Pular para o conteúdo principal
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
transaction-routes
/
{transaction_route_id}
Atualizar uma Rota de Transação
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Charge settlement",
  "description": "Descrição opcional da Rota de Transação.",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "operationType": "source",
      "account": {
        "ruleType": "alias",
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "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.

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.

​
transaction_route_id
string
obrigatório

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

Corpo

application/json
​
title
string

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

Maximum string length: 50
​
description
string

Uma descrição para a Rota de Transação.

Maximum string length: 250
​
operationRoutes
string<uuid>[] | null

Uma lista de IDs de Rotas de Operação que definem a lógica de origem e destino para a transação. Importante: Uma rota de transação deve incluir pelo menos uma rota de operação com tipo: "source" e pelo menos uma rota de operação com tipo: "destination".

​
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 Transaçã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 transação. Usado como nota de entrada para identificação.

​
description
string

Uma descrição para a Rota de Transação.

​
operationRoutes
object[]

Lista de objetos contendo informações sobre as Rotas de Operação da Rota de Transação.

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