- 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
Creates charges for a client
POST
/tenants/{tenant_id}/clients/{client_id}/charges/createcharges
Request
Path Params
Body Params application/json
Example
{
"collected_at": 0,
"sales_rep": 0,
"issue_date": "2019-08-24T14:15:22Z",
"billing_name": "string",
"is_offline_payment": true,
"offline_payment": {
"paymode_level1": "Cash",
"paymode_level2_id": "Cash",
"other_paymode_master_id": 0,
"amount_in_minor_currency": 0,
"upi_provider": "string",
"vpa_id": "string",
"card_number": "string",
"network_type": "string",
"auth_code": "string",
"exp_date": "2019-08-24T14:15:22Z",
"bank_name": "string",
"cheque_date": "2019-08-24T14:15:22Z",
"is_credit_balance_used": true,
"credit_balance_amount_in_minor_currency": 0
},
"is_coupon_code_applied": true,
"sigup_coupon_code": "string",
"charging_today": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"service_first_charge_mid_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"signup_charges": [
{
"id": 0,
"amount_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"taxgrp_id": 0,
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
]
},
"charging_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"prorata_future_recurring": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"service_first_charge_mid_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"signup_charges": [
{
"id": 0,
"amount_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"taxgrp_id": 0,
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
]
},
"pos_device_sale": {
"sale_device_id": "string",
"merchant_id": "string",
"payment_gateway_supported": "Offline"
},
"complition_target_device": "TabletApp"
}Request Code 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 POST '/tenants//clients//charges/createcharges' \
--header 'Content-Type: application/json' \
--data-raw '{
"collected_at": 0,
"sales_rep": 0,
"issue_date": "2019-08-24T14:15:22Z",
"billing_name": "string",
"is_offline_payment": true,
"offline_payment": {
"paymode_level1": "Cash",
"paymode_level2_id": "Cash",
"other_paymode_master_id": 0,
"amount_in_minor_currency": 0,
"upi_provider": "string",
"vpa_id": "string",
"card_number": "string",
"network_type": "string",
"auth_code": "string",
"exp_date": "2019-08-24T14:15:22Z",
"bank_name": "string",
"cheque_date": "2019-08-24T14:15:22Z",
"is_credit_balance_used": true,
"credit_balance_amount_in_minor_currency": 0
},
"is_coupon_code_applied": true,
"sigup_coupon_code": "string",
"charging_today": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"service_first_charge_mid_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"signup_charges": [
{
"id": 0,
"amount_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"taxgrp_id": 0,
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
]
},
"charging_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"prorata_future_recurring": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"service_first_charge_mid_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
},
"signup_charges": [
{
"id": 0,
"amount_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"taxgrp_id": 0,
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"base_cost_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"session_owner_id": 0,
"sessions": 0,
"taxgrp_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
],
"discount_reason": "string",
"plan_id": 0,
"is_addons": true,
"service_category_guid": "string"
}
]
}
]
},
"pos_device_sale": {
"sale_device_id": "string",
"merchant_id": "string",
"payment_gateway_supported": "Offline"
},
"complition_target_device": "TabletApp"
}'Responses
🟢200OK
text/plain
Body
Example
{
"charges_link_uuid": "string",
"client_charges_ids": [
0
],
"invoice_id": 0
}Modified at 2025-03-21 07:23:14