Skip to main content
GET
/
api
/
invoices
Get invoices
curl --request GET \
  --url https://api.example.com/api/invoices \
  --header 'Authorization: Bearer <token>'
[
  {
    "accountId": "<string>",
    "id": "<string>",
    "number": "<string>",
    "date": "2023-12-25",
    "dueDate": "2023-12-25",
    "totalAmount": 123,
    "balance": 123,
    "taxAmount": 123,
    "subTotal": 123,
    "trialAdjustedAmount": 123,
    "discountAmount": 123,
    "surchargeAmount": 123,
    "currency": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "status": "draft"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

trace-id
string

Query Parameters

accountNumber
string

Response

OK

accountId
string
id
string
number
string
date
string<date>
dueDate
string<date>
totalAmount
number
balance
number
taxAmount
number
subTotal
number
trialAdjustedAmount
number
discountAmount
number
surchargeAmount
number
currency
string
createdOn
string<date-time>
updatedOn
string<date-time>
createdBy
string
updatedBy
string
status
enum<string>
Available options:
draft,
posted,
partial-paid,
paid,
cancelled