# Get appointment billing details by domain and appointment id

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

Endpoint: GET /integrations/v1/{domain}/appointments/{appointmentId}/billing
Version: v1
Security: Bearer

## Path parameters:

  - `domain` (string, required)
    Partner domain identifier. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.
    Example: "acme"

  - `appointmentId` (string, required)
    Appointment identifier within the specified domain.
    Example: "A123456"

## Header parameters:

  - `X-Correlation-Id` (string)
    Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.
    Example: "4b7f0a91b4f54f2a"

## Response 200 fields (application/json):

  - `domain` (string, required)
    Domain this appointment belongs to.
    Example: "Example domain"

  - `appointmentId` (string, required)
    Appointment identifier.
    Example: "123"

  - `batchSk` (string)
    Example: "Example batchSk"

  - `billingStatus` (string)
    Billing status for the appointment.
    Example: "active"

  - `billingType` (string)
    Billing type for the appointment.
    Example: "Example billingType"

  - `invoiceCreationError` (string)
    Latest billing error when available.
    Example: "Example invoiceCreationError"

  - `invoiceNumber` (string)
    Invoice number when available.
    Example: "Example invoiceNumber"

  - `invoiceSk` (string)
    Invoice record key when available.
    Example: "Example invoiceSk"

  - `isBillingsChecked` (boolean)
    Whether billing validation has been completed.
    Example: true

  - `medicareExpiryDate` (null,string)
    Example: "2020-01-01"

  - `medicareIrn` (string)
    Example: "Example medicareIrn"

  - `medicareNumber` (string)
    Example: "Example medicareNumber"

  - `providerNumber` (string)
    Example: "Example providerNumber"

  - `serviceItemNumbers` (string)
    Concatenated service item numbers when available.
    Example: "Example serviceItemNumbers"

  - `serviceItems` (array)
    Service item details attached to the appointment.

  - `serviceItems.itemNo` (string, required)
    Service item number.
    Example: "Example itemNo"

  - `serviceItems.key` (string)
    Example: "Example key"

  - `serviceItems.appointmentId` (string)
    Appointment identifier this item belongs to.
    Example: "123"

  - `serviceItems.bulkBillingSpecialist` (null,number)
    Example: 1.23

  - `serviceItems.chargeAmount` (null,number)
    Example: 1.23

  - `serviceItems.dateOfService` (null,string)
    Date of service (ISO 8601, yyyy-MM-dd).
    Example: "2020-01-01"

  - `serviceItems.duration` (null,integer)
    Optional duration (in minutes) associated with the service item.
    Example: 1

  - `serviceItems.dvaSpecialist` (null,number)
    Example: 1.23

  - `serviceItems.errorCode` (string)
    Example: "ABC123"

  - `serviceItems.examCodeId` (string)
    Example: "123"

  - `serviceItems.groupId` (string)
    Example: "123"

  - `serviceItems.lastModifiedBy` (object)
    A lightweight user identity summary.

  - `serviceItems.lastModifiedBy.username` (string, required)
    User's unique username.
    Example: "Example Name"

  - `serviceItems.lastModifiedBy.firstName` (string)
    User's first name.
    Example: "Example Name"

  - `serviceItems.lastModifiedBy.initials` (string)
    User's initials when available.
    Example: "Example initials"

  - `serviceItems.lastModifiedBy.lastName` (string)
    User's last name.
    Example: "Example Name"

  - `serviceItems.lastModifiedBy.role` (string)
    User role when available.
    Example: "Example role"

  - `serviceItems.lastModifiedDateTime` (null,string)
    Example: "2020-01-01T00:00:00Z"

  - `serviceItems.lspn` (string)
    Example: "Example lspn"

  - `serviceItems.medicareUuid` (string)
    Example: "123"

  - `serviceItems.modality` (string)
    Example: "Example modality"

  - `serviceItems.objectType` (string)
    Example: "Example objectType"

  - `serviceItems.shortDescription` (string)
    Example: "Example description"

  - `serviceItems.site` (string)
    Example: "Example site"

  - `serviceItems.status` (string)
    Service item status.
    Example: "active"

  - `serviceItems.subGroup` (string)
    Example: "Example subGroup"

  - `serviceItems.subGroupId` (null,integer)
    Example: 1

  - `serviceItems.uuid` (string)
    Example: "123"

## Response 400 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:bad-request"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 400

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

## Response 401 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:unauthorized"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 401

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

## Response 403 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:forbidden"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 403

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

## Response 404 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:not-found"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 404

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

## Response 429 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:too-many-requests"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 429

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

## Response 500 fields (application/problem+json):

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:server-error"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 500

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"