Pular para o conteúdo principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
account-types
Criar um Tipo de Conta
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "Transactional Account",
  "description": "Account type used for day-to-day payments, transfers, and liquidity operations",
  "keyValue": "CHECKING",
  "metadata": {
    "supportsOverdraft": true,
    "minimumBalance": 0,
    "statementFrequency": "monthly",
    "category": "retail",
    "internalCode": "ACC_TYPE_TX_001"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "keyValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

​
Authorization
string

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

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-Request-Id
string<uuid>

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

Parâmetros de caminho

​
organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

​
ledger_id
string
obrigatório

O identificador único do Ledger associado.

Corpo

application/json
​
name
string
obrigatório

Nome do Tipo de Conta.

​
keyValue
string
obrigatório

Identificador único para o Tipo de Conta que está sendo criado. Importante: Se a funcionalidade de Tipos de Conta estiver habilitada, este valor se torna obrigatório ao criar contas — apenas keyValues previamente registrados serão aceitos no campo type da API de Contas. Caracteres aceitos: alfanuméricos minúsculos, hifens (-) e underscores (_).

​
description
string

Descrição do Tipo de Conta.

​
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'.

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
id
string<uuid>

O identificador único do Tipo de Conta.

​
name
string

Nome do Tipo de Conta.

​
description
string

Descrição do Tipo de Conta.

​
keyValue
string

Identificador único do Tipo de Conta criado.

​
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).

​
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'.