ReceivableEncumbrancesResponse
pagination objectobrigatório
agendaVersion object
ENG-1164 additive field, present only when the caller's client has an ACTIVE consolidated agenda version for the company. The listed receivables/encumbrances then come only from the snapshots of the version's DATA pairs (instead of the per-company active snapshots). The client x company authorization is still required (403). Absent (null) means the client has no ACTIVE version: agendas are read only from consolidated consults (ENG-1184), so the response carries no receivables/encumbrances. ENG-1246: on the session collateral read the values are on the base of each UR (unitCount counts the URs with a performed value above zero, ceded URs included; free, encumbered and the split on the base) and carry performedAmount and cededAmount; the external v2 schedule and encumbrances routes read the registry values of the same version, as before ENG-1246, without those two fields.
Valores possíveis: >= 1
When the consult of the active version was asked for. Omitted on versions consolidated before company started sending it.
Consult date of the active version.
Valores possíveis: [ALL_TERMINAL, TECHNICAL_DEADLINE]
totals objectobrigatório
Totals of the whole consolidated version, independent of the requested window, filters and page. Since ENG-1235 they carry the client split ("comprometido nosso" × "com outras instituições") and its UR counts, frozen at consolidation with the client's ACTIVE financiers of that moment (docs/contracts/client-encumbrance-attribution.md).
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 performed value of the company URs, the base (canonical performedAmount, or registeredAmount + cededAmount); freeAmount, encumberedAmount, unitCount and the split are on the same base. Session routes only (collateral-management and the consult history).
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 value effective cessions took out of the company URs; session routes only.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1355: the stored version keeps the free value before the acquirer's prepaid, so this total, the agenda.consolidated.v1 event and the external API v2 do not change; the Agenda summary, Onerações and the Excel read the prepaid out of the states and photographs and show the free value net of it.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Valores possíveis: >= 0
ENG-1235 whether the client split of a sum of URs is known: AVAILABLE when every counted UR (the unitCount ones) is known, including a sum without URs; PARTIAL when only some are (older photographs add nothing, the values cover the others); UNAVAILABLE when none is, as on every version consolidated before the frozen financier list (all split values null, never zero).
Valores possíveis: [AVAILABLE, PARTIAL, UNAVAILABLE]
Committed by the client's financiers on the company URs; null while UNAVAILABLE.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Committed by other institutions on the company URs; null while UNAVAILABLE.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Valores possíveis: >= 0
Valores possíveis: >= 0
Valores possíveis: >= 0
acquirers object[]obrigatório
ENG-1235 the pairs of each acquirer summed, sorted by acquirerTaxId; frozen at consolidation (derived from the pairs on versions consolidated before it).
Any pair of the acquirer performed.
Valores possíveis: >= 0
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 performed value of the acquirer's URs, the base (canonical performedAmount, or registered + cededAmount); session routes only.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 value effective cessions took out of the acquirer's URs; session routes only.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1235 whether the client split of a sum of URs is known: AVAILABLE when every counted UR (the unitCount ones) is known, including a sum without URs; PARTIAL when only some are (older photographs add nothing, the values cover the others); UNAVAILABLE when none is, as on every version consolidated before the frozen financier list (all split values null, never zero).
Valores possíveis: [AVAILABLE, PARTIAL, UNAVAILABLE]
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Valores possíveis: >= 0
Valores possíveis: >= 0
Valores possíveis: >= 0
pairs object[]obrigatório
Every acquirer x payment-scheme pair of the consolidated version, sorted by acquirerTaxId then paymentScheme. Values are version-wide (all dates, same scope as totals), independent of the requested window, filters and page. EMPTY, NO_ACTIVE_RELATIONSHIP and FAILED pairs carry zero values and keep their reason. See docs/contracts/agenda-version-read.md.
Valores possíveis: [DATA, EMPTY, NO_ACTIVE_RELATIONSHIP, FAILED]
Any unit of the pair performed (unit performed flag, fallback registered > 0).
Valores possíveis: >= 0
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 performed value of the pair's URs, the base (canonical performedAmount, or registered + cededAmount). On the panel's session routes (collateral-management and the consult history); absent on the external v2 routes.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1246 value effective cessions took out of the pair's URs; session routes only.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1072 frozen origin of the pair when the consult opened — PACKAGE (contract package), ADDITIONAL (chosen in the company configuration) and CONTRACT (protected by an advance contract). A pair can have more than one; absent on versions consolidated before the freeze.
Valores possíveis: [PACKAGE, ADDITIONAL, CONTRACT]
ENG-1235 whether the client split of a sum of URs is known: AVAILABLE when every counted UR (the unitCount ones) is known, including a sum without URs; PARTIAL when only some are (older photographs add nothing, the values cover the others); UNAVAILABLE when none is, as on every version consolidated before the frozen financier list (all split values null, never zero).
Valores possíveis: [AVAILABLE, PARTIAL, UNAVAILABLE]
ENG-1235 committed by the client's financiers on the URs of the pair; null while UNAVAILABLE. Absent from the consult history pairs.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
ENG-1235 committed by other institutions on the URs of the pair; null while UNAVAILABLE.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
URs with an encumbrance ("URs com oneração"); null while UNAVAILABLE.
Valores possíveis: >= 0
URs with an encumbrance of the client's financiers ("URs com a nossa oneração"); null while UNAVAILABLE.
Valores possíveis: >= 0
URs where the client's financier is 1st in the queue ("URs em que estamos em 1º"); counts the URs with a queue, TAG and, since ENG-1313, Núclea with the canonical queue; null while UNAVAILABLE.
Valores possíveis: >= 0
unavailablePairs object[]obrigatório
Pairs that returned no agenda (FAILED or NO_ACTIVE_RELATIONSHIP) with their reason. Kept for compatibility; pairs[] carries the same pairs with their values.
Valores possíveis: [FAILED, NO_ACTIVE_RELATIONSHIP]
{
"companyTaxId": "string",
"encumbrances": [
{}
],
"pagination": {},
"agendaVersion": {
"queryId": "string",
"sequence": 0,
"openedAt": "2024-07-29T15:51:28.071Z",
"asOf": "2024-07-29T15:51:28.071Z",
"closedBy": "ALL_TERMINAL",
"totals": {
"registeredAmount": "string",
"performedAmount": "string",
"cededAmount": "string",
"freeAmount": "string",
"encumberedAmount": "string",
"notAllocatedAmount": "string",
"unitCount": 0,
"encumbranceBreakdownStatus": "AVAILABLE",
"encumberedByClientAmount": "string",
"encumberedByOthersAmount": "string",
"encumberedUnitCount": 0,
"clientEncumberedUnitCount": 0,
"clientFirstUnitCount": 0
},
"acquirers": [
{
"acquirerTaxId": "string",
"performed": true,
"unitCount": 0,
"registered": "string",
"performedAmount": "string",
"cededAmount": "string",
"free": "string",
"encumbered": "string",
"notAllocated": "string",
"encumbranceBreakdownStatus": "AVAILABLE",
"encumberedByClient": "string",
"encumberedByOthers": "string",
"encumberedUnitCount": 0,
"clientEncumberedUnitCount": 0,
"clientFirstUnitCount": 0
}
],
"pairs": [
{
"acquirerTaxId": "string",
"paymentScheme": "string",
"result": "DATA",
"reason": "string",
"performed": true,
"unitCount": 0,
"registered": "string",
"performedAmount": "string",
"cededAmount": "string",
"free": "string",
"encumbered": "string",
"notAllocated": "string",
"sources": [
"PACKAGE"
],
"encumbranceBreakdownStatus": "AVAILABLE",
"encumberedByClient": "string",
"encumberedByOthers": "string",
"encumberedUnitCount": 0,
"clientEncumberedUnitCount": 0,
"clientFirstUnitCount": 0
}
],
"unavailablePairs": [
{
"acquirerTaxId": "string",
"paymentScheme": "string",
"result": "FAILED",
"reason": "string"
}
]
}
}