---
title: "List Draft Invoice Items"
method: GET
path: "/invoices/draftItems"
tags: ["Invoices"]
---

# List Draft Invoice Items

`GET /invoices/draftItems`

## Request

- Base URL: `https://api.pax8.com/v1`
- URL: `https://api.pax8.com/v1/invoices/draftItems`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://token-manager.pax8.com/oauth/token`

Fetch a paginated list of draft invoice items before they are finalized into invoices. Default page is 0 and default size is 10. The maximum page size is 200.

DISCLAIMER: For future-dated items, the data represents a snapshot of charges that will be applied to a future invoice as of the request date. This is not an actual invoice. Clients should be aware that the final invoice generated on the 5th of the month may differ. This endpoint does not include charges for usage-based products billed in arrears. Tax calculations are based on current account taxability status and current month tax rates, both of which are subject to change for future invoices.

## Query parameters

- `page` number
- `size` number
- `monthOffset` 0 | 1
- `companyId` string, uuid

## Response `200`

Successful operation

- object
  - `content` InvoiceItem[]
    - `id` string, uuid: The unique id for this invoice item
    - `purchaseOrderNumber` string: The purchase order number
    - `type` 'rebate' | 'prorate' | 'subscription' | 'payment-credit' | 'one-time' | 'service-charge' | 'service-credit' | 'invoice-credit': The item type
    - `companyId` string, uuid: The company id
    - `externalId` string: The company external id
    - `companyName` string: The name of the company
    - `startPeriod` string, yyyy-MM-dd: The start period
    - `endPeriod` string, yyyy-MM-dd: The end period
    - `quantity` number: The quantity of this SKU
    - `unitOfMeasure` string: The unit of measure
    - `term` '3 Year' | 'Annual' | '2 Year' | 'Activation' | 'One-Time' | 'Arrears' | 'Trial' | 'Rebate' | 'One-time' | 'Monthly': The billing term
    - `sku` string: The product sku
    - `description` string: The description
    - `details` string: The details
    - `rateType` 'markup (Percentage based markup over to be determined base cost)' | 'single (Single price for any quantity, same as flat)' | 'flat (Single price for any quantity, same as single)' | 'volume (Price scales linearly with quantity)' | 'tiered (Price dependant on quantity)': The rate type
    - `chargeType` 'flat' | 'per': The charge type
    - `price` number: The customer unit price
    - `subTotal` number: The customer sub total. Represents cost of services plus billing fees.
    - `cost` number: The partner unit cost
    - `costTotal` number: The partner total cost of the services
    - `offeredBy` string: The account who offers this product
    - `billedByPax8` boolean: Is the item billed directly by Pax8
    - `total` number: The customer total including all services and fees
    - `productId` string, uuid: The product id
    - `productName` string: The product name
    - `billingFee` number: The fee for Pax8 billing a bill on behalf of company
    - `billingFeeRate` number: The fee rate for Pax8 billing a bill on behalf of company
    - `amountDue` number: The final total due for the item for this invoice
    - `currencyCode` string: The currency ISO 4217 code
    - `salesTax` number: The sales tax amount for this invoice item
    - `subscriptionId` string, uuid: The identifier of the associated subscription. This field will contain the subscription identifier for all product types, allowing partners to link this invoice line item to the relevant subscription details. Products that do not have a subscription id (i.e., BitTitan migration) will return a null value.
    - `vendorName` string: The name of the vendor
  - `page` Page
    - `size` number: The size of the page
    - `totalElements` unknown
    - `totalPages` unknown
    - `number` unknown

## Other responses

- `403`: Access denied
- `404`: Company not found
- `408`: Request timeout
- `422`: Invalid monthOffset value

---

[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)