List Billings
Este endpoint permite a listagem de todas as cobranças geradas de uma conta em um determinado período de tempo, especificado por uma data inicial e final, bem como pelo número da conta.
A resposta retornada pelo endpoint inclui informações detalhadas sobre cada cobrança, incluindo a data de vencimento, o status atual, o valor total da cobrança e um resumo com os dados do boleto, incluindo o número do boleto, o valor, a data de emissão e a data de vencimento.
Response Schema
| Campo | Tipo | Descrição |
|---|---|---|
| total | integer | Total de cobranças retornadas |
| pages | integer | Total de páginas de cobranças retornadas |
| billings | array | Lista de objetos de cobrança |
| billings.id | string | Identificador único da cobrança |
| billings.request_id | string | Identificador da requisição que gerou a cobrança |
| billings.current_identity | string | Identificador da conta que gerou a cobrança |
| billings.account | object | Objeto com informações da conta relacionada |
| billings.account.account_id | string | Identificador único da conta |
| billings.account.branch | string | Número da agência da conta |
| billings.account.number | string | Número da conta |
| billings.account.identifier | string | CPF ou CNPJ do titular da conta |
| billings.billing_method | string | Método de cobrança utilizado |
| billings.payer | object | Objeto com informações do pagador |
| billings.payer.name | string | Nome do pagador |
| billings.payer.identifier | string | CPF ou CNPJ do pagador |
| billings.payer.address | object | Objeto com informações de endereço do pagador |
| billings.payer.address.street | string | Endereço do pagador |
| billings.payer.address.zip | string | CEP do endereço do pagador |
| billings.payer.address.city | string | Cidade do endereço do pagador |
| billings.payer.address.state | string | Estado do endereço do pagador |
| billings.payer.notifications | object | Objeto com informações sobre notificações |
| billings.payer.notifications.send_email | boolean | Indica se a notificação deve ser enviada por e-mail |
| billings.payer.notifications.send_sms | boolean | Indica se a notificação deve ser enviada por SMS |
| billings.payer.saveascontact | boolean | Indica se o pagador deve ser salvo como contato |
| billings.due_date | string | Data de vencimento da cobrança |
| billings.close_payment | string | Indica a data limite que o pagamento é aceito. Após esta data, não é mais possível receber o pagamento da cobrança, sendo a mesma automaticamente cancelada. |
| billings.closepaymentdays | integer | Indica a data limite para o pagamento da cobrnça em dias. |
| billings.description | string | Descrição da cobrança |
| billings.amount | number | Valor da cobrança |
| billings.status | string | Status atual da cobrança |
| billings.installment | integer | Número da parcela atual da cobrança |
| billings.totalofinstallments | integer | Número total de parcelas da cobrança |
| billings.installmentscheduledto | string | Data programada para a próxima parcela da cobrança |
| billings.recurring_id | string | Identificador único da recorrência |
| billings.boleto_detail | object | Objeto com informações do boleto associado à cobrança |
| billings.boletodetail.boletoid | string | Identificador único do boleto associado à cobrança |
| billings.boletodetail.ournumber | string | Nosso número |
| billings.boletodetail.authenticationcode | string | Código de autenticação único gerado para o boleto associado à cobrança |
| billings.boletodetail.digitableline | string | Linha digitavel do boleto associado à cobrança |
| billings.boletodetail.duplicatepayment | boolean | Indica se o boleto foi pago mais de uma vez |
| billings.boletodetail.paymentdate | string | Indica a data de pagamento do boleto. Este campo é retornado apenas para as cobranças com o status PAID_OUT |
| billings.boletodetail.downloadurl | string | URL para download do boleto associado à cobrança |
| billings.updated_at | string | Timestamp com a data da ultima atualização da cobrança |
| billings.created_at | string | Timestamp com a data de geração da cobrança |
| billings.extra_data | object | Objeto contendo informações adicionais |
| billings.extradata.totalamount | number | Indica a soma do valor(amount) de todas as cobranças retornadas pela consulta. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | integer | |
per_page | number | integer | |
start_date | string | timestamp | |
end_date | string | timestamp | |
search | null | Busca as cobranças que possuem a ocorrencia da string informada. Pode ser realizado consulta por, dados do pagador, como nome, numero da conta, ou dados do emitente. |
RESPONSES
status: OK
[{"id":"6389ab19262886caf1019999","request_id":"85e33120-5709-4b36-a0ac-808a01359999","current_identity":"99999999999","account":{"account_id":"6109864e1965f85451119999","branch":"0001","number":"999999","identifier":"99999999999"},"billing_method":"BOLETO","payer":{"name":"NOME DO PAGADOR","trade_name":"TRADE NAME DO PAGADOR","identifier":"99999999999","address":{"street":"RUA DA CONSOLAÇÃO, 999 APTO XYZ","zip":"9999999","city":"SÃO PAULO","state":"SP"},"email":"teste@contbank.com","phone":{"country_code":"55","phone_number":"99999999999"},"notifications":{"send_email":true,"send_sms":true}},"due_date":"2023-02-01T00:00:00Z","close_payment":"2023-04-02T00:00:00Z","description":"TESTE COBRANÇA RECORRENTE","amount":5.09,"discounts":{"limit_date":"2023-01-31T00:00:00Z","value":10,"type":"FixedPercentUntilLimitDate"},"fine":{"start_date":"2023-02-02T00:00:00Z","value":2,"type":"Percent"},"interest":{"start_date":"2023-02-02T00:00:00Z","value":1.25,"type":"PercentPerMonth"},"status":"Recebido","status_reason":"BANKSLIP_PAID_OUT","installment":1,"total_of_installments":2,"recurring_id":"b6f0663b-ec51-4e8f-9fb4-565d48799999","boleto_detail":{"boleto_id":"6389ab19eb9ad6b077b99999","our_number":"99999999999","authentication_code":"52c45957-8c10-451b-93df-47a93a348709","digitable_line":"33290001151552618829571002078021892480000000999","payment_date":"2023-03-02T07:38:43.265Z","paid_amount":5.09,"duplicate_payment":false,"download_url":"https://s3.us-west-2.amazonaws.com/storage.contbank/207802/9999999999.pdf"},"updated_at":"2022-12-20T23:01:52.758Z","created_at":"2022-12-02T07:36:57.874Z"}]