| Time | Status | User Agent | |
|---|
Retrieving recent requests… |
| Json Property | Data Type | Description |
|---|
| invoice | InvoicePOSDetails | Details of the invoice |
| error | ApiErrorViewModel | Error information, if any |
| Json Property | Data Type | Description |
|---|
| group_invoice_id | Guid? | Group invoice identifier (nullable) |
| id | Guid | Invoice identifier |
| invoice_number | string | Invoice number |
| invoice_number_prefix | string | Prefix for the invoice number |
| receipt_number | string | Receipt number |
| appointment_group_id | Guid? | Appointment group identifier (nullable) |
| lock | bool | Indicates if the invoice is locked |
| is_closed | bool | Indicates if the invoice is closed |
| is_refund | bool | Indicates if the invoice is a refund |
| invoice_date | DateTime | Date of the invoice |
| has_redemptions | bool? | Indicates if the invoice has redemptions |
| center_id | Guid | Center identifier |
| gstin | string | GSTIN (nullable) |
| gst_sequence | GstSequence | Invoice GST sequence |
| invoice_dues | AmountStatusModel | Invoice dues details |
| environmental_fee | AmountStatusModel | Environmental fee details |
| total_price | InvoiceTotalPrice | Total price details |
| guest | InvoiceGuestModel | Guest details |
| invoice_items | | List of invoice items |
| appointments | | List of invoice appointments |
| transactions | | List of transactions |
| additional_fields | <AdditionalField<string, object>> | Additional fields for the invoice |
| Json Property | Data Type | Description |
|---|
| prefix | string | GST sequence prefix |
| number | string | GST sequence number |
| Json Property | Data Type | Description |
|---|
| total | decimal | Total amount |
| paid | decimal | Amount paid |
| balance | decimal | Remaining balance |
| Json Property | Data Type | Description |
|---|
| currency_id | int | Currency identifier |
| net_price | decimal | Net price |
| tax | decimal | Tax amount |
| rounding_adjustment | decimal | Rounding adjustment |
| sum_total | decimal | Sum total price |
Note: Although the property name in code is “RoundingAdjustMent”, the JSON property is “rounding_adjustment”.
| Json Property | Data Type | Description |
|---|
| id | Guid | Guest identifier |
| first_name | string | Guest first name |
| last_name | string | Guest last name |
| gender | GenderSuperSet | Gender |
| code | string | Guest code |
| mobile_phone | string | Mobile phone number |
| email | string | Email address |
| Json Property | Data Type | Description |
|---|
| invoice_item_id | Guid | Invoice item identifier |
| id | Guid | Item identifier |
| name | string | Item name |
| type | ItemTypeEnum | Item type |
| is_giftcard | bool? | Indicates if the item is a gift card |
| code | string | Item code |
| price | ItemPriceViewModel | Item price details |
| quantity | int | Quantity |
| sale_by_id | Guid? | Sale by identifier |
| therapist_name | string | Therapist name |
| hsn | string | HSN (nullable) |
| sac | string | SAC (nullable) |
| Json Property | Data Type | Description |
|---|
| id | Guid | Appointment identifier |
| invoice_item_id | Guid | Invoice item identifier |
| service_name | string | Service name |
| service_id | Guid | Service identifier |
| start_time | DateTime | Start time |
| end_time | DateTime | End time |
| serviceduration_in_miutes | int | Service duration in minutes |
| has_add_ons | bool | Indicates if add-ons are available |
| is_add_on | bool | Indicates if the appointment is an add-on |
| therapist_name | string | Therapist name |
| TherapistId | Guid? | Therapist identifier |
| package_id | Guid? | Package identifier |
| is_recurring | bool | Indicates if the appointment is recurring |
| cart_item_id | Guid? | Cart item identifier |
| appointment_type | AppointmentTypeViewModel | Appointment type |
| therapist_request_type | int | Therapist request type |
| room_id | Guid? | Room identifier |
| room_name | string | Room name |
| equipment_id | Guid? | Equipment identifier |
| equipment_name | string | Equipment name |
| Json Property | Data Type | Description |
|---|
| payment_option | PaymentOptionViewModel | Payment option details |
| total_amount_paid | decimal | Total amount paid |
| amount_paid | decimal | Amount paid |
| tip_amount | decimal | Tip amount |
| ssg_amount | decimal | SSG amount |
| donation_amount | decimal | Donation amount |
| fee_amount | decimal | Fee amount |
| cash_back_amount | decimal | Cash back amount |
| transaction_id | Guid? | Transaction identifier |
| payment_date | DateTime? | Payment date |
| cash_regester_id | Guid? | Cash register identifier |
| gst_sequences | List | Transaction GST sequences |
| Json Property | Data Type | Description |
|---|
| key | T | Key |
| value | K | Value |
| Json Property | Data Type | Description |
|---|
| currency_id | int | Currency identifier |
| sales | decimal | Sales amount |
| tax | decimal | Tax amount |
| final | decimal | Final price |
| discount | decimal | Discount amount |
| Json Property | Data Type | Description |
|---|
| id | Guid | Identifier |
| payment_mode | PaymentModeV1 | Payment mode |
| payment_name | string | Payment name |
| card_number | string | Card number |
| additional_data | string | Additional data |
Below are the enums defined in the code.
| Json Property | Data Type | Description |
|---|
| NotSpecified | -1 | Not specified |
| Male | 1 | Male |
| Female | 2 | Female |
| Any | 0 | Any |
| ThirdGender | 3 | Third gender |
| Multiple | 4 | Multiple genders |
| Json Property | Data Type | Description |
|---|
| None | -1 | None |
| Service | 0 | Service |
| Product | 2 | Product |
| Membership | 3 | Membership |
| SeriesPackage | 4 | Series package |
| DayPromoPackage | 5 | Day promo package |
| GiftCard | 6 | Gift card |
| Employee | 8 | Employee |
| Class | 11 | Class |
| AddOns | 14 | Add-ons |
| ServiceRefund | -90 | Service refund |
| ProductRefund | -92 | Product refund |
| MembershipRefund | -93 | Membership refund |
| ClassRefund | -911 | Class refund |
| GiftCardRefund | -96 | Gift card refund |
| SeriesPackageRefund | -94 | Series package refund |
| DayPromoPackageRefund | -95 | Day promo package refund |
| Json Property | Data Type | Description |
|---|
| GroupBooking | 0 | Group booking |
| BulkBooking | 1 | Bulk booking |
| SingleBooking | 2 | Single booking |
| CoupleBooking | 3 | Couple booking |
| Json Property | Data Type | Description |
|---|
| NotSpecified | -1 | Not specified |
| Cash | 0 | Cash |
| GiftCard | 1 | Gift card |
| Membership | 2 | Membership |
| Package | 3 | Package |
| Custom | 4 | Custom |
| CreditCard | 5 | Credit card |
| Cheque | 6 | Cheque |
| LoyaltyPoints | 7 | Loyalty points |
| Cashback | 8 | Cashback |
| PrepaidCard | 9 | Prepaid card |
