About this integration
Allied health practice management platform for scheduling, clinical notes, billing, and NDIS support. Use it from the workflow canvas with no custom glue script required.
This integration exposes 17 triggers, 36 search modules and 11 actions as workflow nodes. Authentication uses basic authentication.
How to connect
The credential form asks for Base API URL and API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Base API URLRequired | select | Select the API URL to use for your region. |
API KeyRequired | password | Contact Splose Support to enable API access, then retrieve your API key from My Account → API Keys |
Use it in workflow automation
Start with Watch Appointments, then add Create a Contact.
The canvas below runs Watch Appointments into Create a Contact — watch the video, then drop a node onto the canvas.
Select the Watch Patient Forms trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Patient as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 28 ready-made modules for support work — each run logs its inputs and outputs for debugging.
Splose workflow on the canvas: Watch Patient Forms then Create a Patient
Triggers, searches and actions
Use the tables below to inspect Splose's 17 triggers, 36 search modules, and 11 actions.
Triggers
17 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Appointments
- Watch Busy Times
- Watch Busy Time Types
- Watch Cases
- Watch Contacts
Searches
Fetch data on demand using 36 search modules that query the app during a run.
- Get a Busy Time
- Get a Busy Time Type
- Get a Case
- Get a Contact
- Get a Credit Note
Actions
11 action modules cover the full range of create, update, and delete operations.
- Create a Contact
- Create an Appointment
- Create a Patient
- Create a Patient File
- Create a Payment
Explore the fields available for each Splose trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Service ID | number |
Location ID | number |
Practitioner ID | number |
Max patients | number |
Appointment patients | array |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Total | number |
Tax type | text |
Support item ids | array |
Note | text |
Deleted at | date |
Is unavailable block | boolean |
Busy time practitioner ids | array |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Location ID | number |
Practitioner ids | array |
Repeat ID | text |
Recurring rule | text |
Note | text |
Deleted at | date |
Busy time type ID | number |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Title | text |
Color | text |
Duration | number |
Note | text |
Deleted at | date |
Is utilisation included | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Contact ID | number |
Issue date | date |
Expiry date | date |
Hours | number |
Practitioner ID | number |
Items | array |
Organisation ID | number |
Patient ID | number |
Case number | text |
Budget | number |
Appointment count | number |
Provider number | text |
Referral period | text |
Notes | text |
Track type | text |
Include did not arrive | boolean |
Include cancelled | boolean |
Is open | boolean |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Title | text |
First name | text |
Last name | text |
Preferred name | text |
Occupation | text |
Company name | text |
Provider number | text |
Doctor type | text |
Associated patient ids | array |
Associated invoice ids | array |
Associated case ids | array |
Email | |
Address l1 | text |
Address l2 | text |
Address l3 | text |
Suburb | text |
| Field | Type |
|---|---|
ID | number |
Custom num | text |
Invoice ID | number |
Patient ID | number |
Subtotal | number |
Tax | number |
Total | number |
Credit note items | array |
Description | text |
Deleted at | date |
Sent status | text |
Credit allocations | array |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Invoice number | text |
Issue date | date |
Due date | date |
Patient ID | number |
Contact ID | number |
Location ID | number |
Practitioner ID | number |
Extra billing info | text |
Subtotal | number |
Tax status | text |
Tax | number |
Total | number |
Paid amount | number |
Status | text |
Invoice items | array |
Payment ids | array |
Reference numbers | array |
Reference | text |
| Field | Type |
|---|---|
ID | number |
Title | text |
Abn | text |
Address | text |
Postal code | text |
Suburb | text |
State | text |
Country | text |
Phone | text |
Email | text |
Timezone | text |
Associated service ids | array |
Deleted at | date |
Online booking | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Submitted at | text |
Patient ID | number |
Organisation ID | number |
Appointment ID | number |
Template ID | number |
Title | text |
UUID | text |
Branding color | text |
Header image | text |
Content | text |
Submitted message | text |
Status | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Firstname | text |
Lastname | text |
ID | number |
Deleted at | date |
Middle name | text |
Preferred name | text |
Title | text |
Email | |
Sex | text |
Gender identity | text |
Pronouns | text |
Alert | text |
Invoice recipient ID | number |
Birthdate | date |
Timezone | text |
Extra info | text |
Extra billing info | text |
Address l1 | text |
Address l2 | text |
| Field | Type |
|---|---|
ID | number |
Payment number | text |
Amount | number |
Patient ID | number |
Location ID | number |
Payment method ID | number |
Payment date | date |
Payment invoices | array |
Credit allocations | array |
Xero ID | text |
Archived at | date |
Archived | boolean |
| Field | Type |
|---|---|
ID | number |
Firstname | text |
Lastname | text |
Email | |
Title | text |
Profession | text |
Description | text |
Role name | text |
Connections | array |
Provider numbers | array |
Deleted at | date |
Is active | boolean |
Online booking | boolean |
Timezone | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Patient ID | number |
Form ID | number |
Screener tags | array |
Triaging | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
For | text |
Name | text |
Description | text |
Type | text |
Code | text |
Duration | number |
Unit | text |
Pricing | number |
Tax type | text |
Provider travel item code | text |
Provider travel pricing | number |
Provider travel non labour costs item code | text |
Provider travel non labour costs pricing | number |
Service tags | array |
Deleted at | date |
Allow provider travel | boolean |
Allow provider travel non labour costs | boolean |
Archived | boolean |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Patient ID | number |
Practitioner ID | number |
Service ID | number |
Location ID | number |
Case ID | number |
Note | text |
Item code | number |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Quantity | number |
Tax type | text |
Invoice ID | number |
Deleted at | date |
Do not invoice | boolean |
| Field | Type |
|---|---|
ID | number |
Appointment ID | number |
Type | text |
Item code | number |
Pricing | number |
To minutes | number |
Return minutes | number |
Appointment address | text |
Unit | text |
Quantity | text |
Note | text |
Deleted at | date |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ID | number |
Practitioner ID | number |
User group ID | number |
Location ID | number |
Patient ID | number |
Service ids | array |
Waitlist tags | array |
Preferred days | array |
Preferred time | array |
Archived | boolean |
Created at | date |
Updated at | date |
Searches
| Field | Type |
|---|---|
Busy-time IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Location ID | number |
Practitioner ids | array |
Repeat ID | text |
Recurring rule | text |
Note | text |
Deleted at | date |
Busy time type ID | number |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Busy Time Type IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Title | text |
Color | text |
Duration | number |
Note | text |
Deleted at | date |
Is utilisation included | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Case IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Contact ID | number |
Issue date | date |
Expiry date | date |
Hours | number |
Practitioner ID | number |
Items | array |
Organisation ID | number |
Patient ID | number |
Case number | text |
Budget | number |
Appointment count | number |
Provider number | text |
Referral period | text |
Notes | text |
Track type | text |
Include did not arrive | boolean |
Include cancelled | boolean |
Is open | boolean |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Title | text |
First name | text |
Last name | text |
Preferred name | text |
Occupation | text |
Company name | text |
Provider number | text |
Doctor type | text |
Associated patient ids | array |
Associated invoice ids | array |
Associated case ids | array |
Email | |
Address l1 | text |
Address l2 | text |
Address l3 | text |
Suburb | text |
| Field | Type |
|---|---|
Credit Note IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Custom num | text |
Invoice ID | number |
Patient ID | number |
Subtotal | number |
Tax | number |
Total | number |
Credit note items | array |
Description | text |
Deleted at | date |
Sent status | text |
Credit allocations | array |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Location IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
For | text |
Name | text |
Description | text |
Type | text |
Code | text |
Duration | number |
Unit | text |
Pricing | number |
Tax type | text |
Provider travel item code | text |
Provider travel pricing | number |
Provider travel non labour costs item code | text |
Provider travel non labour costs pricing | number |
Service tags | array |
Deleted at | date |
Allow provider travel | boolean |
Allow provider travel non labour costs | boolean |
Archived | boolean |
| Field | Type |
|---|---|
Appointment IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Service ID | number |
Location ID | number |
Practitioner ID | number |
Max patients | number |
Appointment patients | array |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Total | number |
Tax type | text |
Support item ids | array |
Note | text |
Deleted at | date |
Is unavailable block | boolean |
Busy time practitioner ids | array |
| Field | Type |
|---|---|
Busy Time Type IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Invoice number | text |
Issue date | date |
Due date | date |
Patient ID | number |
Contact ID | number |
Location ID | number |
Practitioner ID | number |
Extra billing info | text |
Subtotal | number |
Tax status | text |
Tax | number |
Total | number |
Paid amount | number |
Status | text |
Invoice items | array |
Payment ids | array |
Reference numbers | array |
Reference | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Firstname | text |
Lastname | text |
ID | number |
Deleted at | date |
Middle name | text |
Preferred name | text |
Title | text |
Email | |
Sex | text |
Gender identity | text |
Pronouns | text |
Alert | text |
Invoice recipient ID | number |
Birthdate | date |
Timezone | text |
Extra info | text |
Extra billing info | text |
Address l1 | text |
Address l2 | text |
| Field | Type |
|---|---|
Patient Form IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Submitted at | text |
Patient ID | number |
Organisation ID | number |
Appointment ID | number |
Template ID | number |
Title | text |
UUID | text |
Branding color | text |
Header image | text |
Content | text |
Submitted message | text |
Status | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Payment IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Payment number | text |
Amount | number |
Patient ID | number |
Location ID | number |
Payment method ID | number |
Payment date | date |
Payment invoices | array |
Credit allocations | array |
Xero ID | text |
Archived at | date |
Archived | boolean |
| Field | Type |
|---|---|
Practitioner IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Firstname | text |
Lastname | text |
Email | |
Title | text |
Profession | text |
Description | text |
Role name | text |
Connections | array |
Provider numbers | array |
Deleted at | date |
Is active | boolean |
Online booking | boolean |
Timezone | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Screener IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Patient ID | number |
Form ID | number |
Screener tags | array |
Triaging | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
For | text |
Name | text |
Description | text |
Type | text |
Code | text |
Duration | number |
Unit | text |
Pricing | number |
Tax type | text |
Provider travel item code | text |
Provider travel pricing | number |
Provider travel non labour costs item code | text |
Provider travel non labour costs pricing | number |
Service tags | array |
Deleted at | date |
Allow provider travel | boolean |
Allow provider travel non labour costs | boolean |
Archived | boolean |
| Field | Type |
|---|---|
Support Activity IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Location ID | number |
Practitioner ids | array |
Repeat ID | text |
Recurring rule | text |
Note | text |
Deleted at | date |
Busy time type ID | number |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Support Time IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Appointment ID | number |
Type | text |
Item code | number |
Pricing | number |
To minutes | number |
Return minutes | number |
Appointment address | text |
Unit | text |
Quantity | text |
Note | text |
Deleted at | date |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Waitlist IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Practitioner ID | number |
User group ID | number |
Location ID | number |
Patient ID | number |
Service ids | array |
Waitlist tags | array |
Preferred days | array |
Preferred time | array |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Start After Date | date |
Start Before Date | date |
Patient ID | choice |
Patient Status | choice |
Status Update After Date | date |
Status Update Before Date | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Service ID | number |
Location ID | number |
Practitioner ID | number |
Max patients | number |
Appointment patients | array |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Total | number |
Tax type | text |
Support item ids | array |
Note | text |
Deleted at | date |
Is unavailable block | boolean |
Busy time practitioner ids | array |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Start After Date | date |
Start Before Date | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Location ID | number |
Practitioner ids | array |
Repeat ID | text |
Recurring rule | text |
Note | text |
Deleted at | date |
Busy time type ID | number |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Title | text |
Is Utilisation Included | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Title | text |
Color | text |
Duration | number |
Note | text |
Deleted at | date |
Is utilisation included | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Updated After | text |
Updated Before | text |
Patient ID | choice |
Practitioner ID | choice |
Contact ID | choice |
Track Type | choice |
Status | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Contact ID | number |
Issue date | date |
Expiry date | date |
Hours | number |
Practitioner ID | number |
Items | array |
Organisation ID | number |
Patient ID | number |
Case number | text |
Budget | number |
Appointment count | number |
Provider number | text |
Referral period | text |
Notes | text |
Track type | text |
Include did not arrive | boolean |
Include cancelled | boolean |
Is open | boolean |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
First Name | text |
Last Name | text |
Email | |
Phone Number | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Title | text |
First name | text |
Last name | text |
Preferred name | text |
Occupation | text |
Company name | text |
Provider number | text |
Doctor type | text |
Associated patient ids | array |
Associated invoice ids | array |
Associated case ids | array |
Email | |
Address l1 | text |
Address l2 | text |
Address l3 | text |
Suburb | text |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Patient ID | choice |
Invoice ID | choice |
Practitioner ID | choice |
Sent Status | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Custom num | text |
Invoice ID | number |
Patient ID | number |
Subtotal | number |
Tax | number |
Total | number |
Credit note items | array |
Description | text |
Deleted at | date |
Sent status | text |
Credit allocations | array |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Created at | date |
Updated at | date |
Deleted at | date |
Required | boolean |
Options | array |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Patient ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Invoice number | text |
Issue date | date |
Due date | date |
Patient ID | number |
Contact ID | number |
Location ID | number |
Practitioner ID | number |
Extra billing info | text |
Subtotal | number |
Tax status | text |
Tax | number |
Total | number |
Paid amount | number |
Status | text |
Invoice items | array |
Payment ids | array |
Reference numbers | array |
Reference | text |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Title | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Title | text |
Abn | text |
Address | text |
Postal code | text |
Suburb | text |
State | text |
Country | text |
Phone | text |
Email | text |
Timezone | text |
Associated service ids | array |
Deleted at | date |
Online booking | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Updated After | text |
Updated Before | text |
Include Archived | choice |
Patient IDRequired | choice |
Template IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Submitted at | text |
Patient ID | number |
Organisation ID | number |
Appointment ID | number |
Template ID | number |
Title | text |
UUID | text |
Branding color | text |
Header image | text |
Content | text |
Submitted message | text |
Status | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Updated After | text |
Updated Before | text |
Include Archived | choice |
First Name | text |
Last Name | text |
Email | |
Birth Date | text |
Phone Number | text |
Patient Tag | text |
Limit | number |
| Field | Type |
|---|---|
Firstname | text |
Lastname | text |
ID | number |
Deleted at | date |
Middle name | text |
Preferred name | text |
Title | text |
Email | |
Sex | text |
Gender identity | text |
Pronouns | text |
Alert | text |
Invoice recipient ID | number |
Birthdate | date |
Timezone | text |
Extra info | text |
Extra billing info | text |
Address l1 | text |
Address l2 | text |
| Field | Type |
|---|---|
Updated After | text |
Updated Before | text |
Patient ID | choice |
Location ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Payment number | text |
Amount | number |
Patient ID | number |
Location ID | number |
Payment method ID | number |
Payment date | date |
Payment invoices | array |
Credit allocations | array |
Xero ID | text |
Archived at | date |
Archived | boolean |
| Field | Type |
|---|---|
Practitioner IDRequired | choice |
Start Date | date |
End Date | date |
Location ID | choice |
Limit | number |
| Field | Type |
|---|---|
Date | date |
Location ID | number |
Start time | text |
End time | text |
Repeat interval | text |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Is Active | choice |
First Name | text |
Last Name | text |
Email | |
Role Name | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Firstname | text |
Lastname | text |
Email | |
Title | text |
Profession | text |
Description | text |
Role name | text |
Connections | array |
Provider numbers | array |
Deleted at | date |
Is active | boolean |
Online booking | boolean |
Timezone | text |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Updated After | date |
Updated Before | date |
Include Archived | choice |
Created After | date |
Created Before | date |
Is Accepted | choice |
Is Triaging | choice |
Form IDs | array |
Screener Tags | array |
Screener Tag | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Patient ID | number |
Form ID | number |
Screener tags | array |
Triaging | boolean |
Archived | boolean |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Update Greater Than | date |
Update Less Than | date |
Include Archived | choice |
Name | text |
Type | text |
Code | text |
Service Tag | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
For | text |
Name | text |
Description | text |
Type | text |
Code | text |
Duration | number |
Unit | text |
Pricing | number |
Tax type | text |
Provider travel item code | text |
Provider travel pricing | number |
Provider travel non labour costs item code | text |
Provider travel non labour costs pricing | number |
Service tags | array |
Deleted at | date |
Allow provider travel | boolean |
Allow provider travel non labour costs | boolean |
Archived | boolean |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Start Greater Than | date |
Start Less Than | date |
Patient ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Patient ID | number |
Practitioner ID | number |
Service ID | number |
Location ID | number |
Case ID | number |
Note | text |
Item code | number |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Quantity | number |
Tax type | text |
Invoice ID | number |
Deleted at | date |
Do not invoice | boolean |
| Field | Type |
|---|---|
Update Greater Than | text |
Update Less Than | text |
Include Archived | choice |
Appointment ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Appointment ID | number |
Type | text |
Item code | number |
Pricing | number |
To minutes | number |
Return minutes | number |
Appointment address | text |
Unit | text |
Quantity | text |
Note | text |
Deleted at | date |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Updated After | date |
Updated Before | date |
Include Archived | choice |
Practitioner ID | choice |
User Group ID | choice |
Location ID | choice |
Patient ID | choice |
Date Added After | date |
Date Added Before | date |
Is Active | choice |
Preferred Days | array |
Day | text |
Preferred Time | text |
Service IDs | choice |
Waitlist Tags | array |
Tag | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Practitioner ID | number |
User group ID | number |
Location ID | number |
Patient ID | number |
Service ids | array |
Waitlist tags | array |
Preferred days | array |
Preferred time | array |
Archived | boolean |
Created at | date |
Updated at | date |
Actions
| Field | Type |
|---|---|
Contact TypeRequired | text |
Contact NameRequired | text |
Contact EmailRequired | |
Phone Numbers | array |
Contact Title | text |
Contact First Name | text |
Contact Last Name | text |
Contact Preferred Name | text |
Contact Occupation | text |
Contact Company Name | text |
Contact Provider Number | text |
Contact Doctor Type | choice |
Contact Address Line 1 | text |
Contact Address Line 2 | text |
Contact Address Line 3 | text |
Contact City | text |
Contact State | text |
Contact Post Code | text |
Contact Country | text |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Title | text |
First name | text |
Last name | text |
Preferred name | text |
Occupation | text |
Company name | text |
Provider number | text |
Doctor type | text |
Associated patient ids | array |
Associated invoice ids | array |
Associated case ids | array |
Email | |
Address l1 | text |
Address l2 | text |
Address l3 | text |
Suburb | text |
| Field | Type |
|---|---|
StartRequired | date |
EndRequired | date |
Service IDRequired | choice |
Location IDRequired | choice |
Practitioner IDRequired | choice |
Patient IDRequired | choice |
Case ID | choice |
Note | text |
| Field | Type |
|---|---|
ID | number |
Start | date |
End | date |
Service ID | number |
Location ID | number |
Practitioner ID | number |
Max patients | number |
Appointment patients | array |
Repeat ID | text |
Recurring rule | text |
Unit | text |
Pricing | number |
Total | number |
Tax type | text |
Support item ids | array |
Note | text |
Deleted at | date |
Is unavailable block | boolean |
Busy time practitioner ids | array |
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
Communication PreferenceRequired | choice |
Invoice Recipient ID | choice |
Middle Name | text |
Preferred Name | text |
Title | text |
Email | |
Sex | text |
Gender Identity | text |
Pronouns | text |
Alert | text |
Birthdate | date |
Timezone | time |
Extra Info | text |
Extra Billing Info | text |
Address Line 1 | text |
Address Line 2 | text |
Address Line 3 | text |
| Field | Type |
|---|---|
Firstname | text |
Lastname | text |
ID | number |
Deleted at | date |
Middle name | text |
Preferred name | text |
Title | text |
Email | |
Sex | text |
Gender identity | text |
Pronouns | text |
Alert | text |
Invoice recipient ID | number |
Birthdate | date |
Timezone | text |
Extra info | text |
Extra billing info | text |
Address l1 | text |
Address l2 | text |
| Field | Type |
|---|---|
IDRequired | choice |
FileRequired | text |
File NameRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Patient ID | number |
| Field | Type |
|---|---|
Patient IDRequired | choice |
Location IDRequired | choice |
Payment Method IDRequired | choice |
AmountRequired | number |
Payment DateRequired | date |
Payment InvoicesRequired | array |
Xero Batch Payment ID | text |
| Field | Type |
|---|---|
ID | number |
Payment number | text |
Amount | number |
Patient ID | number |
Location ID | number |
Payment method ID | number |
Payment date | date |
Payment invoices | array |
Credit allocations | array |
Xero ID | text |
Archived at | date |
Archived | boolean |
| Field | Type |
|---|---|
Payment IDRequired | choice |
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Appointment IDRequired | choice |
Start | date |
End | date |
Service ID | choice |
Location ID | choice |
Practitioner ID | choice |
Patient ID | choice |
Case ID | choice |
Note | text |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
SexRequired | text |
Gender IdentityRequired | text |
AlertRequired | text |
BirthdateRequired | date |
CityRequired | text |
StateRequired | text |
Postal CodeRequired | text |
CountryRequired | text |
Phone NumbersRequired | array |
Privacy PolicyRequired | choice |
NDIS NumberRequired | text |
Medicare NumberRequired | text |
IRNRequired | text |
Veterans File NumberRequired | text |
Emergency Contact NumberRequired | text |
| Field | Type |
|---|---|
ID | number |
| Field | Type |
|---|---|
IDRequired | choice |
Custom Field DataRequired | array |
| Field | Type |
|---|---|
ID | number |
Name | text |
Patient ID | number |
| Field | Type |
|---|---|
Support Time IDRequired | choice |
Support Item TypeRequired | choice |
Minutes To Patient | number |
Minutes From Patient | number |
| Field | Type |
|---|---|
ID | number |
Appointment ID | number |
Type | text |
Item code | number |
Pricing | number |
To minutes | number |
Return minutes | number |
Appointment address | text |
Unit | text |
Quantity | text |
Note | text |
Deleted at | date |
Created at | date |
Updated at | date |

