CollectionReceivablesV2Response

Lista paginada dos recebíveis vinculados a uma cobrança.

collectionIdstring<uuid>obrigatório

Identificador da cobrança.

Exemplo 11111111-1111-4111-8111-111111111111

receivables object[]obrigatório

Recebíveis materializados para a cobrança.

Lista [

receivableIdstringobrigatório

Chave única do recebível dentro da cobrança.

Exemplo 43151964000143|12345678000190|VCD|2036-04-23

acquirerTaxIdstring

CNPJ da adquirente.

Exemplo 12345678000190

paymentSchemestring

Código do arranjo de pagamento.

Exemplo VCD

settlementDatestring<date>

Data de liquidação do recebível. Na criação, não pode ser anterior ao dia útil corrente em São Paulo (hoje é aceito); uma data passada responde 400 (ENG-1555).

Exemplo 2036-04-23

amountnumber<double>obrigatório

Valor onerado (efetivamente gravado pela registradora) considerado na cobrança. 0.00 numa UR a constituir.

Exemplo 47.62

requestedAmountnumber<double>

Valor solicitado à registradora para a UR, com duas casas (ENG-1653). Numa UR a constituir é o que ainda não virou onerado; 0.00 quando a cobrança não quer mais a UR. Igual para TAG e Núclea.

Exemplo 300

statusstringobrigatório

Situação do recebível dentro da cobrança. COMMITTED é a UR ativa (onerado acima de 0.00); TO_CONSTITUTE é a UR inativa que a registradora guarda com solicitado acima de 0.00 e onerado 0.00 (ENG-1653); INACTIVE é a UR que saiu da cobrança.

Valores possíveis: [COMMITTED, TO_CONSTITUTE, INACTIVE]

Exemplo COMMITTED

]

pagination objectobrigatório

Cursor pagination for collection receivables, backed by DynamoDB LastEvaluatedKey.

cursorstring

Opaque cursor used to load the current page.

limitinteger<int32>obrigatório

Maximum number of receivables returned in the page.

Valores possíveis: >= 1 e <= 100

Exemplo 30

nextCursorstring

Opaque cursor for the next page, omitted on the terminal page.

currentIteminteger<int32>

Legacy offset retained for backward-compatible callers using lastItem.

nextIteminteger<int32>

Legacy offset retained for backward-compatible callers using lastItem.

totalItemsinteger<int32>

Total item count when the legacy offset compatibility path is used.

CollectionReceivablesV2Response

{
  "collectionId": "11111111-1111-4111-8111-111111111111",
  "receivables": [
    {
      "receivableId": "43151964000143|12345678000190|VCD|2036-04-23",
      "acquirerTaxId": "12345678000190",
      "paymentScheme": "VCD",
      "settlementDate": "2036-04-23",
      "amount": 47.62,
      "requestedAmount": 300,
      "status": "COMMITTED"
    }
  ],
  "pagination": {
    "cursor": "string",
    "limit": 30,
    "nextCursor": "string",
    "currentItem": 0,
    "nextItem": 0,
    "totalItems": 0
  }
}