API reference

Accounts

The chart of accounts, each account's balance and its register.

GET/v1/accountsList the chart of accounts with balances
POST/v1/accountsAdd an account to the chart
GET/v1/accounts/{account_id}Get an account
PATCH/v1/accounts/{account_id}Rename an account, move it in the chart, or take it out of use
GET/v1/accounts/{account_id}/activityList an account's lines with a running balance
PUT/v1/accounts/{account_id}/logoUpload an account's logo
DELETE/v1/accounts/{account_id}/logoRemove an account's uploaded logo
GET/v1/accounts/{account_id}/required_dimensionsGet the dimensions every line on an account must name
PUT/v1/accounts/{account_id}/required_dimensionsSet the dimensions every line on an account must name
PUT/v1/accounts/{account_id}/tax_lineChoose the tax line an account reports on

List the chart of accounts with balances

GET/v1/accounts

client.accounts.list()

The chart of accounts as a tree, each account with its balance as of as_of (today by default), headers rolled up from the accounts under them.

Parameters

Name	Type	Description
`as_of`Query	string (date) or null	Balances as of this date.
`include_empty`Query	boolean	Default true

Response

200ChartOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/accounts" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Add an account to the chart

POST/v1/accounts· Idempotent

client.accounts.create()

Add an account to this entity's chart.

The code range has to match the type (ACCOUNT_CODE_PREFIXES): an expense account numbered in the 4000s works perfectly until a report groups by prefix, and then it is revenue.

Request body

NewAccount

Response

201AccountOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/accounts" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"…","name":"…","type":"…"}'

Get an account

GET/v1/accounts/{account_id}

client.accounts.get()

One account: its balance, where it sits in the chart, and what is under it.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.
`as_of`Query	string (date) or null	Balances as of this date.

Response

200AccountDetailOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/accounts/{account_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Rename an account, move it in the chart, or take it out of use

PATCH/v1/accounts/{account_id}· Idempotent

client.accounts.update()

Rename an account, move it in the chart, or take it out of use and bring it back.

A move puts it under another account of its own type, or at the top of its type. Nothing posted changes; the headers above its old place stop counting it and the ones above its new place start. It is refused under itself, under anything that is under it, and under an account out of use.

An account with history is never deleted: taking it out of use stops anything new being filed or posted to it, and leaves what is there. It is refused for an account the books cannot run without (retained earnings, suspense and the other one-of-a-kind roles), for a header with accounts still in use under it, and while a rule still files to it.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Request body

AccountChange

Response

200AccountOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X PATCH "https://api.ledgerit.ai/v1/accounts/{account_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

List an account's lines with a running balance

GET/v1/accounts/{account_id}/activity

client.accounts.listActivity()

The account's register, oldest first, with a running balance.

A header account's register is its whole subtree's.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.
`since`Query	string (date) or null	First day. Defaults to 1 January of `until`'s year.
`until`Query	string (date) or null	Last day. Defaults to today.

Response

200RegisterOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/accounts/{account_id}/activity" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Upload an account's logo

PUT/v1/accounts/{account_id}/logo· Idempotent

client.accounts.setLogo()

Upload a logo for an account, replacing any uploaded before. It is shown instead of the mark of the integration that feeds it.

The image type is read from the bytes, not from the upload's declared type: PNG, JPEG or WebP, never SVG. It is redrawn as a square PNG of 128 pixels at most. Refused with payload_too_large over 1 MB and unsupported_image for anything else, or an image under 32 pixels.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Response

200AccountOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X PUT "https://api.ledgerit.ai/v1/accounts/{account_id}/logo" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Remove an account's uploaded logo

DELETE/v1/accounts/{account_id}/logo· Idempotent

client.accounts.removeLogo()

Remove the logo uploaded for an account. It wears the mark of the integration that feeds it again, or its type's icon when none does. Removing a logo that is not there succeeds and changes nothing.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Response

200AccountOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X DELETE "https://api.ledgerit.ai/v1/accounts/{account_id}/logo" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Get the dimensions every line on an account must name

GET/v1/accounts/{account_id}/required_dimensions

client.accounts.getRequiredDimensions()

The dimensions every line on this account must name a value of.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Response

200RequiredDimensionsOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/accounts/{account_id}/required_dimensions" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Set the dimensions every line on an account must name

PUT/v1/accounts/{account_id}/required_dimensions· Idempotent

client.accounts.setRequiredDimensions()

Set which dimensions every line on this account must name. Lines already posted are not revisited; every line posted after is held to it, and refused with dimension_required without one.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Request body

RequiredDimensionsIn

Response

200RequiredDimensionsOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X PUT "https://api.ledgerit.ai/v1/accounts/{account_id}/required_dimensions" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"dimension_ids":["…"]}'

Choose the tax line an account reports on

PUT/v1/accounts/{account_id}/tax_line· Idempotent

client.accounts.setTaxLine()

Choose the line an account reports on, or send null to go back to its default. Refused with unprocessable for a line of the wrong part: a balance-sheet account belongs on Schedule L.

Parameters

Name	Type	Description
`account_id`Path · Required	string	An id that starts with `gla_`.

Request body

AccountTaxLineIn

Response

200AccountTaxLineOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X PUT "https://api.ledgerit.ai/v1/accounts/{account_id}/tax_line" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"tax_line":"…"}'

Objects

The objects these operations take and return.

ChartOut

Name	Type	Description
`accounts`Required	array of AccountOut
`as_of`Required	string (date)
`currency`Required	string
`minor_unit_scale`Required	integer	How many decimal places the books' currency is counted in: 2 for dollars, 0 for yen. Every amount posted to these books is a whole number of that unit.

NewAccount

Name	Type	Description
`code`Required	string
`control_role`	string or null	Make it a control account: every line on it must then name its party. One of `ar`, `ap`, `processor_clearing`
`is_postable`	boolean	Default true
`name`Required	string
`parent_id`	string or null	An id that starts with `gla_`.
`role`	string or null
`type`Required	string

AccountOut

Name	Type	Description
`balance`Required	string
`carries_financing`	boolean	True when a financing instrument is carried in it (a SAFE's, a note's or venture debt's account), whatever its code: never a transfer's other end (decision 0191). Default false
`code`Required	string
`control_role`	string or null	`ar`, `ap` or `processor_clearing` on a control account, whose every line names its party (`party_id`). One of `ar`, `ap`, `processor_clearing`
`currency`Required	string or null
`has_activity`	boolean	Default false
`id`Required	string	An id that starts with `gla_`.
`is_active`Required	boolean
`is_postable`Required	boolean
`is_rollup`Required	boolean
`logo_url`	string or null	The logo a person uploaded for the account, a square PNG; null for none. Shown instead of `provider`'s mark.
`name`Required	string
`parent_id`Required	string or null	An id that starts with `gla_`.
`provider`	string or null	The integration that feeds the account (`brex`, `mercury`, …), when one does: the provider of a connected bank account, card or card program mapped to it. The account wears its mark unless a logo was uploaded.
`role`Required	string or null
`type`Required	string

AccountDetailOut

Name	Type	Description
`account`Required	AccountOut
`as_of`Required	string (date)
`children`Required	array of AccountOut
`currency`Required	string
`parent`Required	AccountRef or null

AccountChange

What may change on an account. Its code and type do not: the code is how reports group it, and the type is which side of the books it is on.

Name	Type	Description
`is_active`	boolean or null	False takes it out of use: nothing new is filed or posted to it, and everything already posted stays and still reports. True brings it back.
`name`	string or null	What the chart calls it.
`parent_id`	string or null	An id that starts with `gla_`.

RegisterOut

Name	Type	Description
`closing_balance`Required	string
`currency`Required	string
`lines`Required	array of RegisterLineOut
`opening_balance`Required	string
`since`Required	string (date)
`truncated`Required	boolean
`until`Required	string (date)

RequiredDimensionsOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`dimension_ids`Required	array of string	Every line posted to the account names a value of each of these dimensions.

RequiredDimensionsIn

Name	Type	Description
`dimension_ids`Required	array of string	The whole set: dimensions left out stop being required.

AccountTaxLineIn

Name	Type	Description
`tax_line`Required	string or null	A key from `GET /v1/tax_lines`; null goes back to the default. A balance-sheet account takes a Schedule L line, an income or expense account any other.

AccountTaxLineOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`account_type`Required	string
`code`Required	string
`name`Required	string
`source`Required	string	`chosen` by a person, or the default by the account's `code` in the standard chart, or by its `type`.
`tax_line`Required	string
`tax_line_label`Required	string

AccountRef

Name	Type	Description
`code`Required	string
`id`Required	string	An id that starts with `gla_`.
`name`Required	string

RegisterLineOut

Name	Type	Description
`account`Required	AccountRef
`amount`Required	string
`balance`Required	string
`description`Required	string
`direction`Required	string	One of `debit`, `credit`
`entry_date`Required	string (date)
`entry_id`Required	string	An id that starts with `je_`.
`entry_no`Required	integer
`line_id`Required	string	An id that starts with `jel_`.
`memo`Required	string or null
`reverses_entry_id`	string or null	An id that starts with `je_`.
`signed_amount`Required	string
`source`Required	string