get https://api.zenoti.com/v1/Centers//collections_report?start_date=&end_date=
NOTE : This API is deprecated. Requesting not to use this API for any new integrations as the data cannot be reconciled to new collection report available in the UI. This API retrieves the list of collections of the specified center during the selected date range.You must specify appropriate details for the center_id
, start_date
, and end_date
parameters in the API request.Note : The date range that you specify cannot be more than seven days.
Response Details
Name | Type | Description |
---|---|---|
invoice_id | guid | Unique 32-character identifier of the center. |
invoice_no | string | Unique number assigned to the invoice. |
reciept_no | string | Unique number assigned to the receipt. |
created_date | datetime | Created date of the invoice. |
status | integer | Status of the invoice: 0 - Open and 4 - Closed. |
total_collection | decimal | Total amount collected on the invoice. |
gross_amount | decimal | Gross value of the invoice |
net_amount | decimal | Net value of the invoice. |
discount | decimal | Discount applied on the invoice. |
rounding_adjustment | decimal | Rounding adjustment made on the invoice. |
cashback | decimal | Total cashback paid to the guest's card. |
guest_id | guid | Unique 32-character identifier of the guest. |
transactions | object | Object that contains these list of transaction-related elements made on the invoice: date, type, detail_type, amount, cashback, tips, and ssg. |
items | object | Object that contains the list of items selected as part of the invoice. For more information, refer to the items Object table. |
employee_tips | object | Object that contains these employee tips-related elements: employee_id and tip_amount. |
Error | object | Object that contains error message and error code details. |
page_info Object
Name | Type | Description |
---|---|---|
id | guid | Unique 32-character identifier of the invoice item. |
name | string | Name of the invoice item. |
code | string | Code of the invoice item. |
type | string | Indicates the type of invoice item. |
quantity | integer | Quantity selected as part of the invoice. |
final_sale_price | decimal | Final sale price of the item. |
discount | decimal | Discount applied on the item. |
cashback_redemption | decimal | Cashback redemption on the invoice. |
therapist_id | guid | Unique 32-character identifier of the therapist. |
taxes | object | Object that contains details of tax breakups. |
taxes.type | string | Type of the tax. |
taxes.amount | decimal | Amount collected as tax. |
taxes.tax_percentage | decimal | Tax percentage set for this particular tax type. |
taxes.item_percentage | decimal | Each sale item's price is taxed by this percentage. Typically, this should be set as 100%. In some cases, you may be able to tax only a portion of the sale price. |
payments | object | Object that contains payment details of the invoice item. |
payments.type | string | Type of the payment. |
payments.detail_type | string | Detailed type of the payment. |
payments.amount | decimal | Amount made for the item in this payment. |
payments.tax | decimal | Tax collected for this item in this payment. |
payments.tip | decimal | Tip collected for this item in this payment. |
payments.ssg | decimal | Support staff gratuity collected for this item in this payment. |