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

List policy invoices

get
https://sandbox.uk.rootplatform.com/v1/insurance/policies//invoices

Retrieve the invoices raised against a policy, newest first. The total number of matching invoices is returned in the X-Total-Count response header.

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
string
enum

Narrow the list to a single invoice status, e.g. ?status=open to list the invoices on a policy that are finalised but not yet paid. By default invoices across all statuses are returned.

Allowed:
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).

integer
≥ 1
Defaults to 1

The page number of the entities to fetch. Must be a minimum of 1.

Responses

403

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

Updated about 4 hours 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 about 4 hours ago

Did this page help you?