GET api/Titulos/Pendentes

Retorna a lista de títulos não pagos ou informações do título informado.

Request Information

URI Parameters

None.

Body Parameters

Dados da consulta

ReqTitulosPendentens
NameDescriptionTypeAdditional information
idcadastro

Código do cadastro do cliente

integer

None.

titulo

'Número do título a ser consultado. ZERO traz todos os títulos não pagos

integer

None.

token

Token de acesso

string

None.

Request Formats

application/json, text/json

Sample:
{
  "idcadastro": 1,
  "titulo": 2,
  "token": "sample string 3"
}

application/xml, text/xml

Sample:
<ReqTitulosPendentens xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <idcadastro>1</idcadastro>
  <titulo>2</titulo>
  <token>sample string 3</token>
</ReqTitulosPendentens>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CobrancaDados
NameDescriptionTypeAdditional information
titulo

Número da fatura

integer

None.

data_emissao

Data de emissão da fatura

string

None.

data_vencimento

Data de vencimento da fatura

string

None.

data_pagamento

Data de pagamento da fatura

string

None.

valor

Valor da fatura

decimal number

None.

atraso

Quantidade de dias vencido

integer

None.

juros

Valor dos juros

decimal number

None.

desconto

Valor do desconto (no caso de bloqueio de conexão)

decimal number

None.

desconto_descricao

Descrição sobre o desconto

string

None.

valor_total

Valor total com juros e desconto

decimal number

None.

banco

Número do banco

integer

None.

empresa_nome

Nome da empresa

string

None.

empresa_cnpj

Cnpj da empresa

string

None.

empresa_ie

Inscrição Estadual da empresa

string

None.

empresa_endereco

Endereço da empresa

string

None.

agencia

Agência bancária

string

None.

conta

Conta corrente

string

None.

carteira

Carteira de cobrança bancária

string

None.

nossonumero

Nosso número bancário

string

None.

linha_digitavel

Linha digitável do boleto

string

None.

servico

Tipo do serviço: OU = mensalidade, TX = Taxas, VE = vendas, etc

string

None.

descricao

Descrição da cobrança da fatura

string

None.

url_boleto

Link para abrir o boleto

string

None.

cancelado

True indica que foi cancelado

boolean

None.

cancelado_motivo

Motivo do cancelamento

string

None.

local_pagamento

Local de pagamento

string

None.

recorrente

True indica que é cobrança via pagamento recorrente

boolean

None.

recorrente_recusa

Motivo da recusa do banco do pagamento recorrente

string

None.

notafiscal_scm

Número da nota fiscal SCM

string

None.

renegociacao

1 indica que este título é uma renegociação

integer

None.

fatura_detalhes

Detalhes da fatura, caso haja

Collection of FaturaDetalhes

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "titulo": 1,
    "data_emissao": "sample string 2",
    "data_vencimento": "sample string 3",
    "data_pagamento": "sample string 4",
    "valor": 5.0,
    "atraso": 6,
    "juros": 7.0,
    "desconto": 8.0,
    "desconto_descricao": "sample string 9",
    "valor_total": 10.0,
    "banco": 11,
    "empresa_nome": "sample string 12",
    "empresa_cnpj": "sample string 13",
    "empresa_ie": "sample string 14",
    "empresa_endereco": "sample string 15",
    "agencia": "sample string 16",
    "conta": "sample string 17",
    "carteira": "sample string 18",
    "nossonumero": "sample string 19",
    "linha_digitavel": "sample string 20",
    "servico": "sample string 21",
    "descricao": "sample string 22",
    "url_boleto": "sample string 23",
    "cancelado": true,
    "cancelado_motivo": "sample string 25",
    "local_pagamento": "sample string 26",
    "recorrente": true,
    "recorrente_recusa": "sample string 28",
    "notafiscal_scm": "sample string 29",
    "renegociacao": 30,
    "fatura_detalhes": [
      {
        "ccod": 1,
        "grupo": "sample string 2",
        "data": "sample string 3",
        "descricao": "sample string 4",
        "extra": "sample string 5",
        "celular": "sample string 6",
        "valor_cheio": 7.0,
        "valor": 8.0,
        "fonte_pagadora": 9,
        "descricao_proporcionais": "sample string 10"
      },
      {
        "ccod": 1,
        "grupo": "sample string 2",
        "data": "sample string 3",
        "descricao": "sample string 4",
        "extra": "sample string 5",
        "celular": "sample string 6",
        "valor_cheio": 7.0,
        "valor": 8.0,
        "fonte_pagadora": 9,
        "descricao_proporcionais": "sample string 10"
      }
    ]
  },
  {
    "titulo": 1,
    "data_emissao": "sample string 2",
    "data_vencimento": "sample string 3",
    "data_pagamento": "sample string 4",
    "valor": 5.0,
    "atraso": 6,
    "juros": 7.0,
    "desconto": 8.0,
    "desconto_descricao": "sample string 9",
    "valor_total": 10.0,
    "banco": 11,
    "empresa_nome": "sample string 12",
    "empresa_cnpj": "sample string 13",
    "empresa_ie": "sample string 14",
    "empresa_endereco": "sample string 15",
    "agencia": "sample string 16",
    "conta": "sample string 17",
    "carteira": "sample string 18",
    "nossonumero": "sample string 19",
    "linha_digitavel": "sample string 20",
    "servico": "sample string 21",
    "descricao": "sample string 22",
    "url_boleto": "sample string 23",
    "cancelado": true,
    "cancelado_motivo": "sample string 25",
    "local_pagamento": "sample string 26",
    "recorrente": true,
    "recorrente_recusa": "sample string 28",
    "notafiscal_scm": "sample string 29",
    "renegociacao": 30,
    "fatura_detalhes": [
      {
        "ccod": 1,
        "grupo": "sample string 2",
        "data": "sample string 3",
        "descricao": "sample string 4",
        "extra": "sample string 5",
        "celular": "sample string 6",
        "valor_cheio": 7.0,
        "valor": 8.0,
        "fonte_pagadora": 9,
        "descricao_proporcionais": "sample string 10"
      },
      {
        "ccod": 1,
        "grupo": "sample string 2",
        "data": "sample string 3",
        "descricao": "sample string 4",
        "extra": "sample string 5",
        "celular": "sample string 6",
        "valor_cheio": 7.0,
        "valor": 8.0,
        "fonte_pagadora": 9,
        "descricao_proporcionais": "sample string 10"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCobrancaDados xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <CobrancaDados>
    <agencia>sample string 16</agencia>
    <atraso>6</atraso>
    <banco>11</banco>
    <cancelado>true</cancelado>
    <cancelado_motivo>sample string 25</cancelado_motivo>
    <carteira>sample string 18</carteira>
    <conta>sample string 17</conta>
    <data_emissao>sample string 2</data_emissao>
    <data_pagamento>sample string 4</data_pagamento>
    <data_vencimento>sample string 3</data_vencimento>
    <desconto>8</desconto>
    <desconto_descricao>sample string 9</desconto_descricao>
    <descricao>sample string 22</descricao>
    <empresa_cnpj>sample string 13</empresa_cnpj>
    <empresa_endereco>sample string 15</empresa_endereco>
    <empresa_ie>sample string 14</empresa_ie>
    <empresa_nome>sample string 12</empresa_nome>
    <fatura_detalhes>
      <FaturaDetalhes>
        <ccod>1</ccod>
        <celular>sample string 6</celular>
        <data>sample string 3</data>
        <descricao>sample string 4</descricao>
        <descricao_proporcionais>sample string 10</descricao_proporcionais>
        <extra>sample string 5</extra>
        <fonte_pagadora>9</fonte_pagadora>
        <grupo>sample string 2</grupo>
        <valor>8</valor>
        <valor_cheio>7</valor_cheio>
      </FaturaDetalhes>
      <FaturaDetalhes>
        <ccod>1</ccod>
        <celular>sample string 6</celular>
        <data>sample string 3</data>
        <descricao>sample string 4</descricao>
        <descricao_proporcionais>sample string 10</descricao_proporcionais>
        <extra>sample string 5</extra>
        <fonte_pagadora>9</fonte_pagadora>
        <grupo>sample string 2</grupo>
        <valor>8</valor>
        <valor_cheio>7</valor_cheio>
      </FaturaDetalhes>
    </fatura_detalhes>
    <juros>7</juros>
    <linha_digitavel>sample string 20</linha_digitavel>
    <local_pagamento>sample string 26</local_pagamento>
    <nossonumero>sample string 19</nossonumero>
    <notafiscal_scm>sample string 29</notafiscal_scm>
    <recorrente>true</recorrente>
    <recorrente_recusa>sample string 28</recorrente_recusa>
    <renegociacao>30</renegociacao>
    <servico>sample string 21</servico>
    <titulo>1</titulo>
    <url_boleto>sample string 23</url_boleto>
    <valor>5</valor>
    <valor_total>10</valor_total>
  </CobrancaDados>
  <CobrancaDados>
    <agencia>sample string 16</agencia>
    <atraso>6</atraso>
    <banco>11</banco>
    <cancelado>true</cancelado>
    <cancelado_motivo>sample string 25</cancelado_motivo>
    <carteira>sample string 18</carteira>
    <conta>sample string 17</conta>
    <data_emissao>sample string 2</data_emissao>
    <data_pagamento>sample string 4</data_pagamento>
    <data_vencimento>sample string 3</data_vencimento>
    <desconto>8</desconto>
    <desconto_descricao>sample string 9</desconto_descricao>
    <descricao>sample string 22</descricao>
    <empresa_cnpj>sample string 13</empresa_cnpj>
    <empresa_endereco>sample string 15</empresa_endereco>
    <empresa_ie>sample string 14</empresa_ie>
    <empresa_nome>sample string 12</empresa_nome>
    <fatura_detalhes>
      <FaturaDetalhes>
        <ccod>1</ccod>
        <celular>sample string 6</celular>
        <data>sample string 3</data>
        <descricao>sample string 4</descricao>
        <descricao_proporcionais>sample string 10</descricao_proporcionais>
        <extra>sample string 5</extra>
        <fonte_pagadora>9</fonte_pagadora>
        <grupo>sample string 2</grupo>
        <valor>8</valor>
        <valor_cheio>7</valor_cheio>
      </FaturaDetalhes>
      <FaturaDetalhes>
        <ccod>1</ccod>
        <celular>sample string 6</celular>
        <data>sample string 3</data>
        <descricao>sample string 4</descricao>
        <descricao_proporcionais>sample string 10</descricao_proporcionais>
        <extra>sample string 5</extra>
        <fonte_pagadora>9</fonte_pagadora>
        <grupo>sample string 2</grupo>
        <valor>8</valor>
        <valor_cheio>7</valor_cheio>
      </FaturaDetalhes>
    </fatura_detalhes>
    <juros>7</juros>
    <linha_digitavel>sample string 20</linha_digitavel>
    <local_pagamento>sample string 26</local_pagamento>
    <nossonumero>sample string 19</nossonumero>
    <notafiscal_scm>sample string 29</notafiscal_scm>
    <recorrente>true</recorrente>
    <recorrente_recusa>sample string 28</recorrente_recusa>
    <renegociacao>30</renegociacao>
    <servico>sample string 21</servico>
    <titulo>1</titulo>
    <url_boleto>sample string 23</url_boleto>
    <valor>5</valor>
    <valor_total>10</valor_total>
  </CobrancaDados>
</ArrayOfCobrancaDados>