get
https://api.zenoti.com/v1/invoices/?expand=InvoiceItems&expand=Transactions
Use this API to retrieve the details of an invoice. This API supports multiple expand parameters to retrieve more relevant information related to invoice like InvoiceItems, Appointments, Transactions, gst_parameters, and dues_and_fees
Response Object
invoice (for InvoicePOSDetails)
invoice (for InvoicePOSDetails)| JSON Property | Data Type | Description |
|---|---|---|
| group_invoice_id | Guid? | Unique ID of the group invoice. |
| id | Guid | Unique ID of the invoice. |
| invoice_number | string | Invoice number. |
| invoice_number_prefix | string | Prefix for the invoice number. |
| receipt_number | string | Receipt number for the invoice. |
| appointment_group_id | Guid? | Appointment group ID linked to the invoice. |
| lock | bool | Whether the invoice is locked. |
| is_closed | bool | Whether the invoice is closed. |
| is_refund | bool | Whether the invoice is a refund. |
| invoice_date | DateTime | Date of the invoice. |
| center_id | Guid | Unique ID of the center. |
| gstin | string | GSTIN associated with the invoice. |
| invoice_dues | AmountStatusModel | Dues associated with the invoice. |
| environmental_fee | AmountStatusModel | Environmental fee details. |
| total_price | InvoiceTotalPrice | Total price details of the invoice. |
| guest | InvoiceGuestModel | Guest details linked to the invoice. |
| invoice_items | List<InvoiceItemModel> | List of items in the invoice. |
| appointments | List<InvoiceAppointmentModel> | List of appointments linked to the invoice. |
| transactions | List<InvoiceTransactionModel> | List of transactions linked to the invoice. |
| additional_fields | List<AdditionalField<string, object>> | Additional fields related to the invoice. |
error (for ApiErrorViewModel)
error (for ApiErrorViewModel)| JSON Property | Data Type | Description |
|---|---|---|
No properties were provided for ApiErrorViewModel in the code snippet. |
invoice_dues and environmental_fee (for AmountStatusModel)
invoice_dues and environmental_fee (for AmountStatusModel)| JSON Property | Data Type | Description |
|---|---|---|
| total | decimal | Total amount due. |
| paid | decimal | Total amount paid. |
| balance | decimal | Remaining balance amount. |
total_price (for InvoiceTotalPrice)
total_price (for InvoiceTotalPrice)| JSON Property | Data Type | Description |
|---|---|---|
| currency_id | int | ID of the currency. |
| net_price | decimal | Net price of the invoice. |
| tax | decimal | Total tax on the invoice. |
| rounding_adjustment | decimal | Rounding adjustment amount. |
| sum_total | decimal | Final total price. |
guest (for InvoiceGuestModel)
guest (for InvoiceGuestModel)| JSON Property | Data Type | Description |
|---|---|---|
| id | Guid | Unique ID of the guest. |
| first_name | string | First name of the guest. |
| last_name | string | Last name of the guest. |
| gender | GenderSuperSet | Gender of the guest. |
| code | string | Guest code. |
| mobile_phone | string | Guest's mobile phone. |
string | Guest's email address. |
invoice_items (for InvoiceItemModel)
invoice_items (for InvoiceItemModel)| JSON Property | Data Type | Description |
|---|---|---|
| invoice_item_id | Guid | Unique ID of the invoice item. |
| id | Guid | Unique ID of the item. |
| name | string | Name of the item. |
| type | ItemTypeEnum | Type of the item. |
| is_giftcard | bool? | Indicates if it's a gift card. |
| code | string | Item code. |
| price | ItemPriceViewModel | Price details of the item. |
| quantity | int | Quantity of the item. |
| sale_by_id | Guid? | ID of the salesperson. |
| therapist_name | string | Therapist associated with item. |
| hsn | string | HSN code. |
| sac | string | SAC code. |
appointments (for InvoiceAppointmentModel)
appointments (for InvoiceAppointmentModel)| JSON Property | Data Type | Description |
|---|---|---|
| id | Guid | Unique ID of the appointment. |
| invoice_item_id | Guid | Linked invoice item ID. |
| service_name | string | Name of the service. |
| service_id | Guid | ID of the service. |
| start_time | DateTime | Start time of the service. |
| end_time | DateTime | End time of the service. |
| serviceduration_in_miutes | int | Duration of the service in minutes. |
| has_add_ons | bool | Whether the service has add-ons. |
| is_add_on | bool | Whether the service is an add-on. |
| therapist_name | string | Name of the therapist. |
| therapist_id | Guid? | ID of the therapist. |
| package_id | Guid? | Linked package ID. |
| is_recurring | bool | Indicates if the appointment recurs. |
| cart_item_id | Guid? | Linked cart item ID. |
| appointment_type | AppointmentTypeViewModel | Type of the appointment. |
| therapist_request_type | int | Therapist request type. |
| room_id | Guid? | Linked room ID. |
| room_name | string | Name of the room. |
| equipment_id | Guid? | Linked equipment ID. |
| equipment_name | string | Name of the equipment. |
transactions (for InvoiceTransactionModel)
transactions (for InvoiceTransactionModel)| JSON Property | Data Type | Description |
|---|---|---|
| payment_option | PaymentOptionViewModel | Payment option details. |
| total_amount_paid | decimal | Total amount paid. |
| amount_paid | decimal | Amount paid in the transaction. |
| tip_amount | decimal | Tip amount paid. |
| ssg_amount | decimal | SSG amount paid. |
| donation_amount | decimal | Donation amount included. |
| fee_amount | decimal | Fee amount paid. |
| cash_back_amount | decimal | Cashback amount received. |
| transaction_id | Guid? | Unique ID of the transaction. |
| payment_date | DateTime? | Date of the payment. |
| cash_regester_id | Guid? | Linked cash register ID. |
error Object
| code | message |
|---|---|
| 602 | User does not have access. |
| 438 | cannot access. |
| 401 | Authorization has been denied for this request. |
| 602 | Cannot access. |
| 400 | The request is invalid. |
| 405 | The requested resource does not support http method 'GET'. |
| 418 | couldn't find invoice with the id provided, invoice id : |