Gives a list of all invoices in the system
/invoices
https://api.oauth.pabau.com/{api_key}/invoices
Request
| Query Parameters: | |
| api_key * | |
| date | date of the invoice in format YYYY-MM-DD |
| status | paid, part-paid or unpaid |
| per_page | (int) If not sent, the default is 20. Maximum 50 |
| page | (int) If not sent, the first 20 result will be sent |
| order | ASC or DESC. Default DESC |
Response sample
application/json
{
"success": true,
"total": 1,
"invoices": [
{
"details": {
"id": 123456789,
"invoice_type": "invoice",
"invoice_no": "INV123456",
"invoice_date": "16/08/2024 16:05",
"last_updated": "16/08/2024 16:05",
"inv_total": "450.00",
"created_by": "Jon Doe",
"status": "paid",
"issued_to": "John Doe"
},
"items": [
{
"item_name": "botox",
"unit_price": 250,
"quantity": 1,
"dicount_amount": 0,
"tax_amount": 0,
"item_net": 250,
"item_gross": 250,
"discount_rate": [
],
"tax_rate": [
],
"biller": [
{
"id": 123456,
"full_name": "Jon Doe"
}
]
}
"payments": [
{
"pmethod": "Cash",
"charge_amount": 450,
"datetime": "2024-08-16 16:06:17",
"id": 29528221,
"paid_by": "Jon Doe"
}
],
"location": [
{
"id": 1234,
"name": "Location Name"
}
],
"client": [
{
"contact_id": 12345678,
"client_name": "John Doe",
"email": "john@doe.com",
"mobile": "123456789"
}
],
"appointment": {
"appointment_id": null,
"appointment_date": null,
"service": null
},
"fees": {
"charge_id": null,
"fee": "0.00"
}
}
]
}