- 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 sales returns
GET
/clients/{client_id}/sales_returns
Request
Path Params
Query Params
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 GET '/clients//sales_returns'Responses
🟢200OK
text/plain
Body
Example
{
"items": [
{
"id": 0,
"invoice_id": 0,
"company_id": 0,
"tenant_id": 0,
"client_id": 0,
"number": 0,
"number_prefix": "string",
"invoice_number_prefix": "string",
"sales_rep": 0,
"total_base_amount_in_minor_currency": 0,
"total_tax_amount_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"sales_return_date": "2019-08-24T14:15:22Z",
"track_mode": "StaffWebApp",
"migration_id": "string",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"return_reason": "Injury_Health_Concerns",
"return_comments": "string",
"is_void": true,
"void_reason": "string",
"uuid": "string",
"sales_return_line_items": [
{
"id": 0,
"sales_return_id": 0,
"invoice_line_id": 0,
"description": "string",
"type": "Service",
"net_unit_cost_in_minor_currency": 0,
"quantity": 0,
"net_cost_in_minor_currency": 0,
"total_tax_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"service_id": 0,
"charge_master_id": 0,
"product_id": 0
}
],
"sales_return_tax_line_items": [
{
"id": 0,
"sales_return_id": 0,
"sales_return_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
}
]
}
],
"statistics": [
{
"id": 0,
"invoice_id": 0,
"company_id": 0,
"tenant_id": 0,
"client_id": 0,
"number": 0,
"number_prefix": "string",
"invoice_number_prefix": "string",
"sales_rep": 0,
"total_base_amount_in_minor_currency": 0,
"total_tax_amount_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"sales_return_date": "2019-08-24T14:15:22Z",
"track_mode": "StaffWebApp",
"migration_id": "string",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"return_reason": "Injury_Health_Concerns",
"return_comments": "string",
"is_void": true,
"void_reason": "string",
"uuid": "string",
"sales_return_line_items": [
{
"id": 0,
"sales_return_id": 0,
"invoice_line_id": 0,
"description": "string",
"type": "Service",
"net_unit_cost_in_minor_currency": 0,
"quantity": 0,
"net_cost_in_minor_currency": 0,
"total_tax_in_minor_currency": 0,
"total_amount_in_minor_currency": 0,
"service_id": 0,
"charge_master_id": 0,
"product_id": 0
}
],
"sales_return_tax_line_items": [
{
"id": 0,
"sales_return_id": 0,
"sales_return_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
}
]
}
],
"total_items": 0,
"total_pages": 0,
"current_page": 0
}Modified at 2025-03-21 07:23:14