Pular para o conteúdo principal
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
account-types
/
{account_type_id}
Atualizar um Tipo de Conta
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Savings Accounts",
  "description": "Updated description for accounts used in daily operations",
  "metadata": {
    "supportsOverdraft": false,
    "minimumBalance": 100,
    "statementFrequency": "weekly",
    "category": "business",
    "internalCode": "ACC_TYPE_TX_001_UPD"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "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 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

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

​
account_type_id
string<uuid>
obrigatório

O identificador único do Tipo de Conta que você deseja consultar.

Corpo

application/json
​
name
string

Nome do Tipo de Conta.

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

​
organizationId
string<uuid>

O identificador único da Organização.

​
ledgerId
string<uuid>

O identificador único do Ledger.

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