EXACT API

Appointments

Get Appointment by Id

Returns a specific appointment by its Id. The Id of an appointment can be obtained through the GetAppointments endpoint, and is passed through a route parameter.

Note

All dates must be strictly specified in ISO8601 format, with the UTC offset. In case you're referring to UTC-0, you can specify it as just Z, e.g. 2019-08-24T14:15:22Z.

Required Scopes: appointment.get

Request

GET /v1/Practices/{practiceId}/Appointments/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
id	path	string (uuid)	True	The Id of the appointment to find. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA

Responses

Status Code	Type	Description
200	AppointmentModel	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Update Appointment

Updates an existing appointment. The Id of an appointment can be obtained through the Get Appointment or List Appointments endpoint, and is passed through a route parameter.

Note

This API is only supported on Exact versions 13.856 and above.

Required Scopes: appointment.update

Request

PATCH /v1/Practices/{practiceId}/Appointments/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice. e.g. UKABC123
id	path	string (uuid)	True	The Id of the appointment. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA
body	body	UpdateAppointmentModel		The appointment information to be updated. Only the fields present in the request will be updated.

Responses

Status Code	Type	Description
200	AppointmentModel	Success
400	string	Bad Request
404	string	Not Found
409	string	Conflict
500	string	Server Error
502	string	Server Error
504	string	Server Error

Get Appointment List

Returns a list of appointments based on a set of parameters. The results are paginated based on the response size. A continuation token will be returned as part of the Header (continuation-token) in case more pages are available. Subsequent calls to retrieve additional pages must include the continuation token as part of the parameters.

Note

All dates must be strictly specified in ISO8601 format, with the UTC offset. In case you're referring to UTC-0, you can specify it as just Z, e.g. 2019-08-24T14:15:22Z.

Required Scopes: appointment.list

Request

GET /v1/Practices/{practiceId}/Appointments?from&to[&practitionerId&patientId&status&locationId&continuationToken]

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
from	query	string (date-time)	True	The start of the time range to list appointments for
to	query	string (date-time)	True	The end of the time range to list appointments for
practitionerId	query	string (uuid)		The ID of the appointment's provider. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA
patientId	query	string (uuid)		The ID of the patient. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA
status	query	string		The status of the appointment
locationId	query	string (uuid)		The ID of the appointment's location. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA
continuationToken	query	string		The continuation token used to fetch the next page of results

Responses

Status Code	Type	Description
200	AppointmentModel[]	Success
204	string	No Content
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Create Appointment

Create a new appointment.

Required Scopes: appointment.create

Request

POST /v1/Practices/{practiceId}/Appointments

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice. e.g. UKABC123
body	body	CreateAppointmentModel		The appointment information used for the creation.

Responses

Status Code	Type	Description
200	AppointmentModel	Success
400	string	Bad Request
404	string	Not Found
409	string	Conflict
500	string	Server Error
502	string	Server Error
504	string	Server Error

Patients

Get Patient by Id

Returns a specific patient by its Id.

Required Scopes: patient.get

Request

GET /v1/Practices/{practiceId}/Patients/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to search for the patient record. e.g. UKABC123
id	path	string (uuid)	True	The Id of the patient to use in the search. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA

Responses

Status Code	Type	Description
200	PatientModel	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Update Patient

Updates an existing patient record.

Only the fields present in the request will be updated. Any omitted field value will be preserved on the client. The patient contact information will behave the same way, but existing email addresses cannot be removed. Any new email address informed during an update operation will be appended to the patient record.

Important

Patient addresses are treated as complete units in the API. You must either provide the entire address block or omit it entirely. If you submit a partial address block, any fields not included will be cleared from the patient's record.

Note

This API is only supported on Exact versions 24.50 and above.

Required Scopes: patient.update

Request

PATCH /v1/Practices/{practiceId}/Patients/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice where the patient belongs to. e.g. UKABC123
id	path	string (uuid)	True	The id of the patient to update.
body	body	UpdatePatientModel		The patient information used for the update.

Responses

