PARTNER ENDPOINTSInvoicesCustomizable ReportCopy Pageget https://api.pax8.com/v2/finance-reports/invoicesReturns a customizable report of invoices line items matching the supplied search and filter criteria, along with optional faceted aggregations.Recent RequestsLog in to see full request historyTimeStatusUser Agent Retrieving recent requests…LoadingLoading…Query ParamsqstringFree-text query applied across searchable invoice line item fieldsvendorNamestringReturn only line items matching this vendorName valueclientNamestringReturn only line items matching this clientName valueproductNamestringReturn only line items matching this productName valueinvoiceNumberstringReturn only line items matching this invoiceNumber valuetermstringReturn only line items matching this billing term valueinvoiceDatestringReturn only line items for this invoice date. Accepts yyyy-MM (whole month) or yyyy-MM-ddinvoiceDateRangeStartdateReturn only line items with an invoice date greater than or equal to this date. Must be supplied together with invoiceDateRangeEndinvoiceDateRangeEnddateReturn only line items with an invoice date less than or equal to this date. Must be supplied together with invoiceDateRangeStartorderDatestringReturn only line items matching this orderDate valuestartPeriodstringReturn only line items matching this service startPeriod valueendPeriodstringReturn only line items matching this service endPeriod valueserviceStartstringReturn only line items matching this serviceStart valuechargeTypestringReturn only line items matching this chargeType valuerowTypestringReturn only line items matching this rowType (line item type) valuevendorIduuidReturn only line items matching this vendorId valueclientIduuidReturn only line items matching this clientId valueproductIduuidReturn only line items matching this productId valuepurchaseOrderNumberstringReturn only line items matching this purchaseOrderNumber valueinvoiceIdstringReturn only line items for this invoice. Required unless invoiceDate or both invoiceDateRangeStart and invoiceDateRangeEnd are suppliedcustomerInvoicesbooleanFilter results to customer (bill-on-behalf) invoice line itemstruetruefalsesizeinteger1 to 200Defaults to 10The maximum number of line items to return per pagepageinteger≥ 0Defaults to 0The page number to request (zero-based)sortstringenumReturn line items sorted by this field and direction. Formatted as fieldName,direction - ex. sort=invoiceDate,descclientName,ascclientName,descvendorName,ascvendorName,descproductName,ascproductName,descinvoiceNumber,ascinvoiceNumber,descpartnerName,ascpartnerName,descdescription,ascdescription,descproductSku,ascproductSku,descchargeType,ascchargeType,descterm,ascterm,desctype,asctype,desclineItemType,asclineItemType,descrateType,ascrateType,descofferedBy,ascofferedBy,descpurchaseOrderNumber,ascpurchaseOrderNumber,desccurrencyCode,asccurrencyCode,descunitOfMeasure,ascunitOfMeasure,descclientExternalId,ascclientExternalId,desctaxCollectedFrom,asctaxCollectedFrom,desccommitmentTerm,asccommitmentTerm,desccompanyLocation,asccompanyLocation,descinvoiceDate,ascinvoiceDate,descquantity,ascquantity,descprice,ascprice,desctotal,asctotal,desctotalAfterTax,asctotalAfterTax,desccost,asccost,desccostTotal,asccostTotal,descorderDate,ascorderDate,descserviceStart,ascserviceStart,descstartPeriod,ascstartPeriod,descendPeriod,ascendPeriod,descShow 62 enum valuesfieldsarray of stringsRestrict 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.fieldsShow 63 enum valuesADD stringfacet.fieldarray of stringsRequest 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.fieldShow 9 enum valuesADD stringcurrencyCodestringISO 4217 currency code used to scope the monetary sub-aggregations returned within each facet bucketResponses 200Successful operation 400The request parameters failed validation. The most common cause is a missing scope filter: at least one of invoiceId, invoiceDate, or both invoiceDateRangeStart and invoiceDateRangeEnd must be supplied. Other triggers include: invoiceDateRangeStart and invoiceDateRangeEnd supplied without each other — they must be provided together, and invoiceDateRangeStart must not be after invoiceDateRangeEnd. A malformed invoiceDate (yyyy-MM or yyyy-MM-dd) or range date (yyyy-MM-dd). An unknown sort field or unknown fields value. An invalid facet field, facet.{facetField}.limit (must be 1–100), or facet.{facetField}.cursor. Updated 22 days ago List Draft Invoice ItemsUsage SummariesDid this page help you?YesNo
