Atualizar uma Operação

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Credit pix - Updated",
  "metadata": {
    "notes": "Payment reference updated",
    "originalAmount": "1000",
    "channel": "pix",
    "updatedBy": "system",
    "reason": "customer_request"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

payload = {
    "description": "Credit pix - Updated",
    "metadata": {
        "notes": "Payment reference updated",
        "originalAmount": "1000",
        "channel": "pix",
        "updatedBy": "system",
        "reason": "customer_request"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Credit pix - Updated',
    metadata: {
      notes: 'Payment reference updated',
      originalAmount: '1000',
      channel: 'pix',
      updatedBy: 'system',
      reason: 'customer_request'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_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}/transactions/{transaction_id}/operations/{operation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Credit pix - Updated',
    'metadata' => [
        'notes' => 'Payment reference updated',
        'originalAmount' => '1000',
        'channel' => 'pix',
        'updatedBy' => 'system',
        'reason' => 'customer_request'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

	payload := strings.NewReader("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountAlias": "<string>",
  "balanceId": "<string>",
  "balanceKey": "<string>",
  "description": "<string>",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeCode": "<string>",
  "routeDescription": "<string>",
  "amount": {
    "value": "<string>"
  },
  "balance": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "balanceAfter": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "balanceAffected": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

operations

{operation_id}

Atualizar uma Operação

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Credit pix - Updated",
  "metadata": {
    "notes": "Payment reference updated",
    "originalAmount": "1000",
    "channel": "pix",
    "updatedBy": "system",
    "reason": "customer_request"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

payload = {
    "description": "Credit pix - Updated",
    "metadata": {
        "notes": "Payment reference updated",
        "originalAmount": "1000",
        "channel": "pix",
        "updatedBy": "system",
        "reason": "customer_request"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Credit pix - Updated',
    metadata: {
      notes: 'Payment reference updated',
      originalAmount: '1000',
      channel: 'pix',
      updatedBy: 'system',
      reason: 'customer_request'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_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}/transactions/{transaction_id}/operations/{operation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Credit pix - Updated',
    'metadata' => [
        'notes' => 'Payment reference updated',
        'originalAmount' => '1000',
        'channel' => 'pix',
        'updatedBy' => 'system',
        'reason' => 'customer_request'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

	payload := strings.NewReader("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountAlias": "<string>",
  "balanceId": "<string>",
  "balanceKey": "<string>",
  "description": "<string>",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeCode": "<string>",
  "routeDescription": "<string>",
  "amount": {
    "value": "<string>"
  },
  "balance": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "balanceAfter": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "balanceAffected": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Cabeçalhos

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.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

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.

operation_id

string<uuid>

obrigatório

O identificador único da operação que você deseja consultar.

transaction_id

string<uuid>

obrigatório

O identificador único da transação que você deseja consultar.

Corpo

application/json

description

string

A descrição da operação.

Maximum string length: 256

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

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

string<uuid>

O identificador único da Operação.

transactionId

string<uuid>

O identificador único da Transação.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

accountId

string<uuid>

O identificador único da Conta.

accountAlias

string

O alias da conta utilizada na operação.

balanceId

string

O identificador único do Saldo.

balanceKey

string

A chave única que identifica o Saldo.

description

string

Descrição da transação.

type

enum<string>

O tipo da operação. OVERDRAFT identifica operações companion geradas pelo sistema no saldo interno "overdraft" — direction carrega então a semântica do ciclo de vida (debit para um draw, credit para um reembolso). BLOCK e UNBLOCK identificam operações produzidas pelos endpoints de transação de block/unblock; direction continua carregando a semântica de débito/crédito.

Opções disponíveis:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE,

OVERDRAFT,

BLOCK,

UNBLOCK

assetCode

string

O nome do ativo utilizado na operação.

chartOfAccounts

string

O nome do Plano de Contas ao qual a operação pertence.

route

string

obsoleto

Obsoleto. Use routeId no lugar. Será removido na próxima versão major.

routeId

string<uuid>

O identificador único da rota de operação associada a esta operação. Operações companion de overdraft herdam esse valor da operação primária que as gerou.

routeCode

string

Um código legível da rota de operação, útil para auditoria e rastreabilidade.

Maximum string length: 100

routeDescription

string

A descrição da rota de operação associada a esta operação.

direction

enum<string>

A direção da operação na contabilidade de partida dobrada.

Opções disponíveis:

debit,

credit

amount

object

Um objeto contendo informações sobre o valor utilizado na operação.

Show child attributes

balance

object

Um objeto contendo informações sobre o saldo antes da operação.

Show child attributes

balanceAfter

object

Um objeto contendo informações sobre o saldo após a operação.

Show child attributes

status

object

O status da transação (pendente, concluída, revertida).

Show child attributes

balanceAffected

boolean

Se verdadeiro, indica que a operação afetou o saldo da conta.

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

Show child attributes

Consultar uma Operação

Criar uma Rota de Operação

⌘I