Pular para o conteúdo principal

AgendaVersionPair

acquirerTaxIdstringobrigatório
paymentSchemestringobrigatório
resultstringobrigatório

Valores possíveis: [DATA, EMPTY, NO_ACTIVE_RELATIONSHIP, FAILED]

reasonstringobrigatório
performedbooleanobrigatório

Any unit of the pair performed (unit performed flag, fallback registered > 0).

unitCountintegerobrigatório

Valores possíveis: >= 0

registeredReceivableDecimalAmount (string)obrigatório

Exact non-negative reais with two decimals.

Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$

performedAmountstring

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}$

cededAmountstring

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}$

freeReceivableDecimalAmount (string)obrigatório

Exact non-negative reais with two decimals.

Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$

encumberedReceivableDecimalAmount (string)obrigatório

Exact non-negative reais with two decimals.

Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$

notAllocatedReceivableDecimalAmount (string)obrigatório

Exact non-negative reais with two decimals.

Valores possíveis: O valor deve corresponder à expressão regular ^[0-9]+\.[0-9]{2}$

sourcesstring[]

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]

encumbranceBreakdownStatusAgendaEncumbranceBreakdownStatus (string)

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]

encumberedByClientstringaceita valor nulo

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}$

encumberedByOthersstringaceita valor nulo

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}$

encumberedUnitCountintegeraceita valor nulo

URs with an encumbrance ("URs com oneração"); null while UNAVAILABLE.

Valores possíveis: >= 0

clientEncumberedUnitCountintegeraceita valor nulo

URs with an encumbrance of the client's financiers ("URs com a nossa oneração"); null while UNAVAILABLE.

Valores possíveis: >= 0

clientFirstUnitCountintegeraceita valor nulo

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

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