Retrieve a list of invoice items
Retrieve a paginated list of invoice items for your organization.
The response includes both invoiced items (where invoice_id is set) and pending items that have been billed but not yet consolidated onto an invoice (where invoice_id is null and tax / tax_rate are null). Use the date filters to scope the result set; the cursor in the Link response header to page through results.
This endpoint uses cursor-based pagination via Link headers. See Pagination for details.
Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Query Parameters
Return invoice items dated on or after this timestamp (inclusive). ISO 8601 with timezone.
Return invoice items dated on or before this timestamp (inclusive). ISO 8601 with timezone.
Return only invoice items linked to this parcel id.
Return only invoice items belonging to this invoice id.
Return only invoice items of this type. Returns 400 if the value is not a recognized public type.
addon, addon_refund, carrier_impl_fee, carrier_parcel_fee, claim, coulance, customer_impl_fee, earned_credit, fuel_refund, fuel_surcharge, import_adm_fee, import_duties, import_vat, insurance, insurance_refund, invoice_check_fee, invoice_check_fee_refund, notification, overcharge_fee, parcel_cancelled, parcel_fee, parcel_fee_refund, pickup, pickup_cancelled, pickup_subscription, refund, shipment, subscription, subscription_refund, surcharge, surcharge_refund, unblock, validation The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.
There are 3 possible parameters to encode:
o: Offsetr: Reversep: Position
For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.
"cj0xJnA9MzAw"
The size of the page to fetch. Defaults to 100, max 500.
1 <= x <= 500Response
OK
Retrieve invoice items