ReadMe_CashAdvanceReceivablesResponse

Lista paginada dos recebíveis vinculados ao contrato de antecipação

cashAdvanceIdstring<uuid>

Identificador do contrato

receivables object[]

Lista [

receivableIdstring

Identificador do recebível vinculado ao contrato

Exemplo 1

acquirerTaxIdstring

CNPJ do adquirente

Exemplo 01027058000191

paymentSchemestring

Código do arranjo de pagamento

Exemplo MCC

settlementDatestring<date>

Data de liquidação

Exemplo 2036-08-15

requestedAmountnumber<double>

Valor solicitado para o recebível dentro do contrato

Exemplo 1500

effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado no recebível após confirmação do registrador. Vem nulo até a confirmação ser recebida.

Exemplo 1450

performedAmountnumber<double>aceita valor nulo

Valor performado do recebível conforme registrado. Vem nulo quando o recebível não está mais na agenda.

Exemplo 1500

]

pagination object

Metadados de paginação baseada em cursor

currentItemstringaceita valor nulo

Cursor da página atual (id do último item da página anterior)

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

Cursor da próxima página, ou null se for a última

totalItemsinteger<int64>

Total de itens disponíveis para os filtros informados

Exemplo 150

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_CashAdvanceReceivablesResponse

{
  "cashAdvanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "receivables": [
    {
      "receivableId": "1",
      "acquirerTaxId": "01027058000191",
      "paymentScheme": "MCC",
      "settlementDate": "2036-08-15",
      "requestedAmount": 1500,
      "effectivelyEncumberedAmount": 1450,
      "performedAmount": 1500
    }
  ],
  "pagination": {
    "currentItem": "string",
    "limit": 30,
    "nextItem": "string",
    "totalItems": 150
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}