Pax8

Interact with the Pax8 Partner API

Actions100

Invoices → List Draft Invoice Items

AI-generated

Summary

List draft invoice items from the Pax8 API, filtered by month offset and optionally by company, with pagination support.

Inputs

  • baseUrl — Base URL for the Pax8 API.
  • returnAll — Whether to return all results (paginate automatically).
  • maxResults — Maximum number of results to return. 0 means no limit.
  • page — The page number to request in the draft invoice items list. Used when returnAll is false.
  • size — Returns this number of draft invoice items per page. Used when returnAll is false.
  • monthOffset — Number of months from current to return draft items for. 0 = current month, 1 = next month. Only values 0 and 1 are currently supported. If omitted, defaults to 1 (next month).
  • companyId — Filter draft items to a specific company.

Output shape

array

Returns an array of draft invoice item objects. Pagination is handled via the page and size parameters; when returnAll is true, all items across pages are collected and returned as a single array.

Links

Discussion