Pular para o conteúdo principal

ReadMe_CollectionResponse

Dados de um contrato de cobrança

collectionIdstring<uuid>

Identificador do contrato

Exemplo 11111111-1111-4111-8111-111111111111
externalContractIdstring

Identificador externo do contrato

Exemplo ext-col-001
externalIdstring

Identificador externo individual da operação de cobrança

Exemplo ext-op-001
statusstring

Status do contrato

Valores possíveis: [CREATED, CREATION_PENDING, CREATION_FAILED, CREATION_FAILED_NO_RELATIONS, DELETION_PENDING, DELETION_FAILED, DELETED]

Exemplo CREATED
companyTaxIdstring

CNPJ/CPF da empresa

Exemplo 43151964000143
companyNamestring

Nome da empresa

Exemplo Empresa Teste
financierTaxIdstring

CNPJ do financiador

Exemplo 12345678000190
amounts object

Valores monetários de contratos de cobrança

requestedAmountnumber<double>

Valor solicitado

Exemplo 1500
effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado após confirmação do registrador

Exemplo 1450
strategystring

Estratégia de cobrança

Valores possíveis: [TURBO, SELECTIVE, SNIPER, SELECTIVE_WITH_DEBIT, DYNAMIC]

Exemplo TURBO
firstSettlementDatestring<date>

Data inicial de liquidação dos recebíveis

Exemplo 2026-04-01
lastSettlementDatestring<date>

Data final de liquidação dos recebíveis

Exemplo 2026-04-30
createdAtstring<date-time>

Data/hora de criação em UTC

Exemplo 2026-04-23T18:45:00Z
updatedAtstring<date-time>aceita valor nulo

Data/hora da última atualização em UTC

Exemplo 2026-04-23T19:45:00Z
ReadMe_CollectionResponse
{
  "collectionId": "11111111-1111-4111-8111-111111111111",
  "externalContractId": "ext-col-001",
  "externalId": "ext-op-001",
  "status": "CREATED",
  "companyTaxId": "43151964000143",
  "companyName": "Empresa Teste",
  "financierTaxId": "12345678000190",
  "amounts": {
    "requestedAmount": 1500,
    "effectivelyEncumberedAmount": 1450
  },
  "strategy": "TURBO",
  "firstSettlementDate": "2026-04-01",
  "lastSettlementDate": "2026-04-30",
  "createdAt": "2026-04-23T18:45:00Z",
  "updatedAt": "2026-04-23T19:45:00Z"
}