get
https://api.nibo.com.br/empresas/v1/public/collections
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Raiz
| Propriedade | Tipo | Descrição |
|---|---|---|
| items | array | Lista de cobranças da empresa |
| count | number | Total de cobranças retornadas na consulta |
items[]
| Propriedade | Tipo | Descrição |
|---|---|---|
| id | string | Identificador único da cobrança |
| stakeholderId | string | Total de cobranças retornadas na consulta |
| scheduleId | string | Identificador do agendamento vinculado à cobrança. |
| debtor | object | |
| beneficiary | object | |
| description | string | Descrição ou observação da cobrança |
| createDate | string | Data e hora de criação da cobrança |
| createUser | string | Nome do usuário que criou a cobrança |
| dueDate | string | Data de vencimento da cobrança |
| value | number | Valor total da cobrança |
| paidValue | number | Valor que já foi pago. Será 0 enquanto a cobrança não estiver paga |
| lasStatusChangeDate | string | Data e hora da última alteração de status da cobrança |
| status | object | Status da cobrança |
| deliveryStatus | object | Status de entrega |
| accountantIntegrationStatus | object | Status de integração contábil |
| collectionProfileId | string | Identificador do perfil de cobrança utilizado, que define as configurações de emissão (banco, juros, multa, desconto, notificações) |
| url | string | Link público de acesso à página de pagamento da cobrança, onde o devedor pode visualizar e pagar o boleto/PIX |
| string | URL para download do PDF do boleto gerado. |
items[].debtor
| Propriedade | Tipo | Descrição |
|---|---|---|
| document | string | CPF ou CNPJ do devedor (pagador) da cobrança |
| name | string | Nome ou razão social do devedor |
items[].beneficiary
| Propriedade | Tipo | Descrição |
|---|---|---|
| document | string | CPF ou CNPJ do beneficiário (empresa que emitiu a cobrança) |
| name | string | Nome ou razão social do devedor |
items[].status - Status atual da cobrança no ciclo de vida de emissão e pagamento
| Propriedade | Tipo | Descrição |
|---|---|---|
| code | number | Código numérico do status da cobrança |
| description | string | Descrição textual do status |
Valores dos status possíveis:
| code | Descrição | Significado |
|---|---|---|
| 0 | Em fila de geração | A cobrança foi criada e está aguardando o processamento para geração do boleto |
| 1 | Ativação pendente | O boleto foi gerado e está aguardando confirmação de registro no banco |
| 2 | Ativa | O boleto foi registrado com sucesso e está disponível para pagamento |
| 3 | Paga | A cobrança foi paga pelo devedor |
| -1 | Cancelada | A cobrança foi cancelada |
| -2 | Expirada | A cobrança venceu sem pagamento e o boleto foi fechado pelo banco |
items[].deliveryStatus - Indica se a notificação da cobrança foi entregue e visualizada pelo devedor
| Propriedade | Tipo | Descrição |
|---|---|---|
| code | number | Código numérico do status da cobrança |
| description | string | Descrição textual do status |
Valores dos deliveryStatus possíveis:
| code | Descrição |
|---|---|
| 0 | Não entregue |
| 1 | Entregue |
| 2 | Visualizada |
items[].accountantIntegrationStatus- Indica o status da integração da cobrança com o módulo do Nibo Obrigações
Valores dos accountantIntegrationStatus possíveis:
| code | Descrição |
|---|---|
| 0 | Não definida |
| 1 | Habilitada |
| 2 | Criação do item de conferência em andamento |
| 3 | Item de conferência criado |
| 4 | Item de conferência protocolado |
| -1 | Item de conferência excluído |
| -2 | Protocolo cancelado |
| -3 | Falha ao criar o item de conferência |