Référence de l’API
agency-invoicing
32 points de terminaison dans cette zone. Chacun dispose de sa propre page avec ses paramètres, sa réponse et une requête que vous pouvez exécuter.
| Méthode | Chemin | Son rôle | Autorisation |
|---|---|---|---|
| GET | /v1/agency-invoicing/blocks | Saved reusable text — footers, notes and payment terms. | agency.invoicing.view |
| POST | /v1/agency-invoicing/blocks | Save a reusable text block. | agency.invoicing.manage |
| DELETE | /v1/agency-invoicing/blocks/{blockId} | Delete a saved text block. | agency.invoicing.manage |
| PATCH | /v1/agency-invoicing/blocks/{blockId} | Change a saved text block. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/clients | The clients you invoice. | agency.invoicing.view |
| POST | /v1/agency-invoicing/clients | Save a client. | agency.invoicing.manage |
| DELETE | /v1/agency-invoicing/clients/{clientId} | Archive a client. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/clients/{clientId} | One client, with their whole invoice history. | agency.invoicing.view |
| PATCH | /v1/agency-invoicing/clients/{clientId} | Change a client's details. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/gateway | Can you collect online, and through which of your own accounts? | agency.invoicing.view |
| GET | /v1/agency-invoicing/invoices | Your invoices. | agency.invoicing.view |
| POST | /v1/agency-invoicing/invoices | Start a draft invoice. | agency.invoicing.manage |
| DELETE | /v1/agency-invoicing/invoices/{invoiceId} | Delete a draft. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/invoices/{invoiceId} | One invoice, with its lines, payments and payment link. | agency.invoicing.view |
| PATCH | /v1/agency-invoicing/invoices/{invoiceId} | Edit a draft invoice. | agency.invoicing.manage |
| POST | /v1/agency-invoicing/invoices/{invoiceId}/issue | Give the invoice its number and freeze it. | agency.invoicing.manage |
| POST | /v1/agency-invoicing/invoices/{invoiceId}/payments | Record money received — mark it paid or part-paid. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/invoices/{invoiceId}/pdf | A short-lived download URL for the invoice PDF. | agency.invoicing.view |
| POST | /v1/agency-invoicing/invoices/{invoiceId}/send | Email the invoice to your client, with the PDF attached. | agency.invoicing.manage |
| POST | /v1/agency-invoicing/invoices/{invoiceId}/void | Void an invoice. | agency.invoicing.manage |
| DELETE | /v1/agency-invoicing/logo | Take the logo off future invoices. | agency.invoicing.manage |
| POST | /v1/agency-invoicing/logo | Upload the logo your invoices carry. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/portal-labels | The payment pages' labels in one language, with no invoice. Unauthenticated. | Aucune clé API |
| GET | /v1/agency-invoicing/portal/{token} | The invoice, for the person paying it. Unauthenticated. | Aucune clé API |
| POST | /v1/agency-invoicing/portal/{token}/checkout | Start a payment on the AGENCY's own gateway. Unauthenticated. | Aucune clé API |
| POST | /v1/agency-invoicing/preview | Total a set of lines without saving anything. | agency.invoicing.view |
| GET | /v1/agency-invoicing/profile | Your agency's invoicing identity — what an invoice says it is FROM. | agency.invoicing.view |
| PATCH | /v1/agency-invoicing/profile | Change your invoicing identity or defaults. | agency.invoicing.manage |
| GET | /v1/agency-invoicing/tax-rates | The tax rates you charge — VAT, GST, a sales tax, or zero-rated. | agency.invoicing.view |
| POST | /v1/agency-invoicing/tax-rates | Add a tax rate. | agency.invoicing.manage |
| DELETE | /v1/agency-invoicing/tax-rates/{rateId} | Archive a tax rate. | agency.invoicing.manage |
| PATCH | /v1/agency-invoicing/tax-rates/{rateId} | Change a tax rate. | agency.invoicing.manage |