- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a TenantGET
- Creates a new clientPOST
- Gets client by IDGET
- Gets clients birthday listGET
- Gets clients at riskGET
- Gets client mandatory fieldsGET
- Adds client to blacklistPOST
- Removes client from blacklistPOST
- Updates client detailsPUT
- Used for partial updates of client detailsPATCH
- Changes client representativePOST
- Lists prospectsGET
- Lists ex-clientsGET
- Resets client passwordPOST
- Changes client representative for multiple clientsPOST
- Lists prospect effective date historyGET
- Transfers prospectPOST
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Gets client payments
GET
/clients/{client_id}/payments
Client Sales
Request
Path Params
client_id
integer <int64>
required
Query Params
PageNumber
integer <int32>
optional
PageSize
integer <int32>
optional
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/clients//payments'
Responses
🟢200OK
text/plain
Body
items
array[object (PaymentResponse) {32}]  | nullÂ
optional
id
integer <int64>
optional
log_id
integer <int64>
optional
company_id
integer <int32>
optional
collected_for_tenant_id
integer <int32>
optional
collected_at_tenant_id
integer <int32>
optional
paid_by_client_id
integer <int64>
optional
paid_for_client_id
integer <int64>
optional
amount_in_minor_currency
integer <int64>
optional
is_online
booleanÂ
optional
paymode_level1
enum<string>Â
optional
Cash
-Card
-NetBanking
-UPI
-Wallet
-ACH
-Cheque
-Other
-Emandate
-Adjustment
-PayTo
-Allowed values:
CashCardNetBankingUPIWalletACHChequeOtherEmandateAdjustmentPayTo
payment_mode_level2_id
enum<string>Â
optional
Cash
-Debit
-Credit
-Emandate
-UPI
-Paytm
-AmazonPay
-Venmo
-ACH
-Cheque
-Sodexo
-NetBanking
-ApplePay
-CareemPay
-Knet
-OmanPay
-Fawry
-Benefit
-Mada
-Tabby
-Transfer
-PayTo
-Card
-GCash
-GooglePay
-Link
-Allowed values:
CashDebitCreditEmandateUPIPaytmAmazonPayVenmoACHChequeSodexoNetBankingApplePayCareemPayKnetOmanPayFawryBenefitMadaTabbyTransferPayToCardGCashGooglePayLink
payment_mode_master_id
integer <int32>
optional
payment_mode_master_name_primary_language
string  | nullÂ
optional
payment_mode_master_name_secondary_language
string  | nullÂ
optional
number
integer <int32>
optional
number_prefix
string  | nullÂ
optional
status
enum<string>Â
optional
Open
-PartiallyOpen
-Closed
-Void
-Refunded
-Allowed values:
OpenPartiallyOpenClosedVoidRefunded
void_reason
string  | nullÂ
optional
bulk_uuid
string  | nullÂ
optional
is_number_generated
booleanÂ
optional
created_by
integer <int32>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
payment_date
string <date-time>
optional
sales_representative
integer <int32>
optional
is_ewallet_deposit
booleanÂ
optional
invoices
array[object (InvoiceResponse) {31}]  | nullÂ
optional
payment_gateway_used
enum<string>Â
optional
Offline
-RazorpayIndia
-PayenginUSA
-TwoC2pVietnam
-TwoC2pSingapore
-TwoC2pMalaysia
-EzypayAustralia
-EzypaySingapore
-EzypayMalaysia
-EzypayPhilippines
-PayenginePhilippines
-PayenginCanada
-StripeCanada
-StripeUSA
-TapSaudi
-TapUAE
-TapKuwait
-TapOman
-TapBahrain
-TapEgypt
-EzypayNewZeland
-EzypaySouthKoria
-StripeUAE
-Allowed values:
OfflineRazorpayIndiaPayenginUSATwoC2pVietnamTwoC2pSingaporeTwoC2pMalaysiaEzypayAustraliaEzypaySingaporeEzypayMalaysiaEzypayPhilippinesPayenginePhilippinesPayenginCanadaStripeCanadaStripeUSATapSaudiTapUAETapKuwaitTapOmanTapBahrainTapEgyptEzypayNewZelandEzypaySouthKoriaStripeUAE
settlement_id
string  | nullÂ
optional
dispute_status
enum<string>Â
optional
None
-Open
-Lost
-Won
-Allowed values:
NoneOpenLostWon
payment_method
object (GetClientPaymentTokenResponse)Â
optional
statistics
array[object (PaymentResponse) {32}]  | nullÂ
optional
id
integer <int64>
optional
log_id
integer <int64>
optional
company_id
integer <int32>
optional
collected_for_tenant_id
integer <int32>
optional
collected_at_tenant_id
integer <int32>
optional
paid_by_client_id
integer <int64>
optional
paid_for_client_id
integer <int64>
optional
amount_in_minor_currency
integer <int64>
optional
is_online
booleanÂ
optional
paymode_level1
enum<string>Â
optional
Cash
-Card
-NetBanking
-UPI
-Wallet
-ACH
-Cheque
-Other
-Emandate
-Adjustment
-PayTo
-Allowed values:
CashCardNetBankingUPIWalletACHChequeOtherEmandateAdjustmentPayTo
payment_mode_level2_id
enum<string>Â
optional
Cash
-Debit
-Credit
-Emandate
-UPI
-Paytm
-AmazonPay
-Venmo
-ACH
-Cheque
-Sodexo
-NetBanking
-ApplePay
-CareemPay
-Knet
-OmanPay
-Fawry
-Benefit
-Mada
-Tabby
-Transfer
-PayTo
-Card
-GCash
-GooglePay
-Link
-Allowed values:
CashDebitCreditEmandateUPIPaytmAmazonPayVenmoACHChequeSodexoNetBankingApplePayCareemPayKnetOmanPayFawryBenefitMadaTabbyTransferPayToCardGCashGooglePayLink
payment_mode_master_id
integer <int32>
optional
payment_mode_master_name_primary_language
string  | nullÂ
optional
payment_mode_master_name_secondary_language
string  | nullÂ
optional
number
integer <int32>
optional
number_prefix
string  | nullÂ
optional
status
enum<string>Â
optional
Open
-PartiallyOpen
-Closed
-Void
-Refunded
-Allowed values:
OpenPartiallyOpenClosedVoidRefunded
void_reason
string  | nullÂ
optional
bulk_uuid
string  | nullÂ
optional
is_number_generated
booleanÂ
optional
created_by
integer <int32>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
payment_date
string <date-time>
optional
sales_representative
integer <int32>
optional
is_ewallet_deposit
booleanÂ
optional
invoices
array[object (InvoiceResponse) {31}]  | nullÂ
optional
payment_gateway_used
enum<string>Â
optional
Offline
-RazorpayIndia
-PayenginUSA
-TwoC2pVietnam
-TwoC2pSingapore
-TwoC2pMalaysia
-EzypayAustralia
-EzypaySingapore
-EzypayMalaysia
-EzypayPhilippines
-PayenginePhilippines
-PayenginCanada
-StripeCanada
-StripeUSA
-TapSaudi
-TapUAE
-TapKuwait
-TapOman
-TapBahrain
-TapEgypt
-EzypayNewZeland
-EzypaySouthKoria
-StripeUAE
-Allowed values:
OfflineRazorpayIndiaPayenginUSATwoC2pVietnamTwoC2pSingaporeTwoC2pMalaysiaEzypayAustraliaEzypaySingaporeEzypayMalaysiaEzypayPhilippinesPayenginePhilippinesPayenginCanadaStripeCanadaStripeUSATapSaudiTapUAETapKuwaitTapOmanTapBahrainTapEgyptEzypayNewZelandEzypaySouthKoriaStripeUAE
settlement_id
string  | nullÂ
optional
dispute_status
enum<string>Â
optional
None
-Open
-Lost
-Won
-Allowed values:
NoneOpenLostWon
payment_method
object (GetClientPaymentTokenResponse)Â
optional
total_items
integer <int64>
optional
total_pages
integer <int64>
optional
current_page
integer <int64>
optional
Example
{
"items": [
{
"id": 0,
"log_id": 0,
"company_id": 0,
"collected_for_tenant_id": 0,
"collected_at_tenant_id": 0,
"paid_by_client_id": 0,
"paid_for_client_id": 0,
"amount_in_minor_currency": 0,
"is_online": true,
"paymode_level1": "Cash",
"payment_mode_level2_id": "Cash",
"payment_mode_master_id": 0,
"payment_mode_master_name_primary_language": "string",
"payment_mode_master_name_secondary_language": "string",
"number": 0,
"number_prefix": "string",
"status": "Open",
"void_reason": "string",
"bulk_uuid": "string",
"is_number_generated": true,
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"payment_date": "2019-08-24T14:15:22Z",
"sales_representative": 0,
"is_ewallet_deposit": true,
"invoices": [
{
"id": 0,
"company_id": 0,
"tenant_id": 0,
"company_uuid": "string",
"tenant_uuid": "string",
"client_id": 0,
"is_recurring": true,
"client_subscription_id": 0,
"number": 0,
"number_prefix": "string",
"billing_name": "string",
"sales_representative": 0,
"total_base_amount_in_minor_currency": 0,
"total_tax_amount_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"total_payment_in_minor_currency": 0,
"total_balance_due_in_minor_currency": 0,
"total_sales_return_in_minor_currency": 0,
"total_write_off_amount_in_minor_currency": 0,
"issue_date": "2019-08-24T14:15:22Z",
"track_mode": "StaffWebApp",
"migration_id": "string",
"due_date": "2019-08-24T14:15:22Z",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"status": "Void",
"invoice_line_item": [
{
"id": 0,
"invoice_id": 0,
"description": "string",
"type": "Service",
"base_unit_cost_in_minor_currency": 0,
"net_unit_cost_in_minor_currency": 0,
"quantity": 0,
"total_base_cost_in_minor_currency": 0,
"net_cost_in_minor_currency": 0,
"discount_staff_in_minor_currency": 0,
"discount_coupon_in_minor_currency": 0,
"total_tax_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"service_id": 0,
"service_category_id": 0,
"charge_category_id": 0,
"total_sales_return_amount": 0,
"total_sales_return_quantity": 0,
"invoice_tax_line_item": [
{
"id": 0,
"invoice_id": 0,
"invoice_line_id": 0,
"tax_regime_name": "GSTIndia",
"tax_line_id": 0,
"tax_name_primary_language": "string",
"tax_name_secondary_language": "string",
"rate": 0,
"total_tax_amount_in_minor_currency": 0
}
]
}
],
"invoice_uuid": "string",
"invoice_presale": "string"
}
],
"payment_gateway_used": "Offline",
"settlement_id": "string",
"dispute_status": "None",
"payment_method": {
"id": 0,
"level1": "Cash",
"level2": "Cash",
"network_type": "string",
"masked_card_number": "string",
"masked_account_number": "string",
"upi_provider": "string",
"vpa_id": "string",
"expiry_date": "2019-08-24T14:15:22Z",
"token_status": "iniitiated",
"bank_name": "string",
"pay_to_details": "string",
"token_account_holder_name": "string",
"token_alias_type": "string",
"token_alias_type_id": "string",
"token_account_type": "string",
"is_apple_pay_or_google_pay": true
}
}
],
"statistics": [
{
"id": 0,
"log_id": 0,
"company_id": 0,
"collected_for_tenant_id": 0,
"collected_at_tenant_id": 0,
"paid_by_client_id": 0,
"paid_for_client_id": 0,
"amount_in_minor_currency": 0,
"is_online": true,
"paymode_level1": "Cash",
"payment_mode_level2_id": "Cash",
"payment_mode_master_id": 0,
"payment_mode_master_name_primary_language": "string",
"payment_mode_master_name_secondary_language": "string",
"number": 0,
"number_prefix": "string",
"status": "Open",
"void_reason": "string",
"bulk_uuid": "string",
"is_number_generated": true,
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"payment_date": "2019-08-24T14:15:22Z",
"sales_representative": 0,
"is_ewallet_deposit": true,
"invoices": [
{
"id": 0,
"company_id": 0,
"tenant_id": 0,
"company_uuid": "string",
"tenant_uuid": "string",
"client_id": 0,
"is_recurring": true,
"client_subscription_id": 0,
"number": 0,
"number_prefix": "string",
"billing_name": "string",
"sales_representative": 0,
"total_base_amount_in_minor_currency": 0,
"total_tax_amount_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"total_payment_in_minor_currency": 0,
"total_balance_due_in_minor_currency": 0,
"total_sales_return_in_minor_currency": 0,
"total_write_off_amount_in_minor_currency": 0,
"issue_date": "2019-08-24T14:15:22Z",
"track_mode": "StaffWebApp",
"migration_id": "string",
"due_date": "2019-08-24T14:15:22Z",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"status": "Void",
"invoice_line_item": [
{
"id": 0,
"invoice_id": 0,
"description": "string",
"type": "Service",
"base_unit_cost_in_minor_currency": 0,
"net_unit_cost_in_minor_currency": 0,
"quantity": 0,
"total_base_cost_in_minor_currency": 0,
"net_cost_in_minor_currency": 0,
"discount_staff_in_minor_currency": 0,
"discount_coupon_in_minor_currency": 0,
"total_tax_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"service_id": 0,
"service_category_id": 0,
"charge_category_id": 0,
"total_sales_return_amount": 0,
"total_sales_return_quantity": 0,
"invoice_tax_line_item": [
{
"id": 0,
"invoice_id": 0,
"invoice_line_id": 0,
"tax_regime_name": "GSTIndia",
"tax_line_id": 0,
"tax_name_primary_language": "string",
"tax_name_secondary_language": "string",
"rate": 0,
"total_tax_amount_in_minor_currency": 0
}
]
}
],
"invoice_uuid": "string",
"invoice_presale": "string"
}
],
"payment_gateway_used": "Offline",
"settlement_id": "string",
"dispute_status": "None",
"payment_method": {
"id": 0,
"level1": "Cash",
"level2": "Cash",
"network_type": "string",
"masked_card_number": "string",
"masked_account_number": "string",
"upi_provider": "string",
"vpa_id": "string",
"expiry_date": "2019-08-24T14:15:22Z",
"token_status": "iniitiated",
"bank_name": "string",
"pay_to_details": "string",
"token_account_holder_name": "string",
"token_alias_type": "string",
"token_alias_type_id": "string",
"token_account_type": "string",
"is_apple_pay_or_google_pay": true
}
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
}
Modified at 2025-03-21 07:23:14