List invoices and credit memos for an account
GET https://{{host}}/invoicing-api/v3/invoices?month={{month}}
Returns invoices and credit memos for the current account and the selected month.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
month | string | (Required) Selected billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM). | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"accountId":"A-CCT7890","contractId":"C-0N7RAC7","files":[{"fileFormat":"PDF","fileName":"InvoiceName_1-XYZ_1-ABCD_1234567890_FINAL_1.pdf","fileVersion":1},{"fileFormat":"CSV","fileName":"1234567890_1.csv","fileVersion":1}],"invoiceCurrency":"USD","invoiceDate":"2021-01-01","invoiceDueDate":"2021-01-20","invoiceId":1234567890,"invoiceTotal":50000.42,"invoiceType":"INVOICE"},{"accountId":"A-CCT9012","contractId":"K-0N7RAK71","files":[{"fileFormat":"PDF","fileName":"CreditMemoName_1-XYZ_1-ABCD_8234567890_FINAL_1.pdf","fileVersion":2},{"fileFormat":"CSV","fileName":"8234567890_1.csv","fileVersion":2}],"invoiceCurrency":"USD","invoiceDate":"2021-01-01","invoiceDueDate":"2021-01-20","invoiceId":8234567890,"invoiceTotal":-1020.71,"invoiceType":"CREDIT_MEMO"}]