WebsiteWe're hiringCourses & Certifications→ Get started for free
API Reference

List uninvoiced ledger entries

get
https://sandbox.uk.rootplatform.com/v1/insurance/policies//uninvoiced-ledger-entries

Retrieve the policy's ledger journal entries that are not yet attached to an invoice: the pool to pick from when creating an invoice. Pass an entry's entry_id in journal_entry_ids to invoice it. The total number of matching entries is returned in the X-Total-Count response header.

Entries are ordered by transaction_date, the business date the entry belongs to, which is also what the from and to filters narrow on.

Invoicing is opt-in per organization: unless the invoicing feature flag is enabled for your organization this endpoint returns 403.

Path Params
string
required

Must be a UUID. The unique identifier of the policy.

Query Params
date-time

Only return entries with a transaction_date on or after this ISO 8601 date. Must not be after to.

date-time

Only return entries with a transaction_date on or before this ISO 8601 date.

string
length ≤ 200

Free-text search across the entries' descriptions. Maximum 200 characters.

integer
1 to 200
Defaults to 1

The page number of the entries to fetch, between 1 and 200 (inclusive). The upper bound keeps the deepest reachable offset bounded; 200 pages clears any realistic policy even at the smallest page size.

integer
1 to 100
Defaults to 30

The maximum number of items that will be contained in a single page, between 1 and 100 (inclusive).

Responses

400

Validation error. Examples: from is after to, or page exceeds 200.

403

Invoicing is not enabled for the organization, or the caller is missing the invoices:read permission.

Updated 5 days ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?