Fetch Day Packages Information

This API endpoint retrieves appointment-level service details for a day package invoice item, including service info, therapist, room, and equipment for each booked appointment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

DayPackagesInfoResponse

Json PropertyData TypeDescription
day_packageDayPackageDetailsDay package details containing the booked appointments.
errorAPIV2ErrorModelError details if the request fails; null on success.

DayPackageDetails

Json PropertyData TypeDescription
descriptionstringDescription of the day package.
appointmentsListList of appointments booked under the day package.

DayPackageAppointmentInfo

Json PropertyData TypeDescription
appointment_idGuidUnique identifier of the appointment.
serviceDayPackageServiceInfoService booked for this appointment.
pricedecimal?Service price for this appointment within the day package.
start_timeDateTime?Appointment start time in the center's local timezone.
end_timeDateTime?Appointment end time in the center's local timezone.
therapistDayPackageTherapistInfoTherapist assigned to the appointment.
roomDayPackageResourceInfoRoom assigned to the appointment.
equipmentDayPackageResourceInfoEquipment assigned to the appointment.

DayPackageServiceInfo

Json PropertyData TypeDescription
idGuidUnique identifier of the service.
namestringDisplay name of the service.

DayPackageTherapistInfo

Json PropertyData TypeDescription
idGuid?Unique identifier of the therapist. Null if no therapist is assigned.
namestringDisplay name of the therapist.

DayPackageResourceInfo

Json PropertyData TypeDescription
idGuid?Unique identifier of the resource. Null if the resource is not assigned.
namestringDisplay name of the resource (room or equipment).

APIV2ErrorModel

Json PropertyData TypeDescription
codestringApplication-specific error code.
messagestringHuman-readable description of the error.
Path Params
string
required

Unique identifier of the appointment group for which day package details are retrieved.

Query Params
string

Unique identifier of the day package invoice item.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain