Invoicing API v3

Number of APIs: 8

1. Invoices - List invoices and credit memos for a contract

GET https://{{host}}/invoicing-api/v3/contracts/:contractId/invoices?month={{month}}

Returns invoices and credit memos for the specified contract and the selected month.

---

2. Invoices - Download an invoice or a credit memo file

GET https://{{host}}/invoicing-api/v3/contracts/:contractId/invoices/:invoiceId/download?fileFormat={{fileFormat}}

Returns the content of the selected contract's invoice or credit memo file. The downloadable file is available in the response body. The Content-Type depends on the format of the file you're downloading.

---

3. Invoices - 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.

---

4. Notifications - Create a notification

POST https://{{host}}/invoicing-api/v3/notifications

Creates a notification informing a set of users about new invoices or credit memos for a set of contracts. Each notification needs to specify a unique set of contracts. The request yields an error if the set of contractId values matches that of another notification.

---

5. Notifications - List notifications for an account

GET https://{{host}}/invoicing-api/v3/notifications

Returns notifications for the current account. Notifications inform a set of users whenever there are changes to an invoice or credit memo.

---

6. Notifications - Get a notification

GET https://{{host}}/invoicing-api/v3/notifications/:notificationId

Accesses a specific notification, for example when making modifications to a specific notification.

---

7. Notifications - Modify a notification

PUT https://{{host}}/invoicing-api/v3/notifications/:notificationId

Updates a notification. Any read-only members retained from a GET operation are ignored on subsequent PUTs.

---

8. Notifications - Remove a notification

DELETE https://{{host}}/invoicing-api/v3/notifications/:notificationId

Deletes a notification.

---