Status Code	Type	Description
200	PatientModel	Success
400	string	Bad Request
403	string	Forbidden
404	string	Not Found

List Patients

Returns a list of patients based on a set of parameters.

Required Scopes: patient.list

Request

GET /v1/Practices/{practiceId}/Patients[?FirstName&LastName&DateOfBirth&EmailAddress&PhoneNumber]

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice the patient belongs to. e.g. UKABC123
FirstName	query	string
LastName	query	string
DateOfBirth	query	string (date-time)
EmailAddress	query	string
PhoneNumber	query	string

Responses

Status Code	Type	Description
200	PatientModel[]	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Create Patient

Creates a new patient record.

This endpoint allows for multiple email addresses to informed, however, only the first email in the list will be set as the outbound address.

Note

This API is only supported on Exact versions 24.50 and above.

Required Scopes: patient.create

Request

POST /v1/Practices/{practiceId}/Patients

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice where the patient should be created. e.g. UKABC123
body	body	CreatePatientModel		The patient information used for the creation.

Responses

Status Code	Type	Description
201	PatientModel	Created
400	string	Bad Request
403	string	Forbidden

Contact Patient

Creates a request for a patient contact.

If the patient has opted out of, or does not have the selected communication option, this method will return a 405 - Method not allowed response.

Required Scopes: patient.contact

Request

POST /v1/Practices/{practiceId}/Patients/{id}/Contact

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice the patient belongs to. e.g. UKABC123
id	path	string (uuid)	True	The Id of the patient to contact. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA
body	body	PatientContactRequestModel		The message contents.

Responses

Status Code	Type	Description
202		Accepted
400	string	Bad Request
404	string	Not Found
405	string	Method Not Allowed

Get Patient Contact Details

Returns the contact details of a specific patient by its Id.

Note

Besides the patient.get.contactdetails scope, this endpoint also validates if the caller has either patient.get.contactdetails.phone or patient.get.contactdetails.email scopes. This will determine if phone and email information will be included in the response.

Required Scopes: patient.get.contactdetails

Request

GET /v1/Practices/{practiceId}/Patients/{id}/ContactDetails

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice the patient belongs to. e.g. UKABC123
id	path	string (uuid)	True	The id of the patient. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA

Responses

Status Code	Type	Description
200	PatientContactInfoModel	Success
403	string	Forbidden
404	string	Not Found

Payors

List Payors

Returns the list of practice payors.

Required Scopes: payor.list

Request

GET /v1/Practices/{practiceId}/Payors

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123

Responses

Status Code	Type	Description
200	PayorModel[]	Success
400	string	Bad Request
500	string	Server Error
502	string	Server Error
504	string	Server Error

Get Payor by Id

Retrieve a payor record by Id.

Required Scopes: payor.get

Request

GET /v1/Practices/{practiceId}/Payors/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
id	path	string (uuid)	True	The Id of the payor to find. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA

Responses

Status Code	Type	Description
200	PayorModel	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Practices

Get Practice Details

Get the details of a given practice.

Required Scopes: practice.get

Request

GET /v1/Practices/{practiceId}/details

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123

Responses

Status Code	Type	Description
200	PracticeModel	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Practitioners

List Practitioners

Returns the list of practice practitioners.

Required Scopes: practitioner.list

Request

GET /v1/Practices/{practiceId}/Practitioners

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123

Responses

Status Code	Type	Description
200	PractitionerModel[]	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Get Practitioner by Id

Returns a specific practitioner by its Id.

Required Scopes: practitioner.get

Request

GET /v1/Practices/{practiceId}/Practitioners/{id}

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
id	path	string (uuid)	True	The Id of the practitioner to find. e.g. 66C12476-83FF-4329-886C-15AB6FC83BEA

Responses

Status Code	Type	Description
200	PractitionerModel	Success
400	string	Bad Request
404	string	Not Found
500	string	Server Error
502	string	Server Error
504	string	Server Error

Products

Reports

List Allocations

Get a list of allocations for a given practice, filtered by a date range.

Note

This API is only supported on Exact versions 24.36 and above.

