Customizable Report

get

https://api.pax8.com/v2/finance-reports/invoices

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Free-text query applied across searchable invoice line item fields

vendorName

string

Return only line items matching this vendorName value

clientName

string

Return only line items matching this clientName value

productName

string

Return only line items matching this productName value

invoiceNumber

string

Return only line items matching this invoiceNumber value

term

string

Return only line items matching this billing term value

invoiceDate

string

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

invoiceDateRangeStart

date

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

invoiceDateRangeEnd

date

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

orderDate

string

Return only line items matching this orderDate value

startPeriod

string

Return only line items matching this service startPeriod value

endPeriod

string

Return only line items matching this service endPeriod value

serviceStart

string

Return only line items matching this serviceStart value

chargeType

string

Return only line items matching this chargeType value

rowType

string

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

vendorId

uuid

Return only line items matching this vendorId value

clientId

uuid

Return only line items matching this clientId value

productId

uuid

Return only line items matching this productId value

purchaseOrderNumber

string

Return only line items matching this purchaseOrderNumber value

invoiceId

string

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

customerInvoices

boolean

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

size

integer

1 to 200

Defaults to 10

The maximum number of line items to return per page

page

integer

≥ 0

Defaults to 0

The page number to request (zero-based)

sort

string

enum

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

fields

array of strings

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.

fields

facet.field

array of strings

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.

facet.field

currencyCode

string

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

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation