Skip to main content
GET
List an invoice's entries
An invoice entry is one line item of the invoice — a product or service the payer purchased, with its amount — and the invoice amount is the sum of its OPEN entries. Entries are created automatically from the products of the deal when the invoice is created, and POST .../entries adds more: an on-demand charge for that invoice’s period. Deleted entries stay in the list with status DELETED and no longer count; filter with status. Read the invoice as its issuer (role=VENDOR, the default) or as its payer (role=BUYER, when your organization is the invoice’s payer). Any member of the organization, or an admin of the realm, can list them. Page with limit + next. With details=true the entries are grouped by identifier instead of listed one by one: see that parameter.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization: the one that issued the invoice, or the one that pays it when role is BUYER.

Format: UUID

invoiceId
string<uuid>
required

ID of the invoice whose entries you want to list.

Format: UUID

Query Parameters

status
enum<string>

Only the entries in this status. OPEN: the ones that count toward the invoice amount. DELETED: the ones that were deleted. Omit it to list both.

Available options:
OPEN,
DELETED
details
string

Send true (or the bare ?details) to group the entries by identifier, ignoring case, instead of listing each one. Each item then stands for one identifier: its amount is the sum of that identifier's OPEN entries and its createdAt the creation time of one of them. The other fields of a grouped item are placeholders, not the values of its entries, so don't read them.

role
enum<string>
default:VENDOR

Your side of the invoice. VENDOR (the default): your organization issued it. BUYER: your organization is the invoice's payer.

Available options:
VENDOR,
BUYER
limit
integer
default:15

Page size, 1–1000. Defaults to 15.

Required range: 1 <= x <= 1000
next
string

Cursor returned as next by the previous page; it must be valid base64. Omit it for the first page. Use it with the same filters.

Maximum string length: 128
Pattern: ^[A-Za-z0-9+/]+={0,2}$

Response

Successful response

A page of an invoice's entries, newest first.

items
object[]
required

Entries, newest first.

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"