Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
{account_id}
/
operations
/
{operation_id}
Consultar uma Operação
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'
{
  "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>",
  "type": "CREDIT",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "route": "<string>",
  "amount": {
    "value": "<string>"
  },
  "balance": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123
  },
  "balanceAfter": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123
  },
  "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": {}
}

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.

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser 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_id
string
obrigatório

O identificador único da conta da qual você deseja consultar os saldos.

operation_id
string
obrigatório

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

Resposta

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

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

Opções disponíveis:
CREDIT,
DEBIT,
ON_HOLD,
RELEASE
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

O ID único da rota de operação para esta perna da transação. Deve corresponder à configuração de origem e destino para definir como o valor se move entre as contas.

amount
object

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

balance
object

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

balanceAfter
object

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

status
object

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

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

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