Position

Representa a posição de saldo de um book dentro do ledger. Inicializada automaticamente com valor zero quando um book é criado.

entity_typestringrequired

Possible values: [POSITION]

versionVersion (integer)

Possible values: >= 0 and <= 128

Default value: 0

book_entity_idEntityID (string)

Identificador único da entidade no formato {entity_type}:{uuid_v7}.

Possible values: Value must match regular expression ^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$

Example: {entity_type}:018f74a6e3b270ccbf248a4b012f5f3e

asset_entity_idEntityID (string)required

Identificador único da entidade no formato {entity_type}:{uuid_v7}.

Possible values: Value must match regular expression ^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$

Example: {entity_type}:018f74a6e3b270ccbf248a4b012f5f3e

reference_atstring<date-time>required

Data e hora de referência da posição de saldo. Quando não informada durante uma transação, será a data de criação da transação.

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

entry_referenceEntityIdentifier (string)nullable

Identificador do último lançamento que atualizou a posição do saldo. É nulo quando a posição do saldo é inicializada.

Possible values: Value must match regular expression ^(([a-zA-Z_-]+:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})|(ext:[a-zA-Z0-9_-]{1,32}))$

Example: {entity_type}:018f74a6e3b270ccbf248a4b012f5f3e

posted objectrequired

Posição do saldo lançado.

amountintegerrequired

Valor do saldo em centavos.

Example: 0

creditsintegerrequired

Total de creditos da posicao de saldo.

Example: 0

debitsintegerrequired

Total de debitos da posicao de saldo.

Example: 0

confirmable objectrequired

Posição do saldo a ser confirmado.

amountintegerrequired

Valor do saldo em centavos.

Example: 0

creditsintegerrequired

Total de creditos da posicao de saldo.

Example: 0

debitsintegerrequired

Total de debitos da posicao de saldo.

Example: 0

provisioned objectrequired

Posição do saldo provisionado (lançado e a ser confirmado).

amountintegerrequired

Valor do saldo em centavos.

Example: 0

creditsintegerrequired

Total de creditos da posicao de saldo.

Example: 0

debitsintegerrequired

Total de debitos da posicao de saldo.

Example: 0

available objectrequired

Posição do saldo disponível.

amountintegerrequired

Valor do saldo em centavos.

Example: 0

creditsintegerrequired

Total de creditos da posicao de saldo.

Example: 0

debitsintegerrequired

Total de debitos da posicao de saldo.

Example: 0

created_atstring<date-time>required

Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

updated_atstring<date-time>required

Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

Position

{
  "entity_type": "POSITION",
  "version": 0,
  "book_entity_id": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "asset_entity_id": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "reference_at": "2024-07-29T15:51:28.071Z",
  "entry_reference": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "posted": {
    "amount": 0,
    "credits": 0,
    "debits": 0
  },
  "confirmable": {
    "amount": 0,
    "credits": 0,
    "debits": 0
  },
  "provisioned": {
    "amount": 0,
    "credits": 0,
    "debits": 0
  },
  "available": {
    "amount": 0,
    "credits": 0,
    "debits": 0
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}