ReadMe_ReceivableScheduleResponse

Agenda paginada de recebíveis disponíveis para operação

receivables object[]

Lista [

uniqueKeystring

acquirerTaxIdstring

acquirerNamestringaceita valor nulo

paymentSchemestring

paymentSchemeNamestringaceita valor nulo

settlementDatestring<date>

registeredAmountnumber<double>

encumberedAmountByClientnumber<double>

encumberedAmountByOthersnumber<double>

freeAmountnumber<double>aceita valor nulo

risk object

Resultado da avaliação de risco do recebível

statusstringaceita valor nulo

Exemplo AVAILABLE

evaluatedAtstring<date-time>aceita valor nulo

brokenRulesstringaceita valor nulo

Exemplo REGRA_001

lastUpdatestring<date-time>aceita valor nulo

]

pagination object

Metadados de paginação baseada em cursor

currentItemstringaceita valor nulo

limitinteger<int32>

Exemplo 30

nextItemstringaceita valor nulo

totalItemsinteger<int64>

Exemplo 150

totals object

Totalizadores monetários do recorte

totalRegisteredAmountnumber<double>

Exemplo 15000

pageRegisteredAmountnumber<double>

Exemplo 3000

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_ReceivableScheduleResponse

{
  "receivables": [
    {
      "uniqueKey": "string",
      "acquirerTaxId": "string",
      "acquirerName": "string",
      "paymentScheme": "string",
      "paymentSchemeName": "string",
      "settlementDate": "2024-07-29",
      "registeredAmount": 0,
      "encumberedAmountByClient": 0,
      "encumberedAmountByOthers": 0,
      "freeAmount": 0,
      "risk": {
        "status": "AVAILABLE",
        "evaluatedAt": "2024-07-29T15:51:28.071Z",
        "brokenRules": "REGRA_001"
      },
      "lastUpdate": "2024-07-29T15:51:28.071Z"
    }
  ],
  "pagination": {
    "currentItem": "string",
    "limit": 30,
    "nextItem": "string",
    "totalItems": 150
  },
  "totals": {
    "totalRegisteredAmount": 15000,
    "pageRegisteredAmount": 3000
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}