Required Scopes: allocation.list

Request

GET /v1/Practices/{practiceId}/Allocations?from&to[&continuationToken]

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
from	query	string (date-time)	True	The start of the time range to list allocations for.
to	query	string (date-time)	True	The end of the time range to list allocations for.
continuationToken	query	string		The continuation token used to fetch the next page of results.

Responses

Status Code	Type	Description
200	AllocationModel[]	Success
400	string	Bad Request
500	string	Server Error
502	string	Server Error
504	string	Server Error

List Transactions

Get a list of transactions for a given practice, filtered by a date range.

Note

This API is only supported on Exact versions 24.36 and above.

Required Scopes: transaction.list

Request

GET /v1/Practices/{practiceId}/Transactions?from&to[&continuationToken]

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
from	query	string (date-time)	True	The start of the time range to list transactions for
to	query	string (date-time)	True	The end of the time range to list transactions for
continuationToken	query	string		The continuation token used to fetch the next page of results

Responses

Status Code	Type	Description
200	TransactionModel[]	Success
400	string	Bad Request
500	string	Server Error
502	string	Server Error
504	string	Server Error

Subscriptions

List Active Subscriptions

Returns the list of practices that have signed up for your product in a single collection of strings that represents the alias used by almost all other operations.

Required Scopes: productsubscription.get

Request

GET /v1/Subscriptions/active

Responses

Status Code	Type	Description
200	array	Success

Transactions

Create Payment

Create a new payment for a given practice.

Required Scopes: transaction.payment.create

Request

POST /v1/Practices/{practiceId}/Transactions/Payments

Parameters

Name	In	Type	Required	Description
practiceId	path	string	True	The Id of the practice to query. e.g. UKABC123
body	body	PaymentTransactionCreateRequest		The request for creating payment transaction

Responses

Status Code	Type	Description
200	PaymentTransactionModel	Success
400	string	Bad Request
500	string	Server Error
502	string	Server Error
504	string	Server Error

Definitions

Appointment

Represents an appointment in the system.

Name	Type	Description	Sample
id	string (uuid)	The unique identifier of the appointment	726ee4a5-444f-42cc-ae19-cdc834448cee
providers	ProviderModel[]	The list of providers that the appointment is booked for.
patientId	string (uuid)	The identifier of the patient this appointment is for	726ee4a5-444f-42cc-ae19-cdc834448cee
payorId	string (uuid)	The identifier of the payor for this appointment	726ee4a5-444f-42cc-ae19-cdc834448cee
location	string (uuid)	The identifier of the location of this appointment	726ee4a5-444f-42cc-ae19-cdc834448cee
primaryFamilyAppointmentId	string (uuid)	The identifier of the primary appointment for a family appointment, or null if this is not a family appointment
nextFamilyAppointmentId	string (uuid)	The identifier of the next appointment in order for a family appointment, or null if this is not a family appointment
familyAppointmentIds	array	A collection of all the appointment identifiers in a family appointment, or empty if this is not the primary family appointment
chairDurationMinutes	integer (int32)	The length of time the patient was in the chair for in minutes, or null if the Hso.ExactApi.Contracts.Appointment.Status is not Hso.ExactApi.Contracts.AppointmentStatus.Complete	90
scheduledDurationMinutes	integer (int32)	The total length of the scheduled appointment in minutes	90
actualDurationMinutes	integer (int32)	The total length of the actual appointment in minutes	90
startDate	string (date-time)	The date and time which this appointment is scheduled to begin	2021-07-20T13:15:00.0000000+12:00
endDate	string (date-time)	The date and time which this appointment is scheduled to end	2021-07-20T13:15:00.0000000+12:00
isFirstVisit	boolean	Specifies if this is the first appointment for a new patient at this practice
arrivalDate	string (date-time)	The date and time the patient was marked as arrived for this appointment, or null if the patient has not yet arrived	2021-07-20T13:15:00.0000000+12:00
completionDate	string (date-time)	The date and time this appointment was marked as complete, or null if it has not been completed 2021-07-20T13:15:00+12:00
cancellationDate	string (date-time)	The date and time this appointment was marked as cancelled, or null if it has not been cancelled	2021-07-20T13:15:00.0000000+12:00
status	AppointmentStatus
createdByUserId	string (uuid)	The identifier of the user (staff) who created the appointment, or null if it was booked by the system such as with online booking	726ee4a5-444f-42cc-ae19-cdc834448cee
createdDate	string (date-time)	The date and time of when the appointment was created	2021-07-20T13:15:00.0000000+12:00
lastUpdatedByUserId	string (uuid)	The identifier of the user (staff) who last made a change to this appointment, or null if it had not been changed since creation	726ee4a5-444f-42cc-ae19-cdc834448cee
lastUpdatedDate	string (date-time)	The date and time of the last edit to this appointment, or null if it had not been changed since creation	2021-07-20T13:15:00.0000000+12:00

Provider

The list of providers that the appointment is booked for.

Name	Type	Description	Sample
id	string (uuid)	The unique identifier of this provider
type	ProviderType
name	string	The name of this provider e.g. George, Throckmorton, etc.

ProviderType

Enum Values

Dentist
Hygienist

AppointmentStatus

Enum Values

Unset
Pending
Confirmed
Arrived
InSurgery
Completed
Cancelled
DidNotAttend

UpdateAppointment

The request to update an appointment

Name	Type	Description	Sample
appointmentId	string (uuid)	The id of the appointment to update
startDate	string (date-time)	The start date of the appointment
duration	integer (int32)	The duration of the appointment in minutes
practitionerId	string (uuid)	The practitioner id to assign to the appointment
patientId	string (uuid)	The id of the patient to assign to the appointment
service	string	The service to be performed during the appointment
reasonId	string	The reason for the appointment. This should map to an existing Booking Reason in the system, otherwise the value will be ignored. If a Hso.ExactApi.Models.UpdateAppointmentModel.Service is informed, this field will be ignored.
status	AppointmentStatus
notes	string	Notes specific to the appointment
forceUpdate	boolean	Forces the appointment to be updated even if there's a double booking error

CreateAppointment

Name	Type	Description	Sample
startDate	string (date-time)	The start date of the appointment
duration	integer (int32)	The duration of the appointment in minutes
practitionerId	string (uuid)	The practitioner id to assign to the appointment
patientId	string (uuid)	The id of the patient to assign to the appointment
service	string	The service to be performed during the appointment
reasonId	string	The reason for the appointment. This should map to an existing Booking Reason in the system, otherwise the value will be ignored. If a Hso.ExactApi.Models.CreateAppointmentModel.Service is informed, this field will be ignored.
notes	string	Notes specific to the appointment
forceCreate	boolean	Forces the appointment to be created even if there's a double booking error

Patient

Name	Type	Description	Sample
id	string (uuid)	The globally unique identifier of the patient CF7DBBC6-F284-4732-BC01-94C4240395AD
payingPatientId	string (uuid)	Exact does not have the concept of 'Accounts', but does have the concept of another patient paying for services. If the patient pays for their own treatment then this will match Hso.ExactApi.Contracts.Patient.IdCF7DBBC6-F284-4732-BC01-94C4240395AD
isActive	boolean	True if the patient is active, false if they are any other status (read-only, deceased, deactivated) true
dateOfBirth	string (date-time)	The ISO-8601 date that the patient was born. This does not contain time information, only the date 2021-07-20T00:00:00+12:00 or 2021-07-19T00:00:00Z
defaultDentistId	string (uuid)	The identifier of the patient's default dentist CF7DBBC6-F284-4732-BC01-94C4240395AD
defaultHygienistId	string (uuid)	The identifier of the patient's default hygienist CF7DBBC6-F284-4732-BC01-94C4240395AD
title	string	The title that the patient has provided Mr
preferredName	string	The name that the patient would prefer to be called Jazz
firstName	string	First Name John
middleName	string	Middle Name Arthur
lastName	string	Last Name Smith
sex	Sex
marketingConsent	Consent
healthServiceIdentifier	string	The health service number for this patient, this will be the NHS number in England, Wales and the Isle of Man, and the CHI in Scotland https://en.wikipedia.org/wiki/NHS_number https://en.wikipedia.org/wiki/National_Health_Service_Central_Register_(Scotland) 311 456 8765
nationalInsuranceIdentifier	string	The patient’s national insurance number (NI in the UK)
defaultPayor	PayorType
patientHasAddress	boolean	A value indicating whether the patient record includes address information.
patientHasEmail	boolean	A value indicating whether the patient record includes email contact information.
patientHasSMS	boolean	A value indicating whether the patient has an SMS capable number and has opted in for SMS communications.

Sex

Enum Values

Unspecified
Male
Female
Other

Consent

Enum Values

NotAsked
Consented
Refused

PayorType

Enum Values

Private
AnyOtherPayor
HealthDept
Gmhba
Ctt
Acc
NhsEngland
Inami
HealthDeptSdb
NhsScotland
Midland
MidlandEssentialDental
SouthernEssentialDental
NorthernCapPlans
SouthernEssentialDental2
PfsEhh
PdsGeneric
ShelloitBrunei
PdsSeftonV5
NorthHealthAdult
SadsEds
SadsGds
PdsCornwall
Prsi
Gms
CapitationPlan
NhsIsleOfMan
PdsStHelens
PdsLeasowe
PdsRockferry
PdsSefton
NhsNorthernIreland
PdsWolverhampton
PdsBromley
PdsGloucestershire
PdsWorcestershire
PdsNorthampton
PdsShropshire
PdsSouthernDerbyshire
PdsWiltshire
PdsPeterborough
NhsWales
PdsKirkby
PdsCustom
HealthDeptAohs
Denplan
PrsiLow
PrsiHigh
Ohsa
Sds
OhsExCirc
MedicareEasyclaim
HicapsWorkSafe

UpdatePatient

Name	Type	Description	Sample
patientId	string (uuid)	The patient Id
firstName	string	First name
middleName	string	Second name
lastName	string	Last name
sex	Sex
dateOfBirth	string (date-time)	Date of birth
defaultDentistId	string (uuid)	The identifier of the patient's default dentist CF7DBBC6-F284-4732-BC01-94C4240395AD
defaultHygienistId	string (uuid)	The identifier of the patient's default hygienist CF7DBBC6-F284-4732-BC01-94C4240395AD
defaultPayorId	string (uuid)	The identifier of the payor that the patient usually uses to pay for treatment
patientContactInfo	PatientContactInfo[]

PatientContactInfo

Name	Type	Description	Sample
physicalAddress	PhysicalAddress[]
emailAddresses	array
homePhone	string
homePhoneCountry	string
workPhone	string
workPhoneCountry	string
mobilePhone	string
mobilePhoneCountry	string

PhysicalAddress

Name	Type	Description	Sample
line1	string
line2	string
line3	string
line4	string
postCode	string

CreatePatient

Name	Type	Description	Sample
firstName	string	First name
middleName	string	Second name
lastName	string	Last name
sex	Sex
dateOfBirth	string (date-time)	Date of birth
defaultDentistId	string (uuid)	The identifier of the patient's default dentist CF7DBBC6-F284-4732-BC01-94C4240395AD
defaultHygienistId	string (uuid)	The identifier of the patient's default hygienist CF7DBBC6-F284-4732-BC01-94C4240395AD
defaultPayorId	string (uuid)	The identifier of the payor that the patient usually uses to pay for treatment
patientContactInfo	PatientContactInfo[]

PatientContactRequest

Name	Type	Description	Sample
type	PatientMessageType
subject	string	The subject of the message to send.
body	string	The body of the message to send.
scheduled	string (date-time)	The date and time to send the message.
priority	boolean	Whether to override current send schedules and send immediately. NOTE: Not currently implemented.

PatientMessageType

Enum Values

Sms
Email

PatientContactInfo

Name	Type	Description	Sample
emailAddresses	array	All the email addresses of the patient that are enabled for outbound communications. [john.smith@gmail.com, john.smith@outlook.com]
phoneNumbers	PhoneNumberModel[]	The Patient's collection of contact phone numbers.

PhoneNumber

The Patient's collection of contact phone numbers.

Name	Type	Description	Sample
countryCode	string	The country code of the phone number. 1 OR 64 OR 44
phoneNumber	string	The phone number. 2072343456 OR 92523365
phoneType	PhoneNumberType

PhoneNumberType

Enum Values

Home
Work
Mobile

Payor

Name	Type	Description	Sample
id	string (uuid)	The id of the record for this payor CF7DBBC6-F284-4732-BC01-94C4240395AD
payorType	PayorType
name	string	The name of the payor NHS
displayName	string	The human-friendly name of the payor National Health Service
isActive	boolean	True if this payor is active in the practice and can be used true

Practice

Name	Type	Description	Sample
practiceId	string	The id of the practice UK1234>
practiceName	string	The formal name of the practice The Dental Practice
installationId	string	An identifier of the installation which this practice runs upon Note: this may change and should not be used to address the practice when communicating CF7DBBC6-F284-4732-BC01-94C4240395AD
organizationId	string (uuid)	The id of the parent organization of this practice CF7DBBC6-F284-4732-BC01-94C4240395AD
organizationName	string	The name of the parent organization of this practice BUPA
phoneNumber	string	A telephone number which patients may call to contact the practice, in E.164 format +447911123456
emailAddress	string	An email address which patients may use to contact the practice thedentalpractice@gmail.com
websiteAddress	string	A web address hosting information about the practice https://www.thedentalpractice.com
country	string	The ISO-3166-a3 country code in which the practice operates GBR
countrySubdivision	string	The ISO-3166-2 subdivision code in which the practice operates (if available) SCT
brandingLogoUrl	string	A URL which links to the logo for the practice - a generic placeholder will be served if none is set by the practice https://www.imgur.com/fghgfh.jpg
supportedPayors	array	Payors which are active on the practice
openingHours	object	The hours in which the practice is open for customers, with the day name as the key
practiceTimezoneUtcOffsetMinutes	integer (int32)	The time zone offset of the practice, in minutes 720
pmsVersion	string	Machine-readable version of the practice management software which is installed at the site 13.493.3.430.1
pmsDisplayVersion	string	Human readable version of the practice management software which is installed at the site 13.493 [PF 1]
updatedOn	string (date-time)	When the information in this record was last updated from the site - this does not indicate if the data has actually changed, just freshness 2021-07-20T00:00:00+12:00
locations	PracticeLocationModel[]	A collection of additional locations the practice operates at.

Address

Name	Type	Description	Sample
line1	string	The first address line, usually house number and road 123 Lane ln
line2	string	The second address line, usually suburb Jambo Bay
line3	string	The third address line, usually city / town Auckland
line4	string	The fourth address line New Zealand
postCode	string	Postcode of the address 90210

PracticeLocation

A collection of additional locations the practice operates at.

Name	Type	Description	Sample
id	string (uuid)	The location Id
code	string	The location code
name	string	The name of the location
phone	string	The location's phone number
fax	string	The location's fax number
line1	string	The location's first address line
line2	string	The location's second address line
line3	string	The location's third address line
postCode	string	The location's post code

Practitioner

Name	Type	Description	Sample
id	string (uuid)	The ID of the practitioner record F1D6922F-B2DC-44A3-A08E-5DC079202C51
role	string	The role of this practitioner in the practice Hygienist
userName	string	The short code of the practitioner RGP
name	string	The display name of the practitioner Either the practitioner's name or code
isActive	boolean	True if the practitioner is active true

CreateProduct

Name	Type	Description	Sample
partnerName	string	The name of the Partner.
productName	string	The name of the Product.
apiClientId	string (uuid)	The Client Id requesting the operation.

Product

Name	Type	Description	Sample
id	string (uuid)
name	string
partnerName	string
apiClientId	string
createdOn	string (date-time)
updatedOn	string (date-time)

ProblemDetails

Name	Type	Description	Sample
type	string
title	string
status	integer (int32)
detail	string
instance	string

UpdateProduct

Name	Type	Description	Sample
partnerName	string	The name of the Partner.
productName	string	The name of the Product.
apiClientId	string (uuid)	The Client Id requesting the operation.

Allocation

Name	Type	Description	Sample
id	string (uuid)	The unique identifier for this allocation.
referenceNumber	string	The reference number for the allocation.
date	string (date-time)	The date that this allocation took effect
totalAmount	number (double)	The total amount allocated
from	TransactionModel
to	TransactionModel

Transaction

Name	Type	Description	Sample
id	string (uuid)	The unique identifier for this transaction.
referenceNumber	string	The reference number for the transaction. Its source vary depending on the transaction type.
type	TransactionType	The transaction types
location	PracticeLocationModel
totalAmount	number (double)	The total amount including GST/VAT if applicable.
taxAmount	number (double)	The GST/VAT for this transaction.
date	string (date-time)	The date that this transaction took place.
practitioner	PractitionerModel
responsiblePayorType	TransactionPayorType	The payor type related to a transaction, i.e. who is responsible for paying this transaction
payingPatient	PatientModel
payingPayor	PayorModel
treatedPatient	PatientModel
subType	TransactionSubType	Represents the many types of adjustments that can be made to a transaction.
paymentMethod	PaymentMethodModel	Represents the many payment methods that can be used to pay for a transaction.
paymentReference	string	The reference code for the payment
paymentAccountNumber	string	The bank account number for this payment. Present only for Payment transaction type.
paymentGLAccountNumber	string	The GL Account Number for the payment. Present only for Payment transaction type.
adjustmentTargetTransaction

TransactionType

The transaction types

Enum Values

Adjustment
Invoice
Payment
InvoiceAdjustment
PaymentAdjustment

TransactionPayorType

The payor type related to a transaction, i.e. who is responsible for paying this transaction

Enum Values

Patient
Payor

TransactionSubType

Represents the many types of adjustments that can be made to a transaction.

Enum Values

Stock
Instalment
OpeningBalance
Discount
Resubmission
WriteOff
PaymentTransferIn
PaymentTransferOut
InvoiceTransferIn
InvoiceTransferOut

PaymentMethod

Represents the many payment methods that can be used to pay for a transaction.

Name	Type	Description	Sample
code	string	The short code of the payment method
paymentType	PaymentType	The payment types that can be associated to a payment method.
paymentProviderName	string	The payment provider name, when the payment method is specific to a provider
isActive	boolean	True if this payment method is active, otherwise false

PaymentType

The payment types that can be associated to a payment method.

Enum Values

Cash
Cheque
CreditCard
InsuranceCheck
Other
Giro
DirectDebit
BankTransfer
DebitCard
IntegratedCard
NextFree

ProductSubscription

Name	Type	Description	Sample
id	string (uuid)
productId	string (uuid)
productName	string
practiceId	string
startDate	string (date-time)
endDate	string (date-time)

CreateSubscription

Name	Type	Description	Sample
productId	string (uuid)
practiceId	string
startDate	string (date-time)
endDate	string (date-time)

EndSubscription

Name	Type	Description	Sample
endDate	string (date-time)

PaymentTransactionCreateRequest

Name	Type	Description	Sample
patientId	string (uuid)
practitionerId	string (uuid)
date	string (date-time)
totalAmount	number (double)
paymentMethod	string
comment	string
user	string

PaymentTransaction

Name	Type	Description	Sample
id	string (uuid)	The unique identifier for this transaction.
referenceNumber	string	The reference number for the transaction.
totalAmount	number (double)	The total amount including GST/VAT if applicable.
date	string (date-time)	The date that this transaction took place. Only today's date or a future date is allowed. If a past date is provided, it will be automatically set to today's date.
paymentReference	string	The reference code for the payment. REF123, DEBIT
paymentAccountNumber	string	The bank account number for this payment.
paymentGLAccountNumber	string	The GL Account Number for the payment.