Skip to main content
GET
List invoices

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

status
string

status to be filtered

startAt
string

startAt in YYYY-MM-DD format

Example:

"2023-01-01"

endAt
string

endAt in YYYY-MM-DD format

Example:

"2023-01-01"

To search for an invoice by id / name / email / phoneNo

Example:

"Alex"

paymentMode
enum<string>

payment mode

Available options:
default,
live,
test
Example:

"live"

contactId
string

Contact ID for the invoice

Example:

"AmuzcoPBpgKeccNsFlib"

limit
string
required

Limit the number of items to return

Example:

10

offset
string
required

Number of items to skip

Example:

10

sortField
enum<string>

The field on which sorting should be applied

Available options:
issueDate
Example:

"issueDate"

sortOrder
enum<string>

The order of sort which should be applied for the sortField

Available options:
ascend,
descend
Example:

"descend"

Response

Successful response

invoices
object[]
required
total
number
required

Total number of invoices

Example:

100

Last modified on March 8, 2026