Pular para o conteúdo principal
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
operation-routes
/
{operation_route_id}
Atualizar uma Rota de Operação
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Cashout from service charge",
  "code": "EXT-001",
  "description": "This operation route handles cash-out transactions from service charge collections",
  "account": {
    "ruleType": "account_type",
    "validIf": [
      "liability",
      "revenue"
    ],
    "metadata": {
      "customField1": "updatedValue",
      "customField2": 456,
      "newField": "newValue"
    }
  }
}
'
{
  "organizationId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "ledgerId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@account1"
    ]
  },
  "code": "EXT-001",
  "description": "This operation route handles cash-in transactions from service charge collections",
  "operationType": "source",
  "title": "Cashin from service charge",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

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.

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.

​
operation_route_id
string
obrigatório

O identificador único da Rota de Operação que você deseja consultar.

Corpo

application/json
​
title
string

Texto curto que resume o propósito da operação. Usado como nota de entrada para identificação.

Maximum string length: 50
​
description
string

Descrição detalhada do propósito e uso da Rota de Operação.

Maximum string length: 250
​
code
string

Uma referência externa usada para identificar a rota de operação.

Maximum string length: 100
​
account
object

Define a regra para selecionar a conta que participará da operação (débito ou crédito).

​
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 da Rota de Operação.

​
organizationId
string<uuid>

O identificador único da Organização.

​
ledgerId
string<uuid>

O identificador único do Ledger.

​
title
string

Texto curto que resume o propósito da operação. Usado como nota de entrada para identificação.

​
code
string

Uma referência externa usada para identificar a rota de operação.

Maximum string length: 100
​
description
string

Descrição detalhada do propósito e uso da Rota de Operação.

​
operationType
enum<string>

O tipo da Rota de Operação.

Opções disponíveis:
source,
destination
​
account
object

Define a regra para selecionar a conta que participará da operação (débito ou crédito).

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