PApax8
Invoices

Customizable Report

Returns a customizable report of invoices line items matching the supplied search and filter criteria, along with optional faceted aggregations.

get/finance-reports/invoices

Request

  • Base URL
    https://api.pax8.com/v2
  • URL
    https://api.pax8.com/v2/finance-reports/invoices
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://token-manager.pax8.com/oauth/token

Query parameters

qstring

Free-text query applied across searchable invoice line item fields

vendorNamestring

Return only line items matching this vendorName value

clientNamestring

Return only line items matching this clientName value

productNamestring

Return only line items matching this productName value

invoiceNumberstring

Return only line items matching this invoiceNumber value

termstring

Return only line items matching this billing term value

invoiceDatestring
Example:2026-05

Return only line items for this invoice date. Accepts yyyy-MM (whole month) or yyyy-MM-dd

invoiceDateRangeStartstring date
Example:2026-05-01

Return only line items with an invoice date greater than or equal to this date. Must be supplied together with invoiceDateRangeEnd

invoiceDateRangeEndstring date
Example:2026-05-31

Return only line items with an invoice date less than or equal to this date. Must be supplied together with invoiceDateRangeStart

orderDatestring

Return only line items matching this orderDate value

startPeriodstring

Return only line items matching this service startPeriod value

endPeriodstring

Return only line items matching this service endPeriod value

serviceStartstring

Return only line items matching this serviceStart value

chargeTypestring

Return only line items matching this chargeType value

rowTypestring

Return only line items matching this rowType (line item type) value

vendorIdstring uuid

Return only line items matching this vendorId value

clientIdstring uuid

Return only line items matching this clientId value

productIdstring uuid

Return only line items matching this productId value

purchaseOrderNumberstring

Return only line items matching this purchaseOrderNumber value

invoiceIdstring
Example:57328a3c-6e95-493c-ad2f-e33b896378c7

Return only line items for this invoice. Required unless invoiceDate or both invoiceDateRangeStart and invoiceDateRangeEnd are supplied

customerInvoicesboolean
Example:true

Filter results to customer (bill-on-behalf) invoice line items

sizeinteger

The maximum number of line items to return per page

pageinteger

The page number to request (zero-based)

sort'clientName,asc' | 'clientName,desc' | 'vendorName,asc' | 'vendorName,desc' | 'productName,asc' | 'productName,desc' | 'invoiceNumber,asc' | 'invoiceNumber,desc' | 'partnerName,asc' | 'partnerName,desc' | 'description,asc' | 'description,desc' | 'productSku,asc' | 'productSku,desc' | 'chargeType,asc' | 'chargeType,desc' | 'term,asc' | 'term,desc' | 'type,asc' | 'type,desc' | 'lineItemType,asc' | 'lineItemType,desc' | 'rateType,asc' | 'rateType,desc' | 'offeredBy,asc' | 'offeredBy,desc' | 'purchaseOrderNumber,asc' | 'purchaseOrderNumber,desc' | 'currencyCode,asc' | 'currencyCode,desc' | 'unitOfMeasure,asc' | 'unitOfMeasure,desc' | 'clientExternalId,asc' | 'clientExternalId,desc' | 'taxCollectedFrom,asc' | 'taxCollectedFrom,desc' | 'commitmentTerm,asc' | 'commitmentTerm,desc' | 'companyLocation,asc' | 'companyLocation,desc' | 'invoiceDate,asc' | 'invoiceDate,desc' | 'quantity,asc' | 'quantity,desc' | 'price,asc' | 'price,desc' | 'total,asc' | 'total,desc' | 'totalAfterTax,asc' | 'totalAfterTax,desc' | 'cost,asc' | 'cost,desc' | 'costTotal,asc' | 'costTotal,desc' | 'orderDate,asc' | 'orderDate,desc' | 'serviceStart,asc' | 'serviceStart,desc' | 'startPeriod,asc' | 'startPeriod,desc' | 'endPeriod,asc' | 'endPeriod,desc'

Return line items sorted by this field and direction. Formatted as fieldName,direction - ex. sort=invoiceDate,desc

fieldsstring[]

Restrict each returned line item to only these fields. Accepts a comma-delimited list (?fields=invoiceNumber,total,clientName) or repeated parameters. When omitted, all fields are returned.

facet.fieldstring[]

Request a faceted aggregation for each named field. Repeat the parameter to request multiple facets (?facet.field=vendor&facet.field=product). See the endpoint description for the per-facet facet.{facetField}.limit and facet.{facetField}.cursor parameters.

currencyCodestring
Example:USD

ISO 4217 currency code used to scope the monetary sub-aggregations returned within each facet bucket

Response

Successful operation

facetsobject

Faceted aggregations keyed by the requested facet field name. Omitted when no facets were requested

Example response

{
  "page": {
    "size": 10,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.