Consultar uma Rota de Transação

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "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": {}
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transaction-routes

{transaction_route_id}

Consultar uma Rota de Transação

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "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": {}
}

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

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

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

transaction_route_id

string<uuid>

obrigatório

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

Resposta

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

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.

Show child attributes

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

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

Show child attributes

Listar Rotas de Transação

Atualizar uma Rota de Transação

⌘I