Skip to main content
GET
Get Line Items

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The invoice ID

Query Parameters

limit
integer
default:100

Maximum number of line items to return

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

Opaque pagination token to fetch the next page of results, taken from a previous response's nextPageToken. Do not construct or parse this value.

expand
string

Comma-separated list of fields to expand. Supports: items — resolves each returned line's item and that item's external accounting codes into an items collection, so a line can be translated to a GL/SKU code without a second call.

provider
string

Narrows which external references are returned per item when expand=items. Matched exactly against the provider stored on the reference (e.g. accountsiq); there is no allowlist of known providers, but the value must satisfy the same format every stored provider does, so a malformed one is rejected rather than answered with an empty result that reads as "nothing is mapped". It never removes lines or items: an item with no reference for this provider comes back with an empty list, so unmapped SKUs stay visible. Ignored when the items expansion is not requested. Lowercase snake_case provider identifier (e.g. salesforce, netsuite)

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]*$

Response

Paginated list of invoice line items

invoiceId
string
required

The invoice ID

lineItems
object[]
required

Array of line items for this page

totalCount
integer
required

Total number of line items across all pages

items
object[]

Items the returned lines were tagged with, each appearing once, ordered by id. Only present when expand=items is requested. Scoped to the lines in THIS response, not the whole invoice — combine the collections across pages for an invoice-wide set. Join a line to its entry via the line's itemId. A line whose itemId has no entry here is a data-integrity fault — the tag points at an item that no longer resolves for this merchant. It is not the same as an untagged line and must not be counted as unmapped; report it.

nextPageToken
string | null

Token for fetching the next page, null if no more pages