Manage invoices
Learn how to create, update, delete, and send invoices with the Payabli API
In Payabli, invoices are what you send to customers when you expect payment. You can use Payabli’s invoicing APIs to send basic invoices or invoices with detailed descriptions, order quantities, and payment terms.
This guide covers the key operations for managing invoices through the API.
Considerations
When working with invoices, keep the following in mind:
- Invoices are always linked to a customer. If you don’t include a
customerIdand thecustomerDatafields don’t match an existing customer, Payabli creates a new customer. - Payabli strongly recommends creating the customer first and passing the
customerIdin the customerData object. - Invoice numbers must be unique within an paypoint.
- Invoices can be one-time or recurring.
- You can attach a PDF version of an invoice when sending via email using the
attachfile=trueparameter.
Create an invoice
Send a POST request to /api/Invoice/{entry} to create a new invoice. See the API reference for this endpoint for full documentation.
A successful request sends a 200 response with a JSON body that contains the invoice ID.
Update an invoice
Send a PUT request to /api/Invoice/{idInvoice} to change an existing invoice’s details such as amount, items, or status. See the API reference for this endpoint for full documentation.
A successful request sends a 200 response with a JSON body, exactly like the one in the create an invoice example.
Get invoice details
Send a GET request to /api/Invoice/{idInvoice} to retrieve details about a specific invoice. See the API reference for this endpoint for full documentation.
This example gets details for the invoice with ID 332.
A successful request sends a 200 response that contains the invoice details.
Delete an invoice
Send a DELETE request to /api/Invoice/{idInvoice} to delete an invoice. See the API reference for this endpoint for full documentation.
This example deletes the invoice with ID 332.
A successful request sends a 200 response with a JSON body.
Email an invoice
Send a GET request to /api/Invoice/send/{idInvoice} to email an invoice to a customer. See the API reference for this endpoint for full documentation.
Before you get started, you need the IdInvoice value returned in the response when you created the invoice and the customer email address.
This example emails the invoice with ID 332 to tamara@example.com, and attaches a PDF copy of the invoice.
A successful request returns a 200 response with a JSON body.