List Draft Invoice Items
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.
Request
- Base URLhttps://api.pax8.com/v1
- URLhttps://api.pax8.com/v1/invoices/draftItems
- AuthOAuth 2Client credentialsToken URL: https://token-manager.pax8.com/oauth/token
Query parameters
The page number to request in the draft invoice items list
Returns this number of draft invoice items per page
Number of months from current to return draft items for. 0 = current month, 1 = next month. Only values 0 and 1 are currently supported. If omitted, defaults to 1 (next month).
Filter draft items to a specific company.
Response
Successful operation
Example response
{
"page": {
"size": 50,
"totalElements": 237,
"totalPages": 5,
"number": 1
}
}Changes
No recorded changes to this operation across all 1 revision of this API.