Pular para o conteúdo principal
POST
/
v1
/
organizations
/
{id}
/
ledgers
Criar um Ledger
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{id}/ledgers \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Ledger",
  "status": {
    "code": "ACTIVE",
    "description": "Ledger de produção padrão para operações financeiras"
  },
  "metadata": {
    "environment": "production",
    "region": "us-east-1",
    "businessDomain": "retail_banking",
    "supportedInstruments": [
      "deposit_accounts",
      "pix_transfers",
      "internal_transfers"
    ],
    "multiCurrency": false,
    "createdBy": "system",
    "notes": "Primary ledger used for customer accounts and daily settlement"
  }
}
'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "status": "<unknown>", "metadata": {}, "settings": { "accounting": { "validateAccountType": true, "validateRoutes": true } }, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Cabeçalhos

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

​
Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

​
X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Parâmetros de caminho

​
id
string
obrigatório

O identificador único da Organização.

Corpo

application/json
​
name
string
obrigatório

O nome do Ledger.

Maximum string length: 256
​
status
object

Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.

​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

​
settings
object

Configurações dinâmicas opcionais para o Ledger. Quando omitido, os valores padrão são aplicados (todas as validações desabilitadas).

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

​
id
string<uuid>

O identificador único do Ledger.

​
organizationId
string<uuid>

O identificador único da Organização.

​
name
string

O nome do Ledger.

Maximum string length: 256
​
status
any
​
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

​
settings
object

As configurações atuais de um Ledger.

​
createdAt
string<date-time>

Data e hora de criação (UTC).

​
updatedAt
string<date-time>

Data e hora da última atualização (UTC).

​
deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).