ReceivableScheduleResponse
receivables object[]obrigatório
Origin of the accepted snapshot; omitted for legacy observations without a recorded origin.
Valores possíveis: [ONLINE, BATCH]
Registrar of the accepted snapshot.
Valores possíveis: [TAG, NUCLEA]
Reference time of the accepted snapshot, never the retry processing time.
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Canonical tuple hash. Legacy uniqueKey and receivableId remain valid during migration.
Valores possíveis: O valor deve corresponder à expressão regular ^[a-f0-9]{64}$
SETTLING starts on the scheduled settlement date in America/Sao_Paulo and remains after that date until confirmed settlement. SETTLED requires affirmative settlement evidence. Risk history remains separate. ENG-1355: UNAVAILABLE is an AVAILABLE or HIGH_RISK unit with freeAmount 0.00: nothing is left to the merchant. unavailableReason tells why: ACQUIRER_PREPAID when acquirerPrepaidAmount is above 0.00 (the acquirer prepaid what was free; it prevails when other institutions committed part of the unit too) or, since ENG-1612, OTHER_INSTITUTIONS when there is no prepaid and encumberedByOthers is above 0.00 (other institutions committed what was free; the client's financiers may hold the rest). A unit only the client's financiers committed keeps its situation, and so does one whose split is unknown. Settlement stays ahead of it (such a unit on its own settlement date reads SETTLING or SETTLED), so it means a unit with a future date. It is answered only by the session routes of the Agenda (collateral-management, summary and units) and its workbook; the external API v2 (/api/v2/receivables/schedule) never returns it and keeps the registry's freeAmount.
Valores possíveis: [AVAILABLE, HIGH_RISK, UNAVAILABLE, SETTLING, SETTLED]
Valores possíveis: [AVAILABLE, UNAVAILABLE]
Exact non-negative reais with two decimals.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Committed on the unit by the client's financiers; null while encumbranceBreakdownStatus is UNAVAILABLE.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Committed on the unit by other institutions; null while encumbranceBreakdownStatus is UNAVAILABLE.
Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$
Canonical payment scheme code; equals the retained paymentScheme alias.
Legacy alias of encumberedByClient. Null when client breakdown is unavailable.
Legacy alias of encumberedByOthers. Null when client breakdown is unavailable.
ENG-1313 the risk the calling client sees, by the single rule on its split of the registry queue, the same as the Agenda's: another holder 1st in the queue is HIGH_RISK; the client's financier 1st, or no effect, is AVAILABLE. situation is derived from it. The risk engine's decision is used only where the split is unknown (a photograph without evidence, a version without the frozen financiers), and the field is omitted then if the engine never evaluated the UR. A UR the engine never evaluated but whose split is known now answers a status; before ENG-1313 the field was always the engine's. A contract change for integrators. The split, encumberedTotal and freeAmount of the same item stay on the registry reading (ENG-1246), so one item mixes the two.
Valores possíveis: [AVAILABLE, HIGH_RISK]
The engine's evaluation time or, when it has none, the as-of of the photograph; omitted when there is neither, even with riskStatus set.
Q1 when the single rule decides HIGH_RISK (omitted when it decides AVAILABLE); the engine's rules (for example Z8, several joined by _) only when the split is unknown.
ENG-1235 client split of the provider committed total of the unit, computed on read with the financiers frozen on the caller's ACTIVE agenda version (docs/contracts/client-encumbrance-attribution.md). AVAILABLE carries encumberedByClient ("comprometido nosso": effects held by one of the client's financiers; Núclea totals: atInstitution when the consulting institution is one of them) and encumberedByOthers, which add up to encumberedTotal. UNAVAILABLE (a photograph taken before the registry queue, or a version consolidated before the frozen financier list) keeps both null, never zero. Provider totals are retained, including zero. ENG-1246: on the session collateral read the split and encumberedTotal are on the base of the unit (the canonical performedAmount, or registered + ceded) whenever the registry queue is known (TAG, or Núclea's canonical queue, ENG-1313), so they add up and a cession counts by its holder; the external schedule v2 keeps the split on the registered value and the registry encumberedTotal.
pagination objectobrigatório
totals objectobrigatório
scheduleMetadata objectobrigatório
Valores possíveis: [CURRENT, PARTIAL, EMPTY, NO_ACTIVE_RELATIONSHIP, STALE, NOT_QUERIED]
scopes object[]obrigatório
Valores possíveis: [DATA, EMPTY, NO_ACTIVE_RELATIONSHIP, UNSUCCESSFUL, FAILED]
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]
{
"receivables": [
{
"source": "ONLINE",
"provider": "TAG",
"asOf": "2024-07-29T15:51:28.071Z",
"registeredAmount": "string",
"receivableKey": "string",
"situation": "AVAILABLE",
"encumbranceBreakdownStatus": "AVAILABLE",
"encumberedTotal": "string",
"encumberedByClient": "string",
"encumberedByOthers": "string",
"paymentSchemeCode": "string",
"riskStatus": "AVAILABLE",
"riskEvaluatedAt": "2024-07-29T15:51:28.071Z",
"riskBrokenRules": "string"
}
],
"pagination": {},
"totals": {},
"scheduleMetadata": {
"status": "CURRENT",
"lastSuccessfulAt": "2024-07-29T15:51:28.071Z",
"lastAttemptAt": "2024-07-29T15:51:28.071Z",
"scopes": [
{
"acquirerTaxId": "string",
"paymentScheme": "string",
"snapshotId": "string",
"resultStatus": "DATA",
"asOf": "2024-07-29T15:51:28.071Z",
"stale": true
}
]
},
"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"
}
]
}
}