Skip to main content
POST
/
v1
/
ledgers
/
{id}
/
entries
Create ledger entry
curl --request POST \
  --url https://api.example.com/v1/ledgers/{id}/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 2,
  "type": "credit",
  "description": "<string>",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "type": "credit",
  "description": "<string>",
  "balance": 123,
  "timestamp": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Ledger UUID

Body

application/json
​
transaction_id
string<uuid>
required

Unique transaction identifier

​
amount
integer
required

Entry amount in cents

Required range: x >= 1
​
type
enum<string>
required

Type of entry

Available options:
credit,
debit
​
description
string

Entry description

​
metadata
object

Additional entry metadata

Response

201 - application/json

Entry created successfully

​
id
string<uuid>
​
ledger_id
string<uuid>
​
transaction_id
string<uuid>
​
amount
integer

Amount in cents

​
type
enum<string>
Available options:
credit,
debit
​
description
string
​
balance
integer

Running balance in cents

​
timestamp
string<date-time>
​
metadata
object
​
created_at
string<date-time>
​
created_by
string<uuid>