Invoice payments must be connected to invoices.
Listing Invoice Payments
Returns a collection of invoice payment records, optionally filtered by the available request parameters.
GET /api/v1/invoice/payments
Available Request Parameters:
| Name | Type | Required | Description |
| id | integer | no | ID of the invoice. |
| client | integer | no | ID of the root (parent) client the connected invoice belongs to. |
| location | integer | no | ID of the client location the connected invoice belongs to. |
| invoice | integer | no | ID of the invoice the payment(s) belong to. |
| invoice_number | integer | no | Unique invoice number the payment(s) belong to. |
| invoice_reference_number | string | no | Invoice reference number (e.g. Claim number). |
| reference_number | string | no | Payment reference number (e.g. check or transaction number) |
| paid_from | date | no | Paid on or after the date (Alias: From). |
| paid_to | date | no | Paid on or before the date (Alias: To). |
| invoice_created_from | date | no | Invoice created on or after the date. |
| invoice_created_to | date | no | Invoice created on or before the date. |
| created_from | timestamp | no | Created on or after the date, as determined by the system. |
| created_to | timestamp | no | Created on or before the date, as determined by the system. |
| updated_from | timestamp | no | Updated on or after the date, as determined by the system. |
| updated_to | timestamp | no | Updated on or before the date, as determined by the system. |
Note: All timestamp parameters are queried and returned in UTC.
Getting an Invoice Payment
Returns a single invoice payment record, based on the numeric ID.
GET /api/v1/invoice/payments/{invoice_payment_id}
Creating an Invoice Payment
Creates a new invoice payment record for a given invoice.
POST /api/v1/invoice/payments
Available Parameters
| Name | Type | Required | Description |
| invoice_id | integer | yes | ID of the invoice. API Reference - Invoices |
| payment_method_id | integer | yes |
ID of the Payment Method (Settings > Payment Methods) |
| paid_on | date | yes | The date paid in ISO format (e.g. 2024-12-01) |
| payment_amount | decimal | yes |
The payment amount |
| reference_number | string | no |
A transaction ID, or other reference number associated with this payment. |
| notes | string | no |
A note or memo associated with this payment. |
Example New Invoice Payment
A new invoice payment is created by POSTing a JSON object to the specified end point using the above criteria. The JSON object must contain the required fields (as shown above) and must be nested under the invoice_payment object. See the following example request:
{
"invoice_payment": {
"invoice_id": 123,
"payment_method_id": 1,
"paid_on": "2024-12-01",
"payment_amount": 100.00,
"reference_number": "REF-12345",
"notes": "Submitted via the API"
}
}
Note: The above request is for demonstration purposes only, your implementation will require unique data provided by your account.