API reference

Open items

Every invoice, bill and payment on receivables and payables, with what each has left.

List receivable and payable items

GET/v1/open_items

client.openItems.list()

Receivable and payable items of these books: every AR or AP line that names its party, with what it has left after allocations.

Name	Type	Description
`ledger`Query	string or null	`ar` or `ap`; both when left out.
`party_id`Query	string or null	An id that starts with `party_`.
`open_only`Query	boolean	Only items with something left. Default true
`as_of`Query	string (date) or null	What each had left on this day; today when left out.
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

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.

curl

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

GET/v1/open_items/{item_id}

client.openItems.get()

An open item with every allocation that settled it, or undid one.

Name	Type	Description
`item_id`Path · Required	string	An id that starts with `oi_`.

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.

curl

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

The objects these operations take and return.

Name	Type	Description
`allocations`Required	array of AllocationOut
`currency`Required	string
`due_on`Required	string (date)	The issue day plus the party's payment terms; a payment's own day.
`entry_id`Required	string	The journal entry its line is on.
`entry_no`Required	integer
`id`Required	string	An id that starts with `oi_`.
`issued_on`Required	string (date)
`ledger`Required	string	`ar` or `ap`.
`original_amount`Required	string
`owed`Required	string	`remaining`, positive when owed (an invoice on AR, a bill on AP) and negative when it is a payment not yet applied.
`party_id`Required	string	The counterparty it is with.
`party_name`Required	string or null
`remaining`Required	string	What it has left once its allocations are counted.
`side`Required	string	`debit` or `credit`: the side of its line. A debit item is settled by a credit item.
`subject`Required	string	`invoice`, `bill` or `payment` (`credit` and `advance` come with documents).

Name	Type	Description
`currency`Required	string
`due_on`Required	string (date)	The issue day plus the party's payment terms; a payment's own day.
`entry_id`Required	string	The journal entry its line is on.
`entry_no`Required	integer
`id`Required	string	An id that starts with `oi_`.
`issued_on`Required	string (date)
`ledger`Required	string	`ar` or `ap`.
`original_amount`Required	string
`owed`Required	string	`remaining`, positive when owed (an invoice on AR, a bill on AP) and negative when it is a payment not yet applied.
`party_id`Required	string	The counterparty it is with.
`party_name`Required	string or null
`remaining`Required	string	What it has left once its allocations are counted.
`side`Required	string	`debit` or `credit`: the side of its line. A debit item is settled by a credit item.
`subject`Required	string	`invoice`, `bill` or `payment` (`credit` and `advance` come with documents).

Name	Type	Description
`amount`Required	string	Positive; minus the allocation it undoes when `reverses_id` is set.
`created_by`Required	string or null	An id that starts with `usr_`.
`credit_item_id`Required	string	An id that starts with `oi_`.
`debit_item_id`Required	string	An id that starts with `oi_`.
`effective_on`Required	string (date)
`id`Required	string	An id that starts with `alloc_`.
`recorded_at`Required	string (date-time)
`reverses_id`Required	string or null	An id that starts with `alloc_`.
`settlement_entry_id`Required	string or null	An id that starts with `je_`.