BookCreateRequest

external_entity_idExternalEntityID (string)nullable

Identificador externo da entidade para interoperabilidade com outros sistemas.

Possible values: non-empty and <= 36 characters

Example: ext:123-456-789-ABCD

codestringrequired

Código único de identificação do book. Pode seguir padrões como IFRS COA, COSIF, GAAP ou uma convenção interna da instituição. Utilizado para estruturar o plano de contas e facilitar classificações contábeis. Quando não informado, será usado o EntityID do book.

Possible values: non-empty and <= 128 characters

Example: 1.1.2.01.0001

namestringrequired

Nome único do book dentro do ledger.

Possible values: >= 3 characters and <= 128 characters

naturestringrequired

Define se o book é um credor ou devedor.

Possible values: [CREDITOR, DEBITOR]

asset_identifierEntityIdentifier (string)required

Identificador único entity_id do asset no formato UUIDv7. Alternativamente pode ser utilizado o external_entity_id.

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

metadata object

Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings. O tamanho maximo do objeto deve ser 1MB.

property name*string

BookCreateRequest

{
  "external_entity_id": "ext:123-456-789-ABCD",
  "code": "1.1.2.01.0001",
  "name": "string",
  "nature": "CREDITOR",
  "asset_identifier": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "metadata": {
    "foo": "bar"
  }
}