Get appointment billing details by domain and appointment id

Request

Returns billing and service item details for the specified appointment when the caller has appointments:read_billing access.

Security

Bearer

Path

domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme

appointmentIdstringrequired

Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.

Example:200006

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a

curl -i -X GET \
  https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/appointments/200006/billing \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Billing details for the requested appointment.

Headers

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"

Bodyapplication/json

domainstringrequired

Domain this appointment belongs to.

Example:"Example domain"

appointmentIdstringrequired

Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.

Example:"123"

batchSkstring

Example:"Example batchSk"

billingStatusstring

Billing status for the appointment.

Example:"active"

billingTypestring

Billing type for the appointment.

Example:"Example billingType"

invoiceCreationErrorstring

Latest billing error when available.

Example:"Example invoiceCreationError"

invoiceNumberstring

Invoice number when available.

Example:"Example invoiceNumber"

invoiceSkstring

Invoice record key when available.

Example:"Example invoiceSk"

isBillingsCheckedboolean

Whether billing validation has been completed.

Example:true

medicareExpiryDatenull or string, (date)

Example:"2020-01-01"

medicareIrnstring

Example:"Example medicareIrn"

medicareNumberstring

Example:"Example medicareNumber"

providerNumberstring

Example:"Example providerNumber"

serviceItemNumbersstring

Concatenated service item numbers when available.

Example:"Example serviceItemNumbers"

serviceItemsArray of objects(AppointmentServiceItemResponse)

Service item details attached to the appointment.

Response

{
  "domain": "acme",
  "appointmentId": "200006",
  "batchSk": "BATCH#202501",
  "billingStatus": "active",
  "billingType": "bulk",
  "invoiceNumber": "INV-1001",
  "invoiceSk": "INV#1001",
  "isBillingsChecked": true,
  "medicareNumber": "1234567890",
  "medicareIrn": "1",
  "providerNumber": "1234567A",
  "serviceItemNumbers": "XR001",
  "serviceItems": [
    { … }
  ]
}