Skip to main content
GET
/
v1
/
ledger-entries
/
{ledgerEntryId}
Get a single ledger entry by ID
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/ledger-entries/{ledgerEntryId} \
  --header 'x-api-key: <api-key>'
{
  "id": "le_123456789",
  "posting_set_id": "ps_123456789",
  "pair_token": "pair_123456789",
  "event_id": "evt_123456789",
  "owner_type": "COMPANY",
  "owner_id": "comp_123456789",
  "amount": 10050,
  "operation": "CREDIT",
  "type": "TRANSACTION",
  "currency": "BRL",
  "payment_date": "2023-12-01",
  "installment": 1,
  "total_installments": 1,
  "outstanding_amount": 0,
  "settled": true,
  "created_at": "2023-12-01T10:00:00.000Z",
  "updated_at": "2023-12-01T10:00:00.000Z",
  "settlement_items": [
    {
      "id": "si_123456789",
      "ledger_entry_id": "le_123456789",
      "settled_amount": 10050,
      "settlement_date": "2023-12-01",
      "method": "PIX",
      "status": "PAID",
      "operation_id": "op_123456789",
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z",
      "affiliation_bank_account_id": "ba_123456789",
      "settlement_bank_account_id": "sba_123456789"
    }
  ],
  "company_id": "comp_123456789",
  "organization_id": "org_123456789",
  "affiliation_id": "aff_123456789",
  "transaction_id": "tx_123456789",
  "refund_id": "ref_123456789",
  "dispute_id": "dis_123456789",
  "cashout_id": "co_123456789",
  "fully_settled_at": "2023-12-01T10:00:00.000Z",
  "last_clearing_at": "2023-12-01T10:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Path Parameters

​
ledgerEntryId
string
required

The ledger entry ID

Response

Ledger entry details

Ledger entry data returned by the API

​
id
string
required

Ledger entry unique identifier

Example:

"le_123456789"

​
posting_set_id
string
required

Posting set ID this entry belongs to

Example:

"ps_123456789"

​
pair_token
string
required

Pair token for double-entry bookkeeping

Example:

"pair_123456789"

​
event_id
string
required

Event ID that triggered this entry

Example:

"evt_123456789"

​
owner_type
enum<string>
required

Type of owner for this ledger entry

Available options:
COMPANY,
PLATFORM,
PROVIDER
Example:

"COMPANY"

​
owner_id
string
required

ID of the owner

Example:

"comp_123456789"

​
amount
integer
required

Entry amount in cents

Example:

10050

​
operation
enum<string>
required

Operation type

Available options:
CREDIT,
DEBIT
Example:

"CREDIT"

​
type
enum<string>
required

Entry type

Available options:
TRANSACTION,
ORGANIZATION_FEE,
PLATFORM_COST,
PROVIDER_COST,
ORGANIZATION_ANTICIPATION_FEE,
PLATFORM_ANTICIPATION_COST,
PLATFORM_REFUND_COST,
PROVIDER_REFUND_COST,
TRANSACTION_REFUND,
TRANSACTION_REFUND_REVERSAL,
ORGANIZATION_FEE_REFUND,
PLATFORM_COST_REFUND,
PROVIDER_COST_REFUND,
TRANSACTION_DISPUTE,
TRANSACTION_DISPUTE_REVERSAL
Example:

"TRANSACTION"

​
currency
enum<string>
required

Currency code

Available options:
BRL
Example:

"BRL"

​
payment_date
string<date>
required

Payment date

Example:

"2023-12-01"

​
installment
integer
required

Installment number

Example:

1

​
total_installments
integer
required

Total number of installments

Example:

1

​
outstanding_amount
integer
required

Outstanding amount in cents

Example:

0

​
settled
boolean
required

Whether the entry is settled

Example:

true

​
created_at
string<date-time>
required

Entry creation timestamp

Example:

"2023-12-01T10:00:00.000Z"

​
updated_at
string<date-time>
required

Entry last update timestamp

Example:

"2023-12-01T10:00:00.000Z"

​
settlement_items
object[]
required

Settlement items for this ledger entry

​
company_id
string | null

Company ID (if owner is a company)

Example:

"comp_123456789"

​
organization_id
string | null

Organization ID (if applicable)

Example:

"org_123456789"

​
affiliation_id
string | null

Affiliation ID (if applicable)

Example:

"aff_123456789"

​
transaction_id
string | null

Associated transaction ID

Example:

"tx_123456789"

​
refund_id
string | null

Associated refund ID

Example:

"ref_123456789"

​
dispute_id
string | null

Associated dispute ID

Example:

"dis_123456789"

​
cashout_id
string | null

Associated cashout ID

Example:

"co_123456789"

​
fully_settled_at
string<date-time> | null

When the entry was fully settled

Example:

"2023-12-01T10:00:00.000Z"

​
last_clearing_at
string<date-time> | null

Last clearing timestamp

Example:

"2023-12-01T10:00:00.000Z"