- APIs
- API Reference
- Clients
-
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
Get client balance
Returns the client balance per client ID

https://api.oauth.pabau.com/{api_key}/clients/{contact_id}/balance
Query Parameters: | |
api_key * | |
contact_id * | System ID of the requested client |
Response sample
application/json
{
"success": true,
"balance": {balance},
"loyalty_points": {loyalty_points},
"packages": [
{
"id": {pucrhased_package_id},
"code": {code},
"expiration_date": {expiration_date},
"total_used": {used_count},
"session_count": {total_count},
"service_id": {service_id},
"contact_id": {contact_id}
}
],
"vouchers": [
{
"code": "{code}",
"description": "Voucher Template",
"amount": {purchased_amount},
"remaining_balance": {remaining_amount},
"expiry_date": "{expiration_date}"
}
]
}