Pular para o conteúdo principal

ReadMe_EncumbranceItemResponse

Detalhes de uma oneração sobre recebível

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
ReadMe_EncumbranceItemResponse
{
  "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
}