List Invoices

post

https://example.com/v1/Invoices

List Invoices shows all Invoices that are available to the User. To filter the Invoices that appear in the response, specify one or more optional query and pagination parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Invoices Search Filters

Page

int32 | null

Which page of results to return

pageSize

int32 | null

Number of records per page.

endDate

date-time | null

Supply a created from date to only show Invoices created before this date.

If StartDate is provided EndDate must be provided. If neither are provided a default date range is used.

startDate

date-time | null

Supply a created from date to only show Invoices created after this date.

If StartDate is provided EndDate must be provided. If neither are provided a default date range is used.

deploymentIDs

array of int32s | null

Supply a list of Deployment IDs to filter Invoices to those Deployments.

deploymentIDs

cardPoolIDs

array of int32s | null

Supply a list of Card Pool IDs to limit the Invoices to those belonging to the supplied Card Pools.

cardPoolIDs

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

404

Not Found

Language

Credentials

Bearer

JWT

Loading…

Response

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

text/plain

application/json

text/json

200OK

400Bad Request

500Internal Server Error