Sign in
latestOpenAPI 3.1.02026-07-2422707.0 MB

e628f892391a

Retrieve invoice details including GST sequence details

This API fetches invoice details including GST sequence details. This invoice details API supports "expand" query parameter. The user has to pass "gst_parameters" to the "expand" query parameter.

get/v1/invoices/{invoice_id}

Query parameters

expandstring

gst_parameters should be passed for the call to be successful.

Request body

RAW_BODYstring

Response

200

OR
OR
OR

Example response

{
  "invoice": {
    "id": "34ca4f0f-c11c-434f-9a36-cba6df701397",
    "invoice_number": "117798",
    "invoice_number_prefix": "CMEMGM",
    "receipt_number": "CMEMGMR2308",
    "appointment_group_id": "28d49469-9256-4893-b5fb-2b7e269b4120",
    "is_closed": true,
    "invoice_date": "2025-01-21T13:00:00",
    "has_redemptions": true,
    "center_id": "7aac6915-9252-4dbf-bbff-028e41836ea8",
    "invoice_dues": {
      "total": 3014.9,
      "paid": 3014.9
    },
    "environmental_fee": {
      "total": 10,
      "paid": 10
    },
    "total_price": {
      "net_price": 3000,
      "tax": 4.9,
      "sum_total": 3004.9
    },
    "guest": {
      "id": "e1d61626-629c-4531-8fb5-9b782e21214f",
      "first_name": "Vikas",
      "last_name": "Yadav",
      "gender": 1,
      "mobile_phone": "+1 8754673816"
    },
    "invoice_items": [
      {
        "invoice_item_id": "2b31596e-19c2-4f58-8f5f-d5fc0a1e7250",
        "id": "3185f93e-9ca5-4b50-afb5-f013d3f2ff9b",
        "name": "30 minutes",
        "code": "30m",
        "price": {
          "currency_id": 148,
          "sales": 50,
          "tax": 4.9,
          "final": 54.1
        },
        "quantity": 1,
        "sale_by_id": "4fa7827c-b941-4530-ad72-9e9cd1364861",
        "therapist_name": "Agent Support "
      }
    ],
    "appointments": [
      {
        "id": "5421849a-c163-4b16-80c6-e053274700db",
        "invoice_item_id": "2b31596e-19c2-4f58-8f5f-d5fc0a1e7250",
        "service_name": "30 minutes",
        "service_id": "3185f93e-9ca5-4b50-afb5-f013d3f2ff9b",
        "start_time": "2025-01-21T07:30:00",
        "end_time": "2025-01-21T08:00:00",
        "serviceduration_in_miutes": 30,
        "has_add_ons": true,
        "therapist_name": "Agent S",
        "TherapistId": "4fa7827c-b941-4530-ad72-9e9cd1364861",
        "appointment_type": 2,
        "therapist_request_type": 4,
        "room_name": "Chennai  Room 1"
      }
    ],
    "transactions": [
      {
        "payment_option": {
          "id": "f5af004c-37ef-478f-868f-38d3a37aebc1",
          "payment_name": "CASH"
        },
        "total_amount_paid": 3024.9,
        "amount_paid": 3004.9,
        "ssg_amount": 10,
        "fee_amount": 10,
        "transaction_id": "7322adcd-21c9-4df7-92c6-191a7b73f70b",
        "payment_date": "2025-01-21T17:58:30"
      }
    ]
  }
}