ReadMe_CashAdvanceListResponse

Lista paginada de contratos de antecipação

cashAdvances object[]

Lista [

cashAdvanceIdstring<uuid>

Identificador do contrato

Exemplo 11111111-1111-4111-8111-111111111111

externalContractIdstring

Identificador externo do contrato

Exemplo contract-123

statusstring

Status do contrato

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

Exemplo CREATED

companyTaxIdstringaceita valor nulo

CNPJ/CPF da empresa

Exemplo 43151964000143

companyNamestringaceita valor nulo

Nome da empresa

Exemplo Empresa Teste

financierTaxIdstring

CNPJ do financiador

Exemplo 12345678000190

amounts object

Valores monetários do contrato de antecipação

requestedAmountnumber<double>

Valor solicitado

Exemplo 1500

effectivelyEncumberedAmountnumber<double>aceita valor nulo

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

Exemplo 1450

firstSettlementDatestring<date>aceita valor nulo

Data inicial de liquidação dos recebíveis

Exemplo 2036-04-01

lastSettlementDatestring<date>aceita valor nulo

Data final de liquidação dos recebíveis

Exemplo 2036-04-30

createdAtstring<date-time>aceita valor nulo

Data/hora de criação em UTC

Exemplo 2036-04-23T18:45:00Z

updatedAtstring<date-time>aceita valor nulo

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

Exemplo 2036-04-23T19:45:00Z

]

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

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_CashAdvanceListResponse

{
  "cashAdvances": [
    {
      "cashAdvanceId": "11111111-1111-4111-8111-111111111111",
      "externalContractId": "contract-123",
      "status": "CREATED",
      "companyTaxId": "43151964000143",
      "companyName": "Empresa Teste",
      "financierTaxId": "12345678000190",
      "amounts": {
        "requestedAmount": 1500,
        "effectivelyEncumberedAmount": 1450
      },
      "firstSettlementDate": "2036-04-01",
      "lastSettlementDate": "2036-04-30",
      "createdAt": "2036-04-23T18:45:00Z",
      "updatedAt": "2036-04-23T19:45:00Z"
    }
  ],
  "pagination": {
    "currentItem": "string",
    "limit": 30,
    "nextItem": "string",
    "totalItems": 150
  },
  "totals": {
    "requestedAmount": 15000,
    "effectivelyEncumberedAmount": 14500
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}