Pular para o conteúdo principal

ReadMe_EncumbrancesResponse

Lista de onerações sobre recebíveis de uma empresa

companyTaxIdstring

CNPJ da empresa

Exemplo 43151964000143
encumbrances object[]

Lista de onerações

  • Lista [
    • encumbranceIdstring

    Identificador da oneração

    Exemplo 9bd85955-20b5-4a01-9f18-51e118bd9ec5
    receivableUnitKeystring

    Chave da unidade recebível

    Exemplo 01027058000191_MCC_43151964000143_2026-04-30
    financierTaxIdstring

    CNPJ do financiador

    Exemplo 12345678000190
    acquirerTaxIdstring

    CNPJ do adquirente

    Exemplo 01027058000191
    paymentSchemestring

    Código do arranjo

    Exemplo MCC
    amountnumber

    Valor configurado para a oneração. Quando encumbranceType for FIXED, representa valor monetário; quando for PERCENTAGE, representa percentual.

    Exemplo 1500
    encumbranceTypestring

    Tipo de oneração

    Valores possíveis: [FIXED, PERCENTAGE]

    Exemplo FIXED
    prioritystring

    Prioridade absoluta registrada para a oneração

    Exemplo 1
    settlementDatestring<date>

    Data de liquidação

    Exemplo 2026-04-30
    registeredAmountnumber

    Valor registrado da unidade recebível

    Exemplo 10000
    availableAmountnumber

    Valor disponível registrado para a unidade recebível

    Exemplo 8500
    effectivelyEncumberedAmountnumber

    Valor efetivamente onerado registrado para a unidade recebível

    Exemplo 1500
  • ]
    • pagination object

    Metadados de paginação baseada em cursor

    currentItemstringaceita valor nulo

    Cursor usado na página atual

    Exemplo 9bd85955-20b5-4a01-9f18-51e118bd9ec5
    limitinteger<int32>

    Número máximo de itens na página

    Exemplo 30
    nextItemstringaceita valor nulo

    Cursor da próxima página

    Exemplo 31f29c39-cd87-49ac-b14e-e2ad9e21e3c4
    totalItemsinteger<int32>

    Total de onerações 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_EncumbrancesResponse
    {
      "companyTaxId": "43151964000143",
      "encumbrances": [
        {
          "encumbranceId": "9bd85955-20b5-4a01-9f18-51e118bd9ec5",
          "receivableUnitKey": "01027058000191_MCC_43151964000143_2026-04-30",
          "financierTaxId": "12345678000190",
          "acquirerTaxId": "01027058000191",
          "paymentScheme": "MCC",
          "amount": 1500,
          "encumbranceType": "FIXED",
          "priority": "1",
          "settlementDate": "2026-04-30",
          "registeredAmount": 10000,
          "availableAmount": 8500,
          "effectivelyEncumberedAmount": 1500
        }
      ],
      "pagination": {
        "currentItem": "9bd85955-20b5-4a01-9f18-51e118bd9ec5",
        "limit": 30,
        "nextItem": "31f29c39-cd87-49ac-b14e-e2ad9e21e3c4",
        "totalItems": 150
      },
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }