Skip to main content
POST
Create a new ledger

Authorizations

Authorization
string
header
required

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

Body

application/json
code
string
required

Unique ledger code

Example:

"MAIN-USD-001"

description
string
required

Ledger description

Example:

"Main USD Operating Account"

type
enum<string>
required

Type of ledger

Available options:
asset,
liability,
equity,
income,
expense
Example:

"asset"

currency_id
string<uuid>
required

Currency UUID

Example:

"550e8400-e29b-41d4-a716-446655440000"

currency_code
string
required

ISO currency code

Required string length: 3
Example:

"USD"

balance_current
integer

Current balance in cents

Example:

100000

balance_available
integer

Available balance in cents

Example:

100000

overdraft_enabled
boolean
default:false

Enable overdraft facility

overdraft_limit
integer
default:0

Maximum overdraft amount in cents

opening_date
string<date-time>

Ledger opening date

parent_ledger_id
string<uuid>

Parent ledger UUID

metadata
object

Additional metadata

Response

Ledger created successfully

ledger
object