ReadMe_CollectionListResponse

Lista paginada de contratos de cobrança

collections object[]

Lista de contratos de cobrança

Lista [

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

]

pagination object

Metadados de paginação baseada em cursor

currentItemstring

ID do item atual (primeiro da página)

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

ID do próximo item (cursor para a próxima página)

Exemplo 22222222-2222-4222-8222-222222222222

totalItemsinteger<int64>

Total de itens disponíveis

Exemplo 150

totals object

Totalizadores monetários do filtro

requestedAmountnumber<double>

Valor solicitado total

Exemplo 15000

effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado total

Exemplo 14500

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_CollectionListResponse

{
  "collections": [
    {
      "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"
    }
  ],
  "pagination": {
    "currentItem": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
    "limit": 30,
    "nextItem": "22222222-2222-4222-8222-222222222222",
    "totalItems": 150
  },
  "totals": {
    "requestedAmount": 15000,
    "effectivelyEncumberedAmount": 14500
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}