--- title: "Customizable Report" method: GET path: "/finance-reports/invoices" tags: ["Invoices"] --- # Customizable Report `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` Returns a customizable report of invoices line items matching the supplied search and filter criteria, along with optional faceted aggregations. ## Query parameters - `q` string - `vendorName` string - `clientName` string - `productName` string - `invoiceNumber` string - `term` string - `invoiceDate` string - `invoiceDateRangeStart` string, date - `invoiceDateRangeEnd` string, date - `orderDate` string - `startPeriod` string - `endPeriod` string - `serviceStart` string - `chargeType` string - `rowType` string - `vendorId` string, uuid - `clientId` string, uuid - `productId` string, uuid - `purchaseOrderNumber` string - `invoiceId` string - `customerInvoices` boolean - `size` integer - `page` integer - `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' - `fields` string[] - `facet.field` string[] - `currencyCode` string ## Response `200` Successful operation - FacetedInvoiceLineItemResponse: A page of invoice line items with optional faceted aggregations - `content` FinanceReportInvoiceLineItem[]: The page of matching invoice line items - `id` string, uuid: The unique id of this invoice line item record - `invoiceId` string, uuid: The id of the invoice this line item belongs to - `invoiceNumber` string: The human-readable invoice number - `invoiceDate` string: The date the invoice was generated - `orderId` string, uuid: The id of the associated order - `partnerId` string, uuid: The id of the partner the invoice belongs to - `partnerName` string: The name of the partner - `vendorId` string, uuid: The id of the vendor - `vendorName` string: The name of the vendor - `clientId` string, uuid: The id of the client (company) the line item is for - `clientName` string: The name of the client (company) - `clientExternalId` string: The partner-assigned external id of the client - `productId` string, uuid: The id of the product - `productName` string: The name of the product - `productSku` string: The Pax8 product SKU - `vendorSku` string: The vendor SKU - `vendorSkuId` string: The vendor SKU identifier - `productIsCustom` boolean: Whether the product is a custom product - `subscriptionId` string, uuid: The id of the associated subscription - `originalSubscriptionId` string, uuid: The id of the original subscription, where the subscription has been migrated or replaced - `quantity` number, double: The quantity of the SKU - `unitOfMeasure` string: The unit of measure - `price` number: The customer unit price - `currencyCode` string: The currency ISO 4217 code - `cost` number: The partner unit cost - `costTotal` number: The partner total cost of the services - `costTotalAfterTax` number: The partner total cost including tax - `total` number: The customer total including all services and fees - `totalAfterTax` number: The customer total including tax - `partnerSubtotal` number: The partner subtotal before fees and tax - `billingFee` number: The fee for Pax8 billing a bill-on-behalf-of company - `billingFeeAfterTax` number: The billing fee including tax - `billingFeeRate` number: The fee rate for Pax8 billing a bill-on-behalf-of company - `msrp` number: The manufacturer suggested retail price - `partnerSalesTaxTotal` number: The total sales tax charged to the partner - `companySalesTaxTotal` number: The total sales tax charged to the company (client) - `salesTax` number: The sales tax amount for this line item - `taxable` boolean: Whether this line item is taxable - `taxCollectedFrom` string: The party tax was collected from - `isCustomerInvoice` boolean: Whether this line item belongs to a customer (bill-on-behalf) invoice - `invoiceStatus` string: The status of the invoice - `orderDate` string: The date the order was placed - `serviceStart` string: The service start date - `startPeriod` string: The start of the billed service period - `endPeriod` string: The end of the billed service period - `billingRenewal` string: The billing renewal date - `type` string: The line item type - `lineItemType` string: The detailed line item type - `rateType` string: The rate type - `chargeType` string: The charge type - `term` string: The billing term - `description` string: The line item description - `purchaseOrderNumber` string: The purchase order number - `offeredBy` string: The account that offers this product - `billedByPax8` boolean: Whether the item is billed directly by Pax8 - `billOnBehalfEnabled` boolean: Whether bill-on-behalf is enabled for this line item - `commitmentTerm` string: The commitment term - `numberOfDays` integer: The number of days in the billed period - `companyLocation` string: The company location - `customerBilled` number: The amount billed to the customer - `customerBilledLessTax` number: The amount billed to the customer excluding tax - `amountDue` number: The final total due for this line item - `subtotal` number: The line item subtotal - `page` FinanceReportPage: Pagination metadata for a Finance Reports invoice line item search - `size` integer: The size of the page - `totalElements` integer: The total number of elements able to be paged over - `totalPages` integer: The total number of pages based on the ```size``` and ```totalElements``` - `number` integer: The current page - `facets` object: Faceted aggregations keyed by the requested facet field name. Omitted when no facets were requested ## Other responses - `400`: The 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`. --- [API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)