Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve invoice details

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

get/v1/invoices/{invoice_id}?expand=InvoiceItems&expand=Transactions

Path parameters

invoice_idstring required

Mandatory Unique 32-character identifier of the invoice.

Query parameters

expandstring

when the relevant parameters is passed in the expand query param the respective object information is retrieved in the response of this API. For every additional information you need the respective parameter needs to be passed.

Response

200

OR

Example response

{
  "invoice": {
    "id": "718d48f1-1ee6-45cb-8c16-e34d37e4ab14",
    "is_closed": true,
    "invoice_date": "2019-08-09T19:07:03",
    "center_id": "cab7edd3-d8e8-4c27-a36b-8aa16b8dbb4f",
    "total_price": {
      "net_price": 250,
      "tax": 12.66,
      "sum_total": 262.66
    },
    "guest": {
      "id": "9b26dcda-d1a0-48d1-a613-259311701cc2",
      "first_name": "simon",
      "last_name": "test",
      "gender": 1,
      "code": "TR423",
      "mobile_phone": "+61 6677889900"
    },
    "invoice_items": [
      {
        "invoice_item_id": "48eb0d97-da84-4e33-9431-21dac6c9ec1c",
        "id": "0fe0102e-4e14-4cc3-9a37-276bcddf1dae",
        "name": "201908090907343530",
        "type": 6,
        "price": {
          "currency_id": 25
        },
        "quantity": 1,
        "therapist_name": "  "
      }
    ],
    "transactions": [
      {
        "payment_option": {
          "id": "7e71c340-b971-4c1c-8c64-4a9720f12587",
          "payment_mode": 5,
          "payment_name": "CC Online (visa)",
          "card_number": "****1111"
        },
        "total_amount_paid": 262.66,
        "amount_paid": 262.66,
        "transaction_id": "8849fcf4-bca5-4333-87d3-294ce0a50d90",
        "payment_date": "2019-08-09T09:07:33"
      }
    ]
  }
}