- APIs
- API Reference
- Payments
-
Overview
-
API Reference
- Appointment
- Quotes
- Invoices
- Payments
- Clients
- Client Forms
- Client Documents
- Client Notes
- Client Alerts
- Client Allergies
- Client Communications
- Leads
- Services
- Products
- Packages
- Schedules
- Marketing Sources
- Resources
- Settings
- Tax
- Locations
- Users
- Discounts
- Gift Vouchers
- Labels
- Rooms
- Equipment
- Reports
- Cancellation Policy
- Medical Conditions
- Drugs
- Forms
-
Timesheets
-
Webhooks
List payments
Lists all payments

https://api.oauth.pabau.com/{api_key}/invoices/payments
Request
Query Parameters: | |
api_key * | |
date | Filters payments by date. Needed format YYYY-MM-DD |
per_page | (int) Number of records per page. Default 20, maximum 50 |
page | (int) Page number. If not provided will return the first fetched |
order | ASC or DESC. Default DESC |
Response sample
application/json
{
"total": 1,
"success": true,
"payments": [
{
"id": {id},
"from": "{user_name}",
"date": "2024-05-13 03:10:12",
"amount": {amount},
"pmethod": "{payment_method}",
"user_id": {user_id},
"contact_id": {contact_id},
"invoice_id": {invoice_id},
"invoice_no": {invoice_no}
}
]
}