CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

List All Invoices

get
https://{serverURL}/api/invoices

This endpoint retrieves a list of invoices for the specified parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
Defaults to 25

Maximum number of records to return

int64
Defaults to 0

Offset records, the number of records to skip, for paginating requests

string
Defaults to refName

Sort order, the name of the property to sort by

string
enum
Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:
string

Search phrase for partial matches on name or description

string

Filter by name

string

Filter by startDate greater than or equal to a specified date

string

Filter by endDate less than or equal to a specified date

string

Only return records for period that matches with the specified value. This is an alternative to using startDate/endDate. Format is YYYY or YYYYMM.

string

If specified will return an exact match on refType.

int64

If specified will return an exact match on refId

string

If specified, will filter on the associated StorageVolume status. This is only applicable whn refType=StorageVolume.

int64

The Cloud ID (Zone ID) for Filtering

int64

The Group ID (Site ID) for Filtering

int64

The Instance ID for Filtering

int64

The Container ID for Filtering

int64

The Server ID for Filtering

int64

Filter by User ID

int64

The Project ID for Filtering

boolean

True or False flag for Active

int64

Filter by Tenant ID. This is only available to master tenant users with permission to manage tenants and users.

boolean
Defaults to false

Pass true to include the list of lineItems for each invoice. Only lineItemCount is returned by default.

boolean
Defaults to false

Pass true to include the summed totals (cost/price values) for all the invoices found in the query. The returned property is called invoiceTotals.

string

Filter by tags (metadata). This allows filtering by a tag name and value(s)

Responses

Updated over 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago