AlayaCare Resi API Help Page

Introduction

Provide a general description of your APIs here.

Bed

API	Description
GET Groups/Bed	Get beds from criteria
GET Groups/Bed/Initialize	Get empty bed
GET Groups/Bed/{bedID}	Get bed
GET Groups/Bed/Export/{groupId}	Looks up facility specific beds for export
POST Groups/Bed?validateOnly={validateOnly}	Add bed
PUT Groups/Bed/{bedID}?validateOnly={validateOnly}	Update bed
DELETE Groups/Bed/{bedID}/{purge}	Delete bed

EventVirtualSession

Responsible for handling requests to create, update, and fetch EventVirtualSessions (see EventVirtualSessionDTO)

API	Description
GET Events/VirtualSession	Get EventVirtualSession from criteria
GET Events/VirtualSession/Initialize	Get empty eventVirtualSessions
GET Events/VirtualSession/{eventVirtualSessionID}	Get EventVirtualSession
POST Events/VirtualSession?validateOnly={validateOnly}	Add EventVirtualSession
PUT Events/VirtualSession/{eventVirtualSessionID}?validateOnly={validateOnly}	Update EventVirtualSession
DELETE Events/VirtualSession/{eventVirtualSessionID}/{purge}	Delete EventVirtualSession

CareStatement

API	Description
GET CareStatements/CareStatement/Initialize?ClientID={ClientID}	Get empty CareStatement
GET CareStatements/CareStatement/{careStatementID}	Get CareStatement
GET CareStatements/CareStatement	Get CareStatement from criteria
POST CareStatements/CareStatement?validateOnly={validateOnly}	Add CareStatement
PUT CareStatements/CareStatement/{careStatementID}/updateStatus?updatedStatus={updatedStatus}	Update Status of CareStatement from Held/Generated status to Held/Generated status
DELETE CareStatements/CareStatement/{careStatementID}/{purge}	Delete CareStatement
POST CareStatements/CareStatement/{careStatementID}/email	Send Care Statement email
GET CareStatements/CareStatement/{careStatementID}/pdf	Get Care Statement PDF
POST CareStatements/CareStatement/{careStatementID}/regenerate	Regenerate a CareStatement

NoteDetail

API	Description
GET Notes/Detail	Get noteDetails from criteria
GET Notes/Detail/Initialize?NoteID={NoteID}	Get empty noteDetail
GET Notes/Detail/{noteDetailID}	Get noteDetail
POST Notes/Detail?validateOnly={validateOnly}	Add noteDetail
PUT Notes/Detail/{noteDetailID}?validateOnly={validateOnly}	Update noteDetail
DELETE Notes/Detail/{noteDetailID}/{purge}	Delete noteDetail

Workflow

API	Description
GET Workflows/Workflow	Get Workflows
GET Workflows/Workflow/Initialize	Get empty Workflow
GET Workflows/Workflow/{workflowID}	Get Workflow
POST Workflows/Workflow?validateOnly={validateOnly}	Add Workflow
PUT Workflows/Workflow/{workflowID}?validateOnly={validateOnly}	Update Workflow
DELETE Workflows/Workflow/{workflowID}/{purge}	Delete Workflow

TransactionImport

API	Description
POST Transactions/Import/Parse?residentIDType={residentIDType}&funderID={funderID}&billingRateID={billingRateID}	Parses transaction from csv file. Read from mime multipart content
POST Transactions/Import	Imports transactions
GET Transactions/Import	Finds relevant bulk transactions information for filling out the Journal Details form

AttendanceType

API	Description
GET Setup/AttendanceType	Get attendanceTypes from criteria
GET Setup/AttendanceType/Initialize	Get empty attendanceType
GET Setup/AttendanceType/{attendanceTypeID}	Get attendanceType
POST Setup/AttendanceType	Add attendanceType
PUT Setup/AttendanceType/{attendanceTypeID}	Update attendanceType
DELETE Setup/AttendanceType/{attendanceTypeID}/{purge}	Delete attendanceType

DiagnosesTable

API	Description
GET Setup/DiagnosesTable	Get diagnosesTables from criteria
GET Setup/DiagnosesTable/Initialize?BUID={BUID}	Get empty diagnosesTable
GET Setup/DiagnosesTable/{diagnosesTableID}	Get diagnosesTable
POST Setup/DiagnosesTable?validateOnly={validateOnly}	Add diagnosesTable
PUT Setup/DiagnosesTable/{diagnosesTableID}?validateOnly={validateOnly}	Update diagnosesTable
DELETE Setup/DiagnosesTable/{diagnosesTableID}/{purge}	Delete diagnosesTable

UserSettingProps

API	Description
GET Users/SettingProps?name={name}	Get setting by settingName for current user
POST Users/SettingProps?name={name}	Add/update settings props for current user
DELETE Users/SettingProps?name={name}&purge={purge}	Delete setting for current user

StatementDetail

StatementDetails Controller

API	Description
GET Statements/StatementDetail	Get StatementDetail from criteria
GET Statements/StatementDetail/Initialize	Get empty StatementDetail
GET Statements/StatementDetail/{statementDetailID}	Get StatementDetail
POST Statements/StatementDetail?validateOnly={validateOnly}	Add StatementDetail
PUT Statements/StatementDetail/{statementDetailID}?validateOnly={validateOnly}	Update StatementDetail
DELETE Statements/StatementDetail/{statementDetailID}/{purge}	Delete StatementDetail

ClientParameter

API	Description
GET Clients/Parameter	Get entityFormFieldParameters from criteria
GET Clients/Parameter/Initialize?Type={Type}	Get empty entityFormFieldParameter
GET Clients/Parameter/{parameterID}	Get entityFormFieldParameter
POST Clients/Parameter?validateOnly={validateOnly}	Add entityFormFieldParameter
PUT Clients/Parameter/{parameterID}?validateOnly={validateOnly}	Update entityFormFieldParameter
DELETE Clients/Parameter/{parameterID}/{purge}	Delete entityFormFieldParameter

EntityEventTemplate

API	Description
GET Events/EntityTemplate	Get entityEventTemplates from criteria
GET Events/EntityTemplate/Initialize	Get empty entityEventTemplate
GET Events/EntityTemplate/InitializeEvents?EntityEventTemplateID={EntityEventTemplateID}	Get events to be generated based on entityEventTemplate
GET Events/EntityTemplate/{entityEventTemplateID}	Get entityEventTemplate
POST Events/EntityTemplate?validateOnly={validateOnly}	Add entityEventTemplate
PUT Events/EntityTemplate/{entityEventTemplateID}?validateOnly={validateOnly}	Update entityEventTemplate
DELETE Events/EntityTemplate/{entityEventTemplateID}/{purge}	Delete entityEventTemplate
PUT Events/EntityTemplate/DismissEntityEventTemplate/{entityEventTemplateID}	Dismiss Entity Event Template

ClientAllergySource

API	Description
GET Clients/AllergySource	Get clientAllergySources from criteria
GET Clients/AllergySource/Initialize?ClientAllergyID={ClientAllergyID}	Get empty clientAllergySource
GET Clients/AllergySource/{clientAllergyID}/{sourceEntryID}	Get clientAllergySource
POST Clients/AllergySource?validateOnly={validateOnly}	Add clientAllergySource
PUT Clients/AllergySource/{clientAllergyID}/{sourceEntryID}?validateOnly={validateOnly}	Update clientAllergySource
DELETE Clients/AllergySource/{clientAllergyID}/{sourceEntryID}/{purge}	Delete clientAllergySource

ContactCommunicationMethod

API	Description
GET Contacts/CommunicationMethod	Get contactCommunicationMethods from criteria
GET Contacts/CommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}	Get empty contactCommunicationMethod
GET Contacts/CommunicationMethod/{communicationMethodID}	Get contactCommunicationMethod
POST Contacts/CommunicationMethod?validateOnly={validateOnly}	Add contactCommunicationMethod
PUT Contacts/CommunicationMethod/{contactID}/{communicationMethodID}?validateOnly={validateOnly}	Update contactCommunicationMethod
DELETE Contacts/CommunicationMethod/{communicationMethodID}/{purge}	Delete contactCommunicationMethod

Logout

API	Description
POST Auth/Logout	Logout user session via Authentication-Token

SystemFile

API	Description
GET Setup/File	Get systemFiles from criteria
GET Setup/File/Initialize?FileTypeID={FileTypeID}	Get empty systemFile
GET Setup/File/{systemFileID}/{includePayload}	Get SystemFile
POST Setup/File?validateOnly={validateOnly}	Add SystemFile
POST Setup/File/Multipart?validateOnly={validateOnly}	Add SystemFile via multipart
PUT Setup/File/{systemFileID}/Multipart?validateOnly={validateOnly}	Add SystemFile via multipart
PUT Setup/File/{systemFileID}?validateOnly={validateOnly}	Update SystemFile
DELETE Setup/File/{systemFileID}/{purge}	Delete systemFile

WorkerGroup

API	Description
GET Workers/Group	Get workerGroups from criteria
GET Workers/Group/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty workerGroup
GET Workers/Group/{workerID}/{bUID}/{groupID}	Get workerGroup
POST Workers/Group?validateOnly={validateOnly}	Add workerGroup
PUT Workers/Group/{workerID}/{bUID}/{groupID}?validateOnly={validateOnly}	Update workerGroup
DELETE Workers/Group/{workerID}/{bUID}/{groupID}/{purge}	Delete workerGroup

CarePlanItemFileViaKey

API	Description
GET CarePlanItems/File/ViaKey/{key}/{resultAsBase64}	No documentation available.

FileType

API	Description
GET Setup/FileType	Get fileTypes from criteria
GET Setup/FileType/Initialize	Get empty fileType
GET Setup/FileType/{fileTypeID}	Get fileType
POST Setup/FileType?validateOnly={validateOnly}	Add fileType
PUT Setup/FileType/{fileTypeID}?validateOnly={validateOnly}	Update fileType
DELETE Setup/FileType/{fileTypeID}/{purge}	Delete fileType

ClientNotification

API	Description
GET Clients/Notification	Get clientNotifications from criteria
GET Clients/Notification/Initialize?BUID={BUID}	Get empty clientNotification
GET Clients/Notification/{clientID}/{type}	Get clientNotification
POST Clients/Notification?validateOnly={validateOnly}	Add clientNotification
PUT Clients/Notification/{clientID}/{type}?validateOnly={validateOnly}	Update clientNotification
DELETE Clients/Notification/{clientID}/{type}/{purge}	Delete clientNotification

Finance

API	Description
GET Finance/EBusinessEvents	Get EBusiness Event DTOs from criteria
GET Finance/EBusinessEvents/Initialize	Get empty serviceBusMessage
GET Finance/EBusinessEvents/{messageID}	Get serviceBusMessage
GET Finance/EBusinessEvents/{messageID}/EventPayload/{format}	Get service bus event payload
GET Finance/EBusinessEvents/{messageID}/DownloadEventBinary/{eventAttribute}	Download the binary file of eBusiness event stored in message bus
GET Finance/EBusinessEvents/{messageID}/DownloadEventAttribute/{eventAttribute}/{format}	Download the attribute of eBusiness event stored in message bus
PUT Finance/EBusinessEvents/Provision	Provision (Hydrate) a serviceBusMessage
PUT Finance/EBusinessEvents/{messageID}/Correct	Records a correction of a processed eBusiness message
PUT Finance/EBusinessEvents/{messageID}/Reverse	Records a reversal of a processed eBusiness message
PUT Finance/EBusinessEvents/{messageID}/Resubmit	Records a resubmission of an eBusiness message which is in Error state
PUT Finance/EBusinessEvents/{messageID}/AttachFile	Records an attachment upload action to an eBusiness message which is in Processed state
PUT Finance/EBusinessEvents/{messageID}/EventPayload	Updates payload of a provisioned eBusiness message
GET Finance/EBusinessEvents/EventAttributes/Initialize?eventType={eventType}	No documentation available.
POST Finance/EBusinessEvents	POST - Record an eBusiness event
POST Finance/EBusinessEvents/Enquiry	POST - Record an eBusiness enquiry
GET Finance/EBusinessEvents/EBusinessSetting	No documentation available.
PUT Finance/EBusinessEvents/States	Update state of a Service Bus Message
GET Finance/EBusinessEvents/ExpiryDate	No documentation available.
PUT Finance/EBusinessEvents/ActivateDevice	No documentation available.

Setup

API	Description
POST Setup/Rebuild	Update standard tables for current database (based on current user session)

WorkerBusinessUnitStatus

API	Description
GET Workers/BusinessUnitStatus	Get workerBusinessUnitStatuses from criteria
GET Workers/BusinessUnitStatus/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty workerBusinessUnitStatus
GET Workers/BusinessUnitStatus/{statusID}	Get workerBusinessUnitStatus
POST Workers/BusinessUnitStatus?validateOnly={validateOnly}	Add workerBusinessUnitStatus
PUT Workers/BusinessUnitStatus/{statusID}?validateOnly={validateOnly}	Update workerBusinessUnitStatus
DELETE Workers/BusinessUnitStatus/{statusID}/{purge}	Delete workerBusinessUnitStatus

ClientImage

API	Description
GET Clients/Image/Initialize?FileTypeID={FileTypeID}	Get empty clientImage
GET Clients/Image/{clientID}/{resultAsBase64}	Get current client image
POST Clients/Image?validateOnly={validateOnly}	Add client image
POST Clients/Image/Multipart?validateOnly={validateOnly}	Add client image via multipart

PaymentItem

PaymentItem Controller

API	Description
GET Payments/PaymentItem	Get PaymentItem from criteria
GET Payments/PaymentItem/{paymentItemID}	Get PaymentItem
GET Payments/PaymentItem/Initialize?PaymentMethod={PaymentMethod}	Get empty PaymentItem
POST Payments/PaymentItem?validateOnly={validateOnly}	Add PaymentItem
PUT Payments/PaymentItem/{paymentItemID}?validateOnly={validateOnly}	Update PaymentItem
DELETE Payments/PaymentItem/{paymentItemID}/{purge}	Delete PaymentItem

Service

API	Description
GET Setup/Service?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&IncludeError={IncludeError}&Match={Match}&ServiceCode={ServiceCode}&ServiceName={ServiceName}	Get Services from criteria
GET Setup/Service/Initialize?BUID={BUID}	Get empty Service
GET Setup/Service/Defaults?ServiceID={ServiceID}&ServiceName={ServiceName}	Get default Services
GET Setup/Service/{servicesID}	Get Service
POST Setup/Service?validateOnly={validateOnly}	Add Service
PUT Setup/Service/{serviceID}?validateOnly={validateOnly}	Update Service
DELETE Setup/Service/{servicesID}/{purge}	Delete Service

UserImage

API	Description
GET Users/Image/Initialize?FileTypeID={FileTypeID}	Get empty WorkerImage
GET Users/Image/{userID}	Get current User image
POST Users/Image?validateOnly={validateOnly}	Add User image
POST Users/Image/Multipart?validateOnly={validateOnly}	Add User image via multipart

Client

API	Description
GET Clients/Client	Get clients
GET Clients/Client/Initialize	Get empty client
GET Clients/Client/{clientID}/{partialDataType}	Get client
GET Clients/Client/FindBulkClients	No documentation available.
POST Clients/Client?validateOnly={validateOnly}	Add client
PUT Clients/Client/{clientID}?validateOnly={validateOnly}	Update client
DELETE Clients/Client/{clientID}/{purge}	Delete client
POST Clients/Client/{formID}/updateExtensions	Update form extension

ClientCarePlanEntryItem

API	Description
GET Clients/CarePlanEntryItem	Get clientCarePlanEntryItems from criteria
GET Clients/CarePlanEntryItem/Initialize?BUID={BUID}	Get empty clientCarePlanEntryItem
GET Clients/CarePlanEntryItem/{clientCarePlanEntryID}/{carePlanItemID}	Get clientCarePlanEntryItem
POST Clients/CarePlanEntryItem?validateOnly={validateOnly}	Add clientCarePlanEntryItem
PUT Clients/CarePlanEntryItem/{clientCarePlanEntryID}/{carePlanItemID}?validateOnly={validateOnly}	Update clientCarePlanEntryItem
DELETE Clients/CarePlanEntryItem/{clientCarePlanEntryID}/{carePlanItemID}/{purge}	Delete clientCarePlanEntryItem

ClinicalUpdates

API	Description
GET ClinicalUpdates/Overview	Get Overview from criteria
GET ClinicalUpdates/Overview/Contacts/Relationships	Get a list of Client Relationships that match the criteria.
GET ClinicalUpdates/Overview/Charts	Get a list of Chart entries that match the criteria.

ClientRelationship

API	Description
GET Clients/Relationship	Get clientRelationships from criteria
GET Clients/Relationship/Initialize	Get empty clientRelationship
GET Clients/Relationship/{clientRelationshipID}	Get clientRelationship
POST Clients/Relationship?validateOnly={validateOnly}	Add clientRelationship
PUT Clients/Relationship/{clientRelationshipID}?validateOnly={validateOnly}	Update clientRelationship
DELETE Clients/Relationship/{clientRelationshipID}/{purge}	Delete clientRelationship

CareStatementBatch

API	Description
POST CareStatements/CareStatementBatch?validateOnly={validateOnly}	Add CareStatementBatch
POST CareStatements/CareStatementBatch/Generate?validateOnly={validateOnly}	Generate CareStatementBatch
GET CareStatements/CareStatementBatch/Initialize	Get empty CareStatementBatch
GET CareStatements/CareStatementBatch/{careStatementBatchID}	Get CareStatementBatch
GET CareStatements/CareStatementBatch	Get CareStatementBatch from criteria
DELETE CareStatements/CareStatementBatch/{careStatementBatchID}/{purge}	Delete CareStatementBatch
POST CareStatements/CareStatementBatch/{careStatementBatchID}/MergePDF	Begins the process of merging all Care Statement PDF's for a given Batch into a single file.
GET CareStatements/CareStatementBatch/{careStatementBatchID}/MergePDF	Get the Merged Care Statement Batch PDF

UserSetting

API	Description
GET Users/Setting?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&Name={Name}	Get userSettings from criteria
GET Users/Setting/{settingID}	Get userSetting
POST Users/Setting?validateOnly={validateOnly}	Add userSetting
PUT Users/Setting/{settingID}?validateOnly={validateOnly}	Update userSetting
DELETE Users/Setting/{settingID}/{purge}	Delete userSetting
GET V2/Users/Setting?OrgID={OrgID}&IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&Name={Name}	Get userSettings from criteria
PUT V2/Users/Setting/{settingID}?validateOnly={validateOnly}	Update userSetting

ClientCommunicationMethod

API	Description
GET Clients/CommunicationMethod	Get clientCommunicationMethods from criteria
GET Clients/CommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}	Get empty clientCommunicationMethod
GET Clients/CommunicationMethod/{communicationMethodID}	Get clientCommunicationMethod
POST Clients/CommunicationMethod?validateOnly={validateOnly}	Add clientCommunicationMethod
PUT Clients/CommunicationMethod/{clientID}/{communicationMethodID}?validateOnly={validateOnly}	Update clientCommunicationMethod
DELETE Clients/CommunicationMethod/{communicationMethodID}/{purge}	Delete clientCommunicationMethod

User

API	Description
GET Users/User	Get users from criteria
GET Users/User/Initialize?BUID={BUID}&WorkerID={WorkerID}	Get empty user
GET Users/User/{userID}	Get user
POST Users/User?validateOnly={validateOnly}	Add user
PUT Users/User/{userID}?validateOnly={validateOnly}	Update user
PUT Users/User/ChangePassword	Change user's password
DELETE Users/User/{userID}/{purge}	Delete user
GET V2/Users/User	Get users from criteria
GET V2/Users/User/Initialize?BUID={BUID}&WorkerID={WorkerID}	Get empty user
GET V2/Users/User/{userID}	Get user
GET V2/Users/User/Minimal	Get users from criteria
POST V2/Users/User?validateOnly={validateOnly}	Add user
PUT V2/Users/User/{userID}?validateOnly={validateOnly}	Update a user
DELETE V2/Users/User/{userID}/{purge}	Delete user
POST V2/Users/User/Sync	Syncs logged user to Report system.

MasterOrg

API	Description
GET System/Organization	Get organizations from criteria

BillingMedicareEBusinessDetail

API	Description
GET Billings/MedicareEBusinessDetail	Get MedicareEBusinessDetails
GET Billings/MedicareEBusinessDetail/Initialize	Get empty MedicareEBusinessDetail
GET Billings/MedicareEBusinessDetail/{eventDetailID}	Get MedicareEBusinessDetail
POST Billings/MedicareEBusinessDetail?validateOnly={validateOnly}	Add MedicareEBusinessDetail
PUT Billings/MedicareEBusinessDetail/{eventDetailID}?validateOnly={validateOnly}	Update MedicareEBusinessDetail
DELETE Billings/MedicareEBusinessDetail/{eventDetailID}/{purge}	Delete MedicareEBusinessDetail

UserGroupBusinessUnit

API	Description
GET Users/GroupBusinessUnit	Get userGroupBusinessUnits from criteria
GET Users/GroupBusinessUnit/Initialize?BUID={BUID}	Get empty userGroupBusinessUnit
GET Users/GroupBusinessUnit/{userID}/{bUID}/{groupID}	Get userGroupBusinessUnit
POST Users/GroupBusinessUnit?validateOnly={validateOnly}	Add userGroupBusinessUnit
PUT Users/GroupBusinessUnit/{userID}/{bUID}/{groupID}?validateOnly={validateOnly}	Update userGroupBusinessUnit
DELETE Users/GroupBusinessUnit/{userID}/{bUID}/{groupID}/{purge}	Delete userGroupBusinessUnit
GET V2/Users/GroupBusinessUnits	Get userGroupBusinessUnits from criteria
GET V2/Users/GroupBusinessUnits/Initialize?BUID={BUID}	Initialize a UserGroupBusinessUnit based on criteria
PUT V2/Users/GroupBusinessUnits/{userID}/{orgID}/BulkUpdateUserGroupBusinessUnits	Bulk-update the UserGroupBusinessUnits associated with a user and a particular organization

GroupMaximum

API	Description
GET Groups/GroupMaximum	Get groupMaximums from criteria
GET Groups/GroupMaximum/Initialize?GroupID={GroupID}	Get empty groupMaximum
GET Groups/GroupMaximum/{groupMaximumID}	Get groupMaximum
POST Groups/GroupMaximum?validateOnly={validateOnly}	Add groupMaximum
PUT Groups/GroupMaximum/{groupMaximumID}?validateOnly={validateOnly}	Update groupMaximum
DELETE Groups/GroupMaximum/{groupMaximumID}/{purge}	Delete groupMaximum

AuthDatabase

API	Description
GET Users/AuthDatabase?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&LoginID={LoginID}&DBID={DBID}&LoginIdForAccess={LoginIdForAccess}	Get authDatabase from criteria
GET Users/AuthDatabase/Initialize?DBID={DBID}	Get empty authDatabase
GET Users/AuthDatabase/{userID}/{dbID}	Get authDatabase
POST Users/AuthDatabase?validateOnly={validateOnly}	Add authDatabase
PUT Users/AuthDatabase/{userID}/{dbID}?validateOnly={validateOnly}	Update authDatabase
DELETE Users/AuthDatabase/{userID}/{dbID}/{purge}	Delete authDatabase

FunderRule

API	Description
GET Setup/Funder/{FunderID}/Rules/Initialize	Get empty funder rule
GET Setup/Funder/{funderID}/Rules	No documentation available.
POST Setup/Funder/{funderID}/Rules	Creates a new FunderRule for the given Funder
PUT Setup/Funder/{funderID}/Rules/{funderRuleID}	Updates a FunderRule for the given Funder
PUT Setup/Funder/{funderID}/Rules/{funderRuleID}/Replace	Expires an existing FunderRule and replaces it with a new one
DELETE Setup/Funder/{funderID}/Rules/{funderRuleID}/{purge}	Deletes a FunderRule for the given Funder (after checking if a recent group rule exists)
GET Setup/Funder/{funderID}/Rules/Settings/Initialize	Initializes a FunderRuleSettingsDTO

AuthPrivilege

API	Description
GET Users/AuthPrivilege?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&Type={Type}&AccessType={AccessType}&PrivilegeName={PrivilegeName}&ParentPrivilegeID={ParentPrivilegeID}&AuthGroupID={AuthGroupID}&IncludeDependencies={IncludeDependencies}	Get authPrivileges from criteria
GET Users/AuthPrivilege/Initialize	Get empty authPrivilege
GET Users/AuthPrivilege/{privilegeID}	Get authPrivilege
POST Users/AuthPrivilege?validateOnly={validateOnly}	Add authPrivilege
PUT Users/AuthPrivilege/{privilegeID}?validateOnly={validateOnly}	Update authPrivilege
DELETE Users/AuthPrivilege/{privilegeID}/{purge}	Delete authPrivilege

Invoice

Invoice Controller

API	Description
GET Invoices/Invoice	Get Invoice from criteria
GET Invoices/Invoice/Initialize	Get empty invoices
GET Invoices/Invoice/{invoiceID}	Get Invoice
POST Invoices/Invoice?validateOnly={validateOnly}	Add Invoice
PUT Invoices/Invoice/{invoiceID}?validateOnly={validateOnly}	Update invoiceBatch
PUT Invoices/Invoice/v2/Finalize	Finalize Invoices using background worker
PUT Invoices/Invoice/SettlePayments	No documentation available.
GET Invoices/Invoice/SettlePaymentsMinPostingDate?clientID={clientID}&invoiceID={invoiceID}	Get min posting date for settle payments feature
GET Invoices/Invoice/SettleToInvoiceMinPostingDate?depositID={depositID}&invoiceIDs[0]={invoiceIDs[0]}&invoiceIDs[1]={invoiceIDs[1]}	Get min posting date for settle to invoice feature
POST Invoices/Invoice/{invoiceID}/PostTransactionToInvoice	No documentation available.
POST Invoices/Invoice/AllocateSettleAmount	Allocate settle amounts to an invoice
POST Invoices/Invoice/ApplyItemSettlements	Calculate settlement amounts on an invoice given invoice item settle amounts
POST Invoices/Invoice/WriteOff	Writes off invoice
DELETE Invoices/Invoice/{invoiceID}/{purge}	Delete Invoice

PaymentBusinessUnit

PaymentBusinessUnit Controller

API	Description
GET Payments/PaymentBusinessUnit	Get PaymentBusinessUnit from criteria
GET Payments/PaymentBusinessUnit/{paymentID}/{buid}	Get PaymentBusinessUnit
GET Payments/PaymentBusinessUnit/Initialize	Get empty PaymentBusinessUnit
POST Payments/PaymentBusinessUnit?validateOnly={validateOnly}	Add PaymentBusinessUnit
PUT Payments/PaymentBusinessUnit/{paymentID}/{buid}?validateOnly={validateOnly}	Update PaymentBusinessUnit
DELETE Payments/PaymentBusinessUnit/{paymentID}/{buid}/{purge}	Delete PaymentBusinessUnit

WorkerFile

API	Description
GET Workers/File	Get entityFiles from criteria
GET Workers/File/Initialize?FileTypeID={FileTypeID}	Get empty entityFile
GET Workers/File/{entityFileID}/{includePayload}	Get WorkerFile
POST Workers/File?validateOnly={validateOnly}	Add WorkerFile
PUT Workers/File/{entityFileID}?validateOnly={validateOnly}	Update WorkerFile
DELETE Workers/File/{entityFileID}/{purge}	Delete entityFile

ClientRelationshipDetail

API	Description
GET Clients/RelationshipDetail	Get clientRelationshipDetails from criteria
GET Clients/RelationshipDetail/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty clientRelationshipDetail
GET Clients/RelationshipDetail/{clientID}/{entityRelationshipID}	Get clientRelationshipDetail
POST Clients/RelationshipDetail?validateOnly={validateOnly}	Add clientRelationshipDetail
PUT Clients/RelationshipDetail/{clientID}/{entityRelationshipID}?validateOnly={validateOnly}	Update clientRelationshipDetail
DELETE Clients/RelationshipDetail/{clientID}/{entityRelationshipID}/{purge}	Delete clientRelationshipDetail

WorkerLanguage

API	Description
GET Workers/Language	Get workerLanguages from criteria
GET Workers/Language/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty workerLanguage
GET Workers/Language/{workerID}/{languageEntryID}	Get workerLanguage
POST Workers/Language?validateOnly={validateOnly}	Add workerLanguage
PUT Workers/Language/{workerID}/{languageEntryID}?validateOnly={validateOnly}	Update workerLanguage
DELETE Workers/Language/{workerID}/{languageEntryID}/{purge}	Delete workerLanguage

Contact

API	Description
GET Contacts/Contact	Get contacts
GET Contacts/Contact/Initialize?BUID={BUID}	Get empty contact
GET Contacts/Contact/{contactID}	Get contact
POST Contacts/Contact?validateOnly={validateOnly}	Add contact
PUT Contacts/Contact/{contactID}?validateOnly={validateOnly}	Update contact
DELETE Contacts/Contact/{contactID}/{purge}	Delete contact0
POST Contacts/Contact/{formID}/updateExtensions	Update form extension

EventRecurrence

API	Description
GET Events/Recurrence	Get eventRecurrences from criteria
GET Events/Recurrence/Initialize?BUID={BUID}&Type={Type}&StartDateUtc={StartDateUtc}&StopDateUtc={StopDateUtc}&RecurrenceDataEntryID={RecurrenceDataEntryID}&TZID={TZID}	Get empty eventRecurrence
GET Events/Recurrence/{eventRecurrenceID}	Get eventRecurrence
POST Events/Recurrence?validateOnly={validateOnly}	Add eventRecurrence
PUT Events/Recurrence/{eventRecurrenceID}?validateOnly={validateOnly}	Update eventRecurrence
DELETE Events/Recurrence/{eventRecurrenceID}/{purge}	Delete eventRecurrence
POST Events/Recurrence/Summary?AutoIncludeTimeZoneInfo={AutoIncludeTimeZoneInfo}&IncludeTimeZoneInfo={IncludeTimeZoneInfo}&SimpleDetail={SimpleDetail}&Immediate={Immediate}	Returns recalculated summary for event recurrence

ContactImage

API	Description
GET Contacts/Image/Initialize?FileTypeID={FileTypeID}	Get empty WorkerImage
GET Contacts/Image/{contactID}	Get current Contact image
POST Contacts/Image?validateOnly={validateOnly}	Add Contact image
POST Contacts/Image/Multipart?validateOnly={validateOnly}	Add Contact image via multipart

BillingUtils

API	Description
GET Billing/Utils/Subtypes	No documentation available.
GET Billing/Utils/InvoiceItemSubtypes	Invoice item subtypes are a subset of billing rate subtypes. Unfortunately their respective enums do not share the same values for the same type, so we create a convenience mapping here.

BillingRate

API	Description
GET Billing/BillingRate	Get billingRates from criteria
GET Billing/BillingRate/Initialize?Type={Type}&BillingRateTableID={BillingRateTableID}&BillingRateTableName={BillingRateTableName}	Get empty billingRate
GET Billing/BillingRate/{billingRateID}	Get billingRate
POST Billing/BillingRate?validateOnly={validateOnly}	Add billingRate
PUT Billing/BillingRate/{billingRateID}?validateOnly={validateOnly}	Update billingRate
PUT Billing/BillingRate/SetCurrentRateActive?validateOnly={validateOnly}	Updates a list of existing billing records to be non-active based on the current BillingRateSubType
PUT Billing/BillingRate/{billingRateID}/Replace?validateOnly={validateOnly}	Updates an existing billing record to be expired and adds a new billing rate using some field values form the existing record. The two records are linked by a common rootBillingRateID
PUT Billing/BillingRate/BulkReplace?validateOnly={validateOnly}	Updates a list of existing billing records to be expired and, for each expired record, adds a new billing rate using some field values form the existing record. The two records are linked by a common rootBillingRateID.
DELETE Billing/BillingRate/{billingRateID}/{purge}	Delete billingRate

RespiteExtension

API	Description
GET Billings/RespiteExtension?clientID={clientID}&buid={buid}	No documentation available.

CarePlan

API	Description
GET CarePlans/CarePlan	Get carePlans from criteria
GET CarePlans/CarePlan/Initialize?BUID={BUID}	Get empty carePlan
GET CarePlans/CarePlan/{carePlanID}?includePayload={includePayload}	Get carePlan
POST CarePlans/CarePlan?validateOnly={validateOnly}	Add carePlan
PUT CarePlans/CarePlan/{carePlanID}?validateOnly={validateOnly}	Update carePlan
DELETE CarePlans/CarePlan/{carePlanID}/{purge}	Delete carePlan

WorkerGroupStatus

API	Description
GET Workers/GroupStatus	Get workerGroupStatuses from criteria
GET Workers/GroupStatus/Initialize?BUID={BUID}&EntityID={EntityID}&GroupID={GroupID}	Get empty workerGroupStatus
GET Workers/GroupStatus/{statusID}	Get workerGroupStatus
POST Workers/GroupStatus?validateOnly={validateOnly}	Add workerGroupStatus
PUT Workers/GroupStatus/{statusID}?validateOnly={validateOnly}	Update workerGroupStatus
DELETE Workers/GroupStatus/{statusID}/{purge}	Delete workerGroupStatus

EmailMessage

API	Description
POST Setup/EmailMessage	Send EmailMessage

AuthPrivilegeDependency

API	Description
GET Users/AuthPrivilegeDependency	Get authPrivilegeDependencies from criteria
GET Users/AuthPrivilegeDependency/Group	No documentation available.
GET Users/AuthPrivilegeDependency/Initialize	Get empty authPrivilegeDependency
GET Users/AuthPrivilegeDependency/{privilegeID}?dependentID={dependentID}	Get authPrivilegeDependency
POST Users/AuthPrivilegeDependency?validateOnly={validateOnly}	Add authPrivilegeDependency
PUT Users/AuthPrivilegeDependency/{privilegeID}?validateOnly={validateOnly}	Update authPrivilegeDependency
DELETE Users/AuthPrivilegeDependency/{privilegeID}/{purge}?dependentID={dependentID}	Delete authPrivilegeDependency

ReconcilableItem

ReconcilableItem Controller

API	Description
GET Billings/ReconcilableItem	Get ReconcilableItem from criteria
GET Billings/ReconcilableItem/Initialize	Get empty reconcilableItems
GET Billings/ReconcilableItem/{reconcilableItemID}	Get ReconcilableItem
POST Billings/ReconcilableItem?validateOnly={validateOnly}	Add ReconcilableItem
PUT Billings/ReconcilableItem/{reconcilableItemID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Billings/ReconcilableItem/{reconcilableItemID}/{purge}	Delete ReconcilableItem
POST Billings/ReconcilableItem/CalculateDifference	Calculates ReconcilableItem difference and save the data
PUT Billings/ReconcilableItem/UpdateIsReconciled/{rootReconcilableItemID}/{isReconciled}	No documentation available.

Organization

API	Description
GET Setup/Organization/Initialize	Get empty organization
GET Setup/Organization	Get organization
POST Setup/Organization	Add organization
PUT Setup/Organization/{orgID}	Update organization

AgedCareOnlineClaimingMessage

API	Description
GET Setup/AgedCareOnlineClaimingMessage	Get AgedCareOnlineClaimingMessage from criteria
GET Setup/AgedCareOnlineClaimingMessage/Initialize	Get empty AgedCareOnlineClaimingMessage
GET Setup/AgedCareOnlineClaimingMessage/{messageID}	Get AgedCareOnlineClaimingMessage
POST Setup/AgedCareOnlineClaimingMessage?validateOnly={validateOnly}	Add AgedCareOnlineClaimingMessage

AttendanceTypeBusinessUnit

API	Description
GET Setup/AttendanceType/BusinessUnit	Get AttendanceTypeBusinessUnits from criteria
GET Setup/AttendanceType/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty AttendanceTypeBusinessUnit
GET Setup/AttendanceType/BusinessUnit/{attendanceTypeID}/{bUID}	Get AttendanceTypeBusinessUnit
POST Setup/AttendanceType/BusinessUnit	Add AttendanceTypeBusinessUnit
PUT Setup/AttendanceType/BusinessUnit/{attendanceTypeID}/{bUID}	Update AttendanceTypeBusinessUnit
DELETE Setup/AttendanceType/BusinessUnit/{attendanceTypeID}/{bUID}/{purge}	Delete AttendanceTypeBusinessUnit

FormImportExport

API	Description
GET Forms/Form/export	Get forms
GET Forms/Form/export/{formID}/{includeBusinessUnits}/{includeAuthGroups}	Get form
POST Forms/Form/import?validateOnly={validateOnly}	Add form

WorkflowRuleAction

API	Description
GET Workflows/RuleAction	Get WorkflowRuleActions from criteria
GET Workflows/RuleAction/Initialize	Get empty WorkflowRuleAction
GET Workflows/RuleAction/{workflowRuleActionID}	Get WorkflowRuleAction
POST Workflows/RuleAction?validateOnly={validateOnly}	Add WorkflowRuleAction
PUT Workflows/RuleAction/{workflowRuleActionID}?validateOnly={validateOnly}	Update WorkflowRuleAction
DELETE Workflows/RuleAction/{workflowRuleActionID}/{purge}	Delete WorkflowRuleAction
POST Workflows/RuleAction/UpdateSummary	get summary

ClientGroupStatus

API	Description
GET Clients/GroupStatus	Get clientGroupStatuses from criteria
GET Clients/GroupStatus/Initialize?BUID={BUID}&EntityID={EntityID}&GroupID={GroupID}	Get empty clientGroupStatus
GET Clients/GroupStatus/{statusID}	Get clientGroupStatus
GET Clients/GroupStatus/GetStatusChanges	Get statuses that will be changed
POST Clients/GroupStatus?validateOnly={validateOnly}	Add clientGroupStatus
PUT Clients/GroupStatus/{statusID}?validateOnly={validateOnly}	Update clientGroupStatus
PUT Clients/GroupStatus/{statusID}/Move/{bedID}/{statusReason}	Move client to different bed
POST Clients/GroupStatus/BedMove	Move client to different bed based If effective date is not provided, current date will be used If selected bed is occupied then the client will swap beds
DELETE Clients/GroupStatus/{statusID}/{purge}	Delete clientGroupStatus

CarePlanItemImage

API	Description
GET CarePlans/CarePlanItemImage	Get carePlanItemFiles from criteria
GET CarePlans/CarePlanItemImage/Initialize?FileTypeID={FileTypeID}	Get empty carePlanItemFile
GET CarePlans/CarePlanItemImage/{carePlanItemFileID}/{includePayload}	Get carePlanItemFile
POST CarePlans/CarePlanItemImage?validateOnly={validateOnly}	Add carePlanItemFile
POST CarePlans/CarePlanItemImage/Multipart?validateOnly={validateOnly}	Add carePlanItemFile file via multipart
PUT CarePlans/CarePlanItemImage/{carePlanItemFileID}?validateOnly={validateOnly}	Update carePlanItemFile
PUT CarePlans/CarePlanItemImage/{carePlanItemFileID}/Multipart?validateOnly={validateOnly}	Update CarePlanItemFile via multipart
DELETE CarePlans/CarePlanItemImage/{carePlanItemFileID}/{purge}	Delete carePlanItemFile

Notification

API	Description
GET Users/Notification	Get notifications from criteria

FormEntryAuditLog

API	Description
GET Forms/EntryAuditLog	Get formEntryAuditLogs from criteria
GET Forms/EntryAuditLog/Initialize	Get empty formEntryAuditLog
GET Forms/EntryAuditLog/{auditLogID}	Get formEntryAuditLog
POST Forms/EntryAuditLog?validateOnly={validateOnly}	Add formEntryAuditLog
PUT Forms/EntryAuditLog/{auditLogID}?validateOnly={validateOnly}	Update formEntryAuditLog
DELETE Forms/EntryAuditLog/{auditLogID}	Delete formEntryAuditLog

ClientCarePlanEntryItemNote

API	Description
GET Clients/CarePlanEntryItemNote	Get clientCarePlanEntryItemNotes from criteria
GET Clients/CarePlanEntryItemNote/Initialize?BUID={BUID}	Get empty clientCarePlanEntryItemNote
GET Clients/CarePlanEntryItemNote/{clientCarePlanEntryItemNoteID}	Get clientCarePlanEntryItemNote
POST Clients/CarePlanEntryItemNote?validateOnly={validateOnly}	Add clientCarePlanEntryItemNote
PUT Clients/CarePlanEntryItemNote/{clientCarePlanEntryItemNoteID}?validateOnly={validateOnly}	Update clientCarePlanEntryItemNote
DELETE Clients/CarePlanEntryItemNote/{clientCarePlanEntryItemNoteID}/{purge}	Delete clientCarePlanEntryItemNote

ClientLanguage

API	Description
GET Clients/Language	Get clientLanguages from criteria
GET Clients/Language/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty clientLanguage
GET Clients/Language/{clientID}/{languageEntryID}	Get clientLanguage
POST Clients/Language?validateOnly={validateOnly}	Add clientLanguage
PUT Clients/Language/{clientID}/{languageEntryID}?validateOnly={validateOnly}	Update clientLanguage
DELETE Clients/Language/{clientID}/{languageEntryID}/{purge}	Delete clientLanguage

EntityEvent

API	Description
GET Events/EntityEvent	Get entityEvent from criteria
GET Events/EntityEvent/Initialize	Get empty entityEvent
GET Events/EntityEvent/{entityID}/{eventID}	Get entityEvent
POST Events/EntityEvent?validateOnly={validateOnly}	Add entityEvent
PUT Events/EntityEvent/{entityID}/{eventID}?validateOnly={validateOnly}	Update entityEvent
DELETE Events/EntityEvent/{entityID}/{eventID}/{purge}	Delete entityEvent

BillingRateTax

API	Description
GET Billing/BillingRateTax	Get billingRateTaxs from criteria
GET Billing/BillingRateTax/Initialize	Get empty billingRateTax
GET Billing/BillingRateTax/{billingRateTaxID}	Get billingRateTax
POST Billing/BillingRateTax?validateOnly={validateOnly}	Add billingRateTax
PUT Billing/BillingRateTax/{billingRateTaxID}?validateOnly={validateOnly}	Update billingRateTax
DELETE Billing/BillingRateTax/{billingRateTaxID}/{purge}	Delete billingRateTax

ReportV2

Responsible for letting users run JReport reports.

API	Description
GET v2/reports/{reportID}/context?reportType={reportType}	Returns all necessary information to execute a JReport report via the JReport JSApi or Api.
GET v2/reports/setting	Get report settings

EventTemplateDetail

API	Description
GET Events/TemplateDetail	Get eventTemplateDetails from criteria
GET Events/TemplateDetail/Initialize?BUID={BUID}&EventTemplateID={EventTemplateID}	Get empty eventTemplateDetail
GET Events/TemplateDetail/{eventTemplateDetailID}	Get eventTemplateDetail
POST Events/TemplateDetail?validateOnly={validateOnly}	Add eventTemplateDetail
PUT Events/TemplateDetail/{eventTemplateDetailID}?validateOnly={validateOnly}	Update eventTemplateDetail
DELETE Events/TemplateDetail/{eventTemplateDetailID}/{purge}	Delete eventTemplateDetail

GroupRelationship

API	Description
GET Groups/Relationship	Get groupRelationships from criteria
GET Groups/Relationship/Initialize	Get empty groupRelationship
GET Groups/Relationship/{groupRelationshipID}	Get groupRelationship
POST Groups/Relationship?validateOnly={validateOnly}	Add groupRelationship
PUT Groups/Relationship/{groupRelationshipID}?validateOnly={validateOnly}	Update groupRelationship
DELETE Groups/Relationship/{groupRelationshipID}/{purge}	Delete groupRelationship

ClientSecondaryCarePlan

API	Description
GET Clients/SecondaryCarePlan	Get clientSecondaryCarePlans from criteria
GET Clients/SecondaryCarePlan/Initialize?BUID={BUID}	Get empty clientSecondaryCarePlan
GET Clients/SecondaryCarePlan/{clientCarePlanID}/{carePlanID}	Get clientSecondaryCarePlan
POST Clients/SecondaryCarePlan?validateOnly={validateOnly}	Add clientSecondaryCarePlan
PUT Clients/SecondaryCarePlan/{clientCarePlanID}/{carePlanID}?validateOnly={validateOnly}	Update clientSecondaryCarePlan
DELETE Clients/SecondaryCarePlan/{clientCarePlanID}/{carePlanID}/{purge}	Delete clientSecondaryCarePlan

Note

API	Description
GET Notes/Note	Get notes from criteria
GET Notes/Note/Initialize	Get empty note
GET Notes/Note/{noteID}	Get note
POST Notes/Note?validateOnly={validateOnly}	Add note
PUT Notes/Note/{noteID}?validateOnly={validateOnly}	Update note
DELETE Notes/Note/{noteID}/{purge}	Delete note

ServiceBusMessage

API	Description
GET Setup/ServiceBusMessage	Get serviceBusMessages from criteria
GET Setup/ServiceBusMessage/Initialize	Get empty serviceBusMessage
GET Setup/ServiceBusMessage/{messageID}?messageTarget={messageTarget}	Get serviceBusMessage
POST Setup/ServiceBusMessage?validateOnly={validateOnly}	Add serviceBusMessage
PUT Setup/ServiceBusMessage/{messageID}?validateOnly={validateOnly}	Update serviceBusMessage
DELETE Setup/ServiceBusMessage/{messageID}/{purge}	Delete serviceBusMessage

WorkerFileViaKey

API	Description
GET Workers/File/ViaKey/{key}?resultAsBase64={resultAsBase64}	No documentation available.

ABAFile

API	Description
GET ABAFiles/Payment/{paymentID}	No documentation available.
GET ABAFiles/Deposit/{depositID}	No documentation available.

OrganizationBankAccount

API	Description
GET Setup/Organization/BankAccount/Initialize	No documentation available.
GET Setup/Organization/BankAccount/{organizationBankAccountID}	No documentation available.
GET Setup/Organization/BankAccount	No documentation available.
POST Setup/Organization/BankAccount	No documentation available.
PUT Setup/Organization/BankAccount/{organizationBankAccountID}	No documentation available.
DELETE Setup/Organization/BankAccount/{organizationBankAccountID}/{purge}	No documentation available.

AuthGroup

API	Description
GET Users/AuthGroup?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&GroupName={GroupName}&ExceptAuthGroupID={ExceptAuthGroupID}&MaxRows={MaxRows}&CreatedDateUtcMin={CreatedDateUtcMin}&CreatedDateUtcMax={CreatedDateUtcMax}&LastUpdatedDateUtcMin={LastUpdatedDateUtcMin}&LastUpdatedDateUtcMax={LastUpdatedDateUtcMax}	Get authGroups from criteria
GET Users/AuthGroup/Initialize	Get empty authGroup
GET Users/AuthGroup/{authGroupID}	Get authGroup
POST Users/AuthGroup?validateOnly={validateOnly}	Add authGroup
PUT Users/AuthGroup/{authGroupID}?validateOnly={validateOnly}	Update authGroup
DELETE Users/AuthGroup/{authGroupID}/{purge}	Delete authGroup
GET V2/Users/AuthGroup?OrgID={OrgID}&IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&GroupName={GroupName}&ExceptAuthGroupID={ExceptAuthGroupID}&MaxRows={MaxRows}&CreatedDateUtcMin={CreatedDateUtcMin}&CreatedDateUtcMax={CreatedDateUtcMax}&LastUpdatedDateUtcMin={LastUpdatedDateUtcMin}&LastUpdatedDateUtcMax={LastUpdatedDateUtcMax}	Get authGroups from criteria

OrganizationalUnit

API	Description
GET Setup/OrganizationalUnit	Get organizationalUnits from criteria
GET Setup/OrganizationalUnit/Initialize	Get empty organizationalUnit
GET Setup/OrganizationalUnit/{oUID}	Get organizationalUnit
POST Setup/OrganizationalUnit?validateOnly={validateOnly}	Add organizationalUnit
PUT Setup/OrganizationalUnit/{oUID}?validateOnly={validateOnly}	Update organizationalUnit
DELETE Setup/OrganizationalUnit/{oUID}/{purge}	Delete organizationalUnit

ClientBusinessUnitStatus

API	Description
GET Clients/BusinessUnitStatus	Get clientBusinessUnitStatuses from criteria
GET Clients/BusinessUnitStatus/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty clientBusinessUnitStatus
GET Clients/BusinessUnitStatus/{statusID}	Get clientBusinessUnitStatus
POST Clients/BusinessUnitStatus?validateOnly={validateOnly}	Add clientBusinessUnitStatus
PUT Clients/BusinessUnitStatus/{statusID}?validateOnly={validateOnly}	Update clientBusinessUnitStatus
DELETE Clients/BusinessUnitStatus/{statusID}/{purge}	Delete clientBusinessUnitStatus

Group

API	Description
GET Groups/Group	Get groups
GET Groups/Group/Initialize?BUID={BUID}&ParentGroupID={ParentGroupID}&Type={Type}&SubType={SubType}&IncludeBinaries={IncludeBinaries}	Get empty group
GET Groups/Group/{groupID}	Get group
POST Groups/Group?validateOnly={validateOnly}	Add group
PUT Groups/Group/UpdateGroupLocation/{groupID}	Add group
PUT Groups/Group/{groupID}?validateOnly={validateOnly}	Update group
DELETE Groups/Group/{groupID}/{purge}	Delete group

ClientDiagnosis

API	Description
GET Clients/Diagnosis	Get clientDiagnosiss from criteria
GET Clients/Diagnosis/Initialize?BUID={BUID}&ClientID={ClientID}	Get empty clientDiagnosis
GET Clients/Diagnosis/{clientDiagnosisID}	Get clientDiagnosis
POST Clients/Diagnosis/InitializeNote	Get empty clientDiagnosis Note
POST Clients/Diagnosis?validateOnly={validateOnly}	Add clientDiagnosis
PUT Clients/Diagnosis/{clientDiagnosisID}?validateOnly={validateOnly}	Update clientDiagnosis
DELETE Clients/Diagnosis/{clientDiagnosisID}/{purge}	Delete clientDiagnosis

UserFileViaKey

API	Description
GET Users/File/ViaKey/{key}?resultAsBase64={resultAsBase64}	No documentation available.

DeferredManagementFeeExtension

DeferredManagementFeeExtension Controller

API	Description
GET Billings/DeferredManagementFeeExtension	Get DeferredManagementFeeExtension from criteria
GET Billings/DeferredManagementFeeExtension/Initialize	Get empty DeferredManagementFeeExtensions
GET Billings/DeferredManagementFeeExtension/{deferredManagementFeeExtensionID}	Get DeferredManagementFeeExtension
POST Billings/DeferredManagementFeeExtension?validateOnly={validateOnly}	Add DeferredManagementFeeExtensionDTO
POST Billings/DeferredManagementFeeExtension/GenerateDeferredManagementFees	Create new DMF record and related client order billing rates
PUT Billings/DeferredManagementFeeExtension/{deferredManagementFeeExtensionID}/{validateOnly}	Update deferredManagementFeeExtensions
GET Billings/DeferredManagementFeeExtension/MinimumResaleDate/{clientOrderID}	Get the minimum resale date for a client order
POST Billings/DeferredManagementFeeExtension/SettleCapitalGainLoss	No documentation available.
PUT Billings/DeferredManagementFeeExtension/Resale/{deferredManagementFeeExtensionID}	No documentation available.
DELETE Billings/DeferredManagementFeeExtension/{deferredManagementFeeExtensionID}/{purge}	Delete DeferredManagementFeeExtension

ViewModelWidget

API	Description
GET vm/widgets/{widgetIdentifier}	Get widget view model data

WorkflowRule

API	Description
GET Workflows/Rule	Get WorkflowRules from criteria
GET Workflows/Rule/Initialize	Get empty WorkflowRule
GET Workflows/Rule/{workflowRuleID}	Get WorkflowRule
POST Workflows/Rule?validateOnly={validateOnly}	Add WorkflowRule
PUT Workflows/Rule/{workflowRuleID}?validateOnly={validateOnly}	Update WorkflowRule
DELETE Workflows/Rule/{workflowRuleID}/{purge}	Delete WorkflowRule

EventTemplate

API	Description
GET Events/Template	Get eventTemplates from criteria
GET Events/Template/Initialize?BUID={BUID}	Get empty eventTemplate
GET Events/Template/{eventTemplateID}	Get eventTemplate
POST Events/Template?validateOnly={validateOnly}	Add eventTemplate
PUT Events/Template/{eventTemplateID}?validateOnly={validateOnly}	Update eventTemplate
DELETE Events/Template/{eventTemplateID}/{purge}	Delete eventTemplate

FormCategory

API	Description
GET Forms/Category	Get formCategories from criteria
GET Forms/Category/Initialize?FormClass={FormClass}	Get empty formCategory
GET Forms/Category/{formCategoryID}	Get formCategory
POST Forms/Category?validateOnly={validateOnly}	Add formCategory
PUT Forms/Category/{formCategoryID}?validateOnly={validateOnly}	Update formCategory
DELETE Forms/Category/{formCategoryID}/{purge}	Delete formCategory
GET Forms/Category/{formCategoryID}/used	Is form category used

Funder

API	Description
GET Setup/Funder	Get funders from criteria
GET Setup/Funder/Initialize	Get empty funder
GET Setup/Funder/{funderID}	Get funder
GET Setup/Funder/{funderID}/Addresses/Initialize	Initialize a new funder's address
GET Setup/Funder/{funderID}/Addresses	Get funder's addresses from criteria
POST Setup/Funder/{funderID}/Addresses	Add an address for funder
PUT Setup/Funder/{funderID}/Addresses/{addressID}	Updates a funder address
DELETE Setup/Funder/{funderID}/Addresses/{addressID}/{purge}	Deletes or Purges a Funder Address
GET Setup/Funder/{funderID}/CommunicationMethods/Initialize	Get funder's contact types (communication methods)
GET Setup/Funder/{funderID}/CommunicationMethods	Get funder's contact types (communication methods) from criteria
POST Setup/Funder/{funderID}/CommunicationMethods	Add a contact type (communication method) for funder
PUT Setup/Funder/{funderID}/CommunicationMethods/{communicationMethodID}	Updates a funder's contact details (communication method)
DELETE Setup/Funder/{funderID}/CommunicationMethods/{communicationMethodID}/{purge}	Deletes or Purges a Funder's Contact Details (Communication Method)
GET Setup/Funder/{funderID}/Contacts/{contactID}/Initialize	Initialize a new funder's contact
GET Setup/Funder/{funderID}/Contacts	Get contacts with relationships with a particular funder
POST Setup/Funder/{funderID}/Contacts	Add a contact relationships with a particular funder
PUT Setup/Funder/{funderID}/Contacts/{contactID}	Update a contact relationships with a particular funder
DELETE Setup/Funder/{funderID}/Contacts/{contactID}/{purge}	Deletes all contact relationships with a particular funder
GET Setup/Funder/{funderID}/ASOSupplies?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&CrossFilter={CrossFilter}	Get funder ASO Supplies
POST Setup/Funder?validateOnly={validateOnly}	Add funder
PUT Setup/Funder/{funderID}?validateOnly={validateOnly}	Update funder
PUT Setup/Funder/Generated/{funderID}	Finalize the events generation in funder and move to next period
DELETE Setup/Funder/{funderID}/{purge}	Delete funder

PaymentInstallment

Payment Controller

API	Description
GET Billings/PaymentInstallments	Get Payment Installment from criteria
GET Billings/PaymentInstallments/{paymentInstallmentID}	Get Payment Installment
GET Billings/PaymentInstallments/Initialize	Get empty Payment Installment
POST Billings/PaymentInstallments?validateOnly={validateOnly}	Add Payment Installment
PUT Billings/PaymentInstallments/{paymentInstallmentID}?validateOnly={validateOnly}	Update Payment Installment
PUT Billings/PaymentInstallments/UpdateOverrideAmount/{paymentInstallmentID}	No documentation available.
PUT Billings/PaymentInstallments/UpdateInstallmentPaidStatus/{paymentInstallmentID}/{isPaid}	No documentation available.
DELETE Billings/PaymentInstallments/{paymentInstallmentID}/{purge}	Delete Payment Installment
POST Billings/PaymentInstallments/ConvertInstallmentsToPaymentItems/endDate:DateTime?endDate={endDate}	No documentation available.

ClientAllergy

API	Description
GET Clients/Allergy	Get clientAllergies from criteria
GET Clients/Allergy/Initialize?BUID={BUID}&ClientID={ClientID}	Get empty clientAllergy
GET Clients/Allergy/{clientAllergyID}	Get clientAllergy
POST Clients/Allergy/InitializeNote	Get empty clientAllergy Note
POST Clients/Allergy?validateOnly={validateOnly}	Add clientAllergy
PUT Clients/Allergy/{clientAllergyID}?validateOnly={validateOnly}	Update clientAllergy
DELETE Clients/Allergy/{clientAllergyID}/{purge}	Delete clientAllergy

CodeTable

API	Description
GET Setup/CodeTable	Get codeTables from criteria
GET Setup/CodeTable/Initialize?BUID={BUID}	Get empty codeTable
GET Setup/CodeTable/{tableID}	Get codeTable
POST Setup/CodeTable?validateOnly={validateOnly}	Add codeTable
PUT Setup/CodeTable/{tableID}?validateOnly={validateOnly}	Update codeTable
DELETE Setup/CodeTable/{tableID}/{purge}	Delete codeTable

AuthGroupPrivilege

API	Description
GET Users/AuthGroupPrivilege	Get authGroupPrivileges from criteria
GET Users/AuthGroupPrivilege/Initialize	Get empty authGroupPrivilege
GET Users/AuthGroupPrivilege/{authGroupID}/{privilegeID}	Get authGroupPrivilege
POST Users/AuthGroupPrivilege?validateOnly={validateOnly}	Add authGroupPrivilege
PUT Users/AuthGroupPrivilege/bulk	No documentation available.
PUT Users/AuthGroupPrivilege/{authGroupID}/{privilegeID}?validateOnly={validateOnly}	Update authGroupPrivilege
DELETE Users/AuthGroupPrivilege/{authGroupID}/{privilegeID}/{purge}	Delete authGroupPrivilege

CarePlanImportExport

API	Description
GET CarePlans/CarePlan/export	Get forms
GET CarePlans/CarePlan/export/{carePlanID}	Get form
POST CarePlans/CarePlan/import?validateOnly={validateOnly}	Add CarePlan

BedGroup

API	Description
GET Groups/BedGroup	Get bedGroups from criteria
GET Groups/BedGroup/Initialize?BUID={BUID}&Type={Type}	Get empty bedGroup
GET Groups/BedGroup/{bedID}/{groupID}	Get bedGroup
GET Groups/BedGroup/{groupID}/Beds?BathroomsCount={BathroomsCount}&ExtraServices={ExtraServices}&BedStatus={BedStatus}&BedStatusStartDateUtc={BedStatusStartDateUtc}	Find all the beds under a bed group
POST Groups/BedGroup?validateOnly={validateOnly}	Add bedGroup
PUT Groups/BedGroup/{bedID}/{groupID}?validateOnly={validateOnly}	Update bedGroup
DELETE Groups/BedGroup/{bedID}/{groupID}/{purge}	Delete bedGroup

CarePlanResponseCode

API	Description
GET CarePlans/ResponseCode	Get carePlanResponseCodes from criteria
GET CarePlans/ResponseCode/Initialize?BUID={BUID}	Get empty carePlanResponseCode
GET CarePlans/ResponseCode/{carePlanResponseCodeID}	Get carePlanResponseCode
POST CarePlans/ResponseCode?validateOnly={validateOnly}	Add carePlanResponseCode
PUT CarePlans/ResponseCode/{carePlanResponseCodeID}?validateOnly={validateOnly}	Update carePlanResponseCode
DELETE CarePlans/ResponseCode/{carePlanResponseCodeID}/{purge}	Delete carePlanResponseCode

ClientOrder

API	Description
GET Clients/Order	Get Client Orders from criteria
GET Clients/Order/Initialize	Get empty clientOrder
GET Clients/Order/{clientOrderID}	Get clientOrder
POST Clients/Order?validateOnly={validateOnly}	Add clientOrder
PUT Clients/Order/{clientOrderID}?validateOnly={validateOnly}	Update clientOrder
DELETE Clients/Order/{clientOrderID}/{purge}	Delete clientOrder
PUT Clients/Order/UpdateClientOrders	No documentation available.
PUT Clients/Order/updateClientOrdersStartDate	No documentation available.
GET Clients/Order/{clientOrderId}/Addresses/Initialize	Initialize a new address for a client order
GET Clients/Order/{clientOrderId}/Addresses	Get addresses of a client order from criteria
POST Clients/Order/{clientOrderId}/Addresses	Add an address for client order
PUT Clients/Order/{clientOrderId}/Addresses/{addressId}	Updates an address of a client order
DELETE Clients/Order/{clientOrderId}/Addresses/{addressId}/{purge}	Deletes or Purges a Client Order Address
GET Clients/Order/GetPreEntryBillingDate?BUID={BUID}&StartDate={StartDate}	No documentation available.
GET Clients/Order/{clientOrderId}/ContactDetails/Initialize	Initialize a new contact details for a client order
GET Clients/Order/{clientOrderId}/ContactDetails	Get contact details of a client order from criteria
POST Clients/Order/{clientOrderId}/ContactDetails	Add contact details for a client order
PUT Clients/Order/{clientOrderId}/ContactDetails/{contactDetailsId}	Updates contact details of a client order
DELETE Clients/Order/{clientOrderId}/ContactDetails/{contactDetailsId}/{purge}	Deletes or Purges a Client Order Contact Details
GET Clients/Order/{clientOrderId}/Contacts/Initialize	Initialize a new contact for a client order
GET Clients/Order/{clientOrderId}/Contacts	Get contact of a client order from criteria
POST Clients/Order/{clientOrderId}/Contacts	Add contact for a client order
PUT Clients/Order/{clientOrderId}/Contacts/{contactId}	Updates contact of a client order
DELETE Clients/Order/{clientOrderId}/Contacts/{contactId}/{purge}	Deletes or Purges a Client Order Contact

Event

API	Description
GET Events/Event	Get events from criteria
GET Events/Event/Initialize?BUID={BUID}&PrimaryServiceReceiverEntityID={PrimaryServiceReceiverEntityID}&PrimaryServiceProviderEntityID={PrimaryServiceProviderEntityID}&PrimaryGroupEntityID={PrimaryGroupEntityID}&RoleID={RoleID}&EventShiftCodeID={EventShiftCodeID}&StartDateUtc={StartDateUtc}&StopDateUtc={StopDateUtc}&EventType={EventType}&EventSubType={EventSubType}&Subject={Subject}&DueDateUtc={DueDateUtc}&StartDateDays={StartDateDays}&StartTime={StartTime}&StopDateDays={StopDateDays}&StopTime={StopTime}&DueDateDays={DueDateDays}&DueTime={DueTime}&NotifyDateDays={NotifyDateDays}&NotifyTime={NotifyTime}&NotifyUserID={NotifyUserID}&IncludeClientBundles={IncludeClientBundles}&ActivityCategory={ActivityCategory}&ActivityType={ActivityType}	Get empty event
GET Events/Event/{eventID}?IncludeCurrentBedLocation={IncludeCurrentBedLocation}&IncludeCurrentAddressLocation={IncludeCurrentAddressLocation}&IncludeNextOccurrence={IncludeNextOccurrence}	Get event
GET Events/Event/summary	Get event summaries from criteria
GET Events/Event/summary/list	Get event summaries from criteria
POST Events/Event?validateOnly={validateOnly}	Add event
POST Events/Event/Generate?EventID={EventID}&GenerationDateUtcMin={GenerationDateUtcMin}&GenerationDateUtcMax={GenerationDateUtcMax}&SupressReturn={SupressReturn}	Generate events
POST Events/Event/Multiple?validateOnly={validateOnly}	Add events
PUT Events/Event/{eventID}?validateOnly={validateOnly}	Update event
PUT Events/Event/UpdateState/{eventID}/{newState}/{originalState}	Update Event Notify state
DELETE Events/Event/{eventID}/{purge}	Delete event
PUT Events/Event/Series/{eventID}?validateOnly={validateOnly}	Update event
GET Events/Event/IsCancelAllowed/{eventID}	No documentation available.
GET Events/Event/IsResetAllowed/{eventID}	No documentation available.
PUT Events/Event/DismissFutureEvents	Dismiss all future events using a sql script

WorkerAddress

API	Description
GET Workers/Address	Get workerAddresses from criteria
GET Workers/Address/Initialize	Get empty workerAddress
GET Workers/Address/{addressID}	Get workerAddress
POST Workers/Address?validateOnly={validateOnly}	Add workerAddress
PUT Workers/Address/{addressID}?validateOnly={validateOnly}	Update workerAddress
DELETE Workers/Address/{addressID}/{purge}	Delete workerAddress

TransactionTypes

API	Description
GET Setup/Billing/TransactionTypes	Gets a list of TransactionTypeDTOs
GET Setup/Billing/TransactionTypes/{transactionTypeID}	Gets a TransactionTypeDTO
PUT Setup/Billing/TransactionTypes/{transactionTypeID}	Updates a TransactionTypeDTO
DELETE Setup/Billing/TransactionTypes/{transactionTypeID}/{purge}	Deletes a TransactionType

ClientCarePlan

API	Description
GET Clients/CarePlan	Get clientCarePlans from criteria
GET Clients/CarePlan/Initialize?BUID={BUID}	Get empty clientCarePlan
GET Clients/CarePlan/Simple	Get SimpleClientCarePlans from criteria
GET Clients/CarePlan/{clientCarePlanID}?includePayload={includePayload}	Get clientCarePlan
POST Clients/CarePlan?validateOnly={validateOnly}	Add clientCarePlan
PUT Clients/CarePlan/{clientCarePlanID}?validateOnly={validateOnly}	Update clientCarePlan
DELETE Clients/CarePlan/{clientCarePlanID}/{purge}	Delete clientCarePlan

NoteBinaryViaKey

API	Description
GET Notes/Binary/ViaKey/{key}/{resultAsBase64}	No documentation available.

BusinessUnitSetting

API	Description
GET Setup/BusinessUnitSetting	Get businessUnitSettings from criteria
GET Setup/BusinessUnitSetting/Initialize	Get empty businessUnitSetting
GET Setup/BusinessUnitSetting/Defaults?BUID={BUID}&Type={Type}	Get default businessUnitSettings
GET Setup/BusinessUnitSetting/{settingID}	Get businessUnitSetting
POST Setup/BusinessUnitSetting?validateOnly={validateOnly}	Add businessUnitSetting
PUT Setup/BusinessUnitSetting/{settingID}?validateOnly={validateOnly}	Update businessUnitSetting
DELETE Setup/BusinessUnitSetting/{settingID}/{purge}	Delete businessUnitSetting
GET Setup/BusinessUnitSetting/{buID}/Export	No documentation available.
POST Setup/BusinessUnitSetting/{buID}/Import	No documentation available.

BillingRateReportingCode

API	Description
GET Billing/BillingRateReportingCode	Get billingRateReportingCodes from criteria
GET Billing/BillingRateReportingCode/Initialize?BillingRateID={BillingRateID}&BillingRateDescription={BillingRateDescription}&BillingRateCode={BillingRateCode}	Get empty billingRateReportingCode
GET Billing/BillingRateReportingCode/{billingRateReportingCodeID}	Get billingRateReportingCode
POST Billing/BillingRateReportingCode?validateOnly={validateOnly}	Add billingRateReportingCode
PUT Billing/BillingRateReportingCode/{billingRateReportingCodeID}?validateOnly={validateOnly}	Update billingRateReportingCode
DELETE Billing/BillingRateReportingCode/{billingRateReportingCodeID}/{purge}	Delete billingRateReportingCode

ClientMedication

API	Description
GET Clients/Medication	Get clientMedications from criteria
GET Clients/Medication/Initialize?MedicationCategory={MedicationCategory}&ClientID={ClientID}	Get empty clientMedication
GET Clients/Medication/{clientMedicationID}	Get clientMedication
POST Clients/Medication?validateOnly={validateOnly}	Add clientMedication
PUT Clients/Medication/{clientMedicationID}?validateOnly={validateOnly}	Update clientMedication
DELETE Clients/Medication/{clientMedicationID}/{purge}	Delete clientMedication

ClientFile

API	Description
GET Clients/File	Get entityFiles from criteria
GET Clients/File/Initialize?FileTypeID={FileTypeID}	Get empty entityFile
GET Clients/File/{entityFileID}/{includePayload}	Get clientFile
POST Clients/File?validateOnly={validateOnly}	Add clientFile
POST Clients/File/Multipart?validateOnly={validateOnly}	Add clientFile via multipart
PUT Clients/File/{entityFileID}/Multipart?validateOnly={validateOnly}	Add clientFile via multipart
PUT Clients/File/{entityFileID}?validateOnly={validateOnly}	Update clientFile
DELETE Clients/File/{entityFileID}/{purge}	Delete entityFile

ContactNotification

API	Description
GET Contacts/Notification	Get contactNotifications from criteria
GET Contacts/Notification/Initialize?BUID={BUID}	Get empty contactNotification
GET Contacts/Notification/{contactID}/{type}	Get contactNotification
POST Contacts/Notification?validateOnly={validateOnly}	Add contactNotification
PUT Contacts/Notification/{contactID}/{type}?validateOnly={validateOnly}	Update contactNotification
DELETE Contacts/Notification/{contactID}/{type}/{purge}	Delete contactNotification

EntityUserChange

API	Description
GET Users/EntityUserChange	Get EntityUserChange from criteria
GET Users/EntityUserChange/{entityUserChangeID}	Get EntityUserChange

FormFieldLinkDependency

API	Description
GET Forms/FieldLinkDependency	Get formFieldLinkDependencies from criteria
GET Forms/FieldLinkDependency/Initialize	Get empty formFieldLinkDependency
GET Forms/FieldLinkDependency/{formID}/{formFieldLinkID}/{parentFormFieldLinkID}	Get formFieldLinkDependency
POST Forms/FieldLinkDependency?validateOnly={validateOnly}	Add formFieldLinkDependency
PUT Forms/FieldLinkDependency/{formID}/{formFieldLinkID}/{parentFormFieldLinkID}?validateOnly={validateOnly}	Update formFieldLinkDependency
DELETE Forms/FieldLinkDependency/{formID}/{formFieldLinkID}/{parentFormFieldLinkID}/{purge}	Delete formFieldLinkDependency

ClientDiagnosisSource

API	Description
GET Clients/DiagnosisSource	Get clientDiagnosisSources from criteria
GET Clients/DiagnosisSource/Initialize?ClientDiagnosisID={ClientDiagnosisID}	Get empty clientDiagnosisSource
GET Clients/DiagnosisSource/{clientDiagnosisID}/{sourceEntryID}	Get clientDiagnosisSource
POST Clients/DiagnosisSource?validateOnly={validateOnly}	Add clientDiagnosisSource
PUT Clients/DiagnosisSource/{clientDiagnosisID}/{sourceEntryID}?validateOnly={validateOnly}	Update clientDiagnosisSource
DELETE Clients/DiagnosisSource/{clientDiagnosisID}/{sourceEntryID}/{purge}	Delete clientDiagnosisSource

UserPersistenceFilter

API	Description
GET Users/PersistenceFilter	Get UserPersistenceFilters from criteria
GET Users/PersistenceFilter/Initialize	Get empty UserPersistenceFilter
GET Users/PersistenceFilter/{userID}/{filter}	Get UserPersistenceFilter
POST Users/PersistenceFilter?validateOnly={validateOnly}	Add UserPersistenceFilter
PUT Users/PersistenceFilter/{userID}/{filter}?validateOnly={validateOnly}	Update UserPersistenceFilter
DELETE Users/PersistenceFilter/{userID}/{filter}/{purge}	Delete UserPersistenceFilter

ContactBusinessUnitStatus

API	Description
GET Contacts/BusinessUnitStatus	Get contactBusinessUnitStatuses from criteria
GET Contacts/BusinessUnitStatus/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty contactBusinessUnitStatus
GET Contacts/BusinessUnitStatus/{statusID}	Get contactBusinessUnitStatus
POST Contacts/BusinessUnitStatus?validateOnly={validateOnly}	Add contactBusinessUnitStatus
PUT Contacts/BusinessUnitStatus/{statusID}?validateOnly={validateOnly}	Update contactBusinessUnitStatus
DELETE Contacts/BusinessUnitStatus/{statusID}/{purge}	Delete contactBusinessUnitStatus

Task

API	Description
GET Events/Task	Get tasks from criteria
GET Events/Task/Initialize?BUID={BUID}&PrimaryServiceReceiverEntityID={PrimaryServiceReceiverEntityID}&PrimaryServiceProviderEntityID={PrimaryServiceProviderEntityID}&PrimaryGroupEntityID={PrimaryGroupEntityID}&EventSubType={EventSubType}&StartDateUtc={StartDateUtc}&StopDateUtc={StopDateUtc}&Subject={Subject}&DueDateUtc={DueDateUtc}&StartDateDays={StartDateDays}&StartTime={StartTime}&StopDateDays={StopDateDays}&StopTime={StopTime}&DueDateDays={DueDateDays}&DueTime={DueTime}&NotifyDateDays={NotifyDateDays}&NotifyTime={NotifyTime}	Get empty task
GET Events/Task/{taskID}	Get task
POST Events/Task?validateOnly={validateOnly}	Add task
POST Events/Task/Generate?EventID={EventID}&GenerationDateUtcMin={GenerationDateUtcMin}&GenerationDateUtcMax={GenerationDateUtcMax}&SupressReturn={SupressReturn}	Generate tasks
PUT Events/Task/{taskID}?validateOnly={validateOnly}	Update task
DELETE Events/Task/{taskID}/{purge}	Delete task

InvoiceBatchBusinessUnit

Invoice Batch Business Unit Controller

API	Description
GET Invoices/BatchBusinessUnit	Get InvoiceBatchBusinessUnit from criteria
GET Invoices/BatchBusinessUnit/Initialize	Get empty invoiceBatchBusinessUnits
GET Invoices/BatchBusinessUnit/{invoiceBatchBUID}	Get InvoiceBatchBusinessUnit
POST Invoices/BatchBusinessUnit?validateOnly={validateOnly}	Add InvoiceBatchBusinessUnit
PUT Invoices/BatchBusinessUnit/{invoiceBatchBUID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/BatchBusinessUnit/{invoiceBatchBUID}/{purge}	Delete InvoiceBatchBusinessUnit

InvoiceNote

Invoice Note Controller

API	Description
GET Invoices/Note	Get InvoiceNote from criteria
GET Invoices/Note/Initialize	Get empty invoiceNotes
GET Invoices/Note/{invoiceNoteID}	Get InvoiceNote
POST Invoices/Note?validateOnly={validateOnly}	Add InvoiceNote
PUT Invoices/Note/{invoiceNoteID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/Note/{invoiceNoteID}/{purge}	Delete InvoiceNote

CarePlanItem

API	Description
GET CarePlans/Item	Get carePlanItems from criteria
GET CarePlans/Item/Initialize?BUID={BUID}&CarePlanID={CarePlanID}&CarePlanItemCategoryID={CarePlanItemCategoryID}	Get empty carePlanItem
GET CarePlans/Item/{carePlanItemID}	Get carePlanItem
POST CarePlans/Item?validateOnly={validateOnly}	Add carePlanItem
PUT CarePlans/Item/{carePlanItemID}?validateOnly={validateOnly}	Update carePlanItem
DELETE CarePlans/Item/{carePlanItemID}/{purge}	Delete carePlanItem
POST CarePlans/Item/Upgrade/{carePlanItemLinkID}

UtilsInfo

API	Description
GET Utils/Info	Get version

TemporarySubsidyJournalItem

TemporarySubsidyJournalItem Controller

API	Description
GET Billings/TemporarySubsidyJournalItem	Get TemporarySubsidyJournalItem from criteria
GET Billings/TemporarySubsidyJournalItem/Initialize	Get empty temporarySubsidyJournalItems
GET Billings/TemporarySubsidyJournalItem/{temporarySubsidyJournalItemID}	Get TemporarySubsidyJournalItem
POST Billings/TemporarySubsidyJournalItem?validateOnly={validateOnly}	Add TemporarySubsidyJournalItem
POST Billings/TemporarySubsidyJournalItem/GenerateJournalItemsFromReconcilableItems/{subsidyReconciliationBatchID}	No documentation available.
POST Billings/TemporarySubsidyJournalItem/GenerateJournalItemsfromTempJournalItems	No documentation available.
PUT Billings/TemporarySubsidyJournalItem/{temporarySubsidyJournalItemID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Billings/TemporarySubsidyJournalItem/{temporarySubsidyJournalItemID}/{purge}	Delete TemporarySubsidyJournalItem

Diagnosis

API	Description
GET Setup/Diagnosis	Get diagnosiss from criteria
GET Setup/Diagnosis/Initialize?DiagnosesTableID={DiagnosesTableID}	Get empty diagnosis
GET Setup/Diagnosis/{diagnosisID}	Get diagnosis
POST Setup/Diagnosis?validateOnly={validateOnly}	Add diagnosis
PUT Setup/Diagnosis/{diagnosisID}?validateOnly={validateOnly}	Update diagnosis
DELETE Setup/Diagnosis/{diagnosisID}/{purge}	Delete diagnosis

ClientFileViaKey

API	Description
GET Clients/File/ViaKey/{key}/{resultAsBase64}	No documentation available.

AutomaticSettlements

Automatic Settlements Controller

API	Description
GET AutomaticSettlements/Residents	Finds relevant clients for automatic settlements
POST AutomaticSettlements/Process	Process automatic settlements

ClientAddress

API	Description
GET Clients/Address	Get clientAddresses from criteria
GET Clients/Address/Initialize	Get empty clientAddress
GET Clients/Address/{addressID}	Get clientAddress
POST Clients/Address?ValidateOnly={ValidateOnly}&BypassPeriodLogic={BypassPeriodLogic}	Add clientAddress
POST Clients/Address/bypassPeriodLogic?validateOnly={validateOnly}	Add clientAddress
PUT Clients/Address/{addressID}?ValidateOnly={ValidateOnly}&BypassPeriodLogic={BypassPeriodLogic}	Update clientAddress
PUT Clients/Address/bypassPeriodLogic/{addressID}?validateOnly={validateOnly}	Update clientAddress
DELETE Clients/Address/{addressID}/{purge}	Delete clientAddress

CodeTableEntry

API	Description
GET Setup/CodeTableEntry	Get codeTableEntries from criteria
GET Setup/CodeTableEntry/Initialize?BUID={BUID}&TableID={TableID}	Get empty codeTableEntry
GET Setup/CodeTableEntry/{entryID}	Get codeTableEntry
POST Setup/CodeTableEntry?validateOnly={validateOnly}	Add codeTableEntry
PUT Setup/CodeTableEntry/{entryID}?validateOnly={validateOnly}	Update codeTableEntry
DELETE Setup/CodeTableEntry/{entryID}/{purge}	Delete codeTableEntry

ContactGroup

API	Description
GET Contacts/Group	Get contactGroups from criteria
GET Contacts/Group/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty contactGroup
GET Contacts/Group/{contactID}/{bUID}/{groupID}	Get contactGroup
POST Contacts/Group?validateOnly={validateOnly}	Add contactGroup
PUT Contacts/Group/{contactID}/{bUID}/{groupID}?validateOnly={validateOnly}	Update contactGroup
DELETE Contacts/Group/{contactID}/{bUID}/{groupID}/{purge}	Delete contactGroup

FundingDaysBalance

API	Description
GET Billings/FundingDaysBalance?clientID={clientID}	Retrieve the funding days balance for a client who is currently absent
POST Billings/FundingDaysBalance	Retrieve the funding days balances for clients who are currently absent
GET Billings/FundingDaysBalance/hasFundingDayReductionBalanceRecord?clientID={clientID}&fundingReductionType={fundingReductionType}	Checks if the client has a Funding day balance based on client ID and year
GET Billings/FundingDaysBalance/hasRespiteFundingDayReductionBalanceRecord?clientID={clientID}	Checks if the client has a Respite Funding day balance record based on client ID for the current financial year

CarePlanResponseSubCode

API	Description
GET CarePlans/ResponseSubCode	Get carePlanResponseSubCodes from criteria
GET CarePlans/ResponseSubCode/Initialize?BUID={BUID}	Get empty carePlanResponseSubCode
GET CarePlans/ResponseSubCode/{carePlanResponseSubCodeID}	Get carePlanResponseSubCode
POST CarePlans/ResponseSubCode?validateOnly={validateOnly}	Add carePlanResponseSubCode
PUT CarePlans/ResponseSubCode/{carePlanResponseSubCodeID}?validateOnly={validateOnly}	Update carePlanResponseSubCode
DELETE CarePlans/ResponseSubCode/{carePlanResponseSubCodeID}/{purge}	Delete carePlanResponseSubCode

UserBusinessUnit

API	Description
GET Users/BusinessUnit?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&BUID={BUID}&MaxRows={MaxRows}	Get userBusinessUnits from criteria
GET Users/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty userBusinessUnit
GET Users/BusinessUnit/{userID}/{bUID}	Get userBusinessUnit
POST Users/BusinessUnit?validateOnly={validateOnly}	Add userBusinessUnit
PUT Users/BusinessUnit/{userID}/{bUID}?validateOnly={validateOnly}	Update userBusinessUnit
DELETE Users/BusinessUnit/{userID}/{bUID}/{purge}	Delete userBusinessUnit
GET V2/Users/BusinessUnit?OrgID={OrgID}&IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&BUID={BUID}&MaxRows={MaxRows}	Get userBusinessUnits from criteria
GET V2/Users/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty userBusinessUnit
POST V2/Users/BusinessUnit?validateOnly={validateOnly}	Add userBusinessUnit
PUT V2/Users/BusinessUnit/{userID}/{bUID}?validateOnly={validateOnly}	Update userBusinessUnit
DELETE V2/Users/BusinessUnit/{userID}/{bUID}/{orgID}/{purge}	Delete userBusinessUnit

WorkerImage

API	Description
GET Workers/Image/Initialize?FileTypeID={FileTypeID}	Get empty WorkerImage
GET Workers/Image/{workerID}	Get current Worker image
POST Workers/Image?validateOnly={validateOnly}	Add Worker image
POST Workers/Image/Multipart?validateOnly={validateOnly}	Add worker image via multipart

LocalizeViaKey

API	Description
GET Utils/Localize/ViaKey/{key}	No documentation available.

BillingRateTableBusinessUnit

API	Description
GET Billing/BillingRateTableBusinessUnit	Get billingRateTableBusinessUnits from criteria
GET Billing/BillingRateTableBusinessUnit/Initialize?BUID={BUID}&BusinessUnitName={BusinessUnitName}	Get empty billingRateTableBusinessUnit
GET Billing/BillingRateTableBusinessUnit/{billingRateTableBusinessUnitID}	Get billingRateTableBusinessUnit
POST Billing/BillingRateTableBusinessUnit?validateOnly={validateOnly}	Add billingRateTableBusinessUnit
PUT Billing/BillingRateTableBusinessUnit/{billingRateTableBusinessUnitID}?validateOnly={validateOnly}	Update billingRateTableBusinessUnit
DELETE Billing/BillingRateTableBusinessUnit/{billingRateTableBusinessUnitID}/{purge}	Delete billingRateTableBusinessUnit

WorkflowBusinessUnit

API	Description
GET Workflows/BusinessUnit	Get WorkflowBusinessUnits from criteria
GET Workflows/BusinessUnit/Initialize	Get empty WorkflowBusinessUnit
GET Workflows/BusinessUnit/{workflowID}/{bUID}	Get WorkflowBusinessUnit
POST Workflows/BusinessUnit?validateOnly={validateOnly}	Add WorkflowBusinessUnit
PUT Workflows/BusinessUnit/{workflowID}/{bUID}?validateOnly={validateOnly}	Update WorkflowBusinessUnit
DELETE Workflows/BusinessUnit/{workflowID}/{bUID}/{purge}	Delete WorkflowBusinessUnit

ClientMedicationReconciliation

API	Description
GET Clients/MedicationReconciliation	Get clientMedicationReconciliations from criteria
GET Clients/MedicationReconciliation/Initialize	Get empty clientMedicationReconciliation
GET Clients/MedicationReconciliation/{clientMedicationReconciliationID}	Get clientMedicationReconciliation
POST Clients/MedicationReconciliation?validateOnly={validateOnly}	Add clientMedicationReconciliation
PUT Clients/MedicationReconciliation/{clientMedicationReconciliationID}?validateOnly={validateOnly}	Update clientMedicationReconciliation
DELETE Clients/MedicationReconciliation/{clientMedicationReconciliationID}/{purge}	Delete clientMedicationReconciliation

FunderServiceTable

API	Description
GET Setup/FunderServiceTable?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&IncludeError={IncludeError}&Match={Match}	Get FunderServiceTables from criteria
GET Setup/FunderServiceTable/Initialize	Get empty FunderServiceTable
GET Setup/FunderServiceTable/{serviceTableID}	Get FunderServiceTable
POST Setup/FunderServiceTable?validateOnly={validateOnly}	Add FunderServiceTable
PUT Setup/FunderServiceTable/{serviceTableID}?validateOnly={validateOnly}	Update FunderServiceTable
PUT Setup/FunderServiceTable/Generated/{serviceTableID}	Finalize the events generation in FunderServiceTable and move to next period
DELETE Setup/FunderServiceTable/{serviceTableID}/{purge}	Delete FunderServiceTable

FormDataExtension

API	Description
GET Forms/Extension	Get extensions

ClientBankAccount

API	Description
GET Clients/BankAccount/Initialize	No documentation available.
GET Clients/BankAccount/{clientBankAccountID}	No documentation available.
GET Clients/BankAccount	No documentation available.
POST Clients/BankAccount	No documentation available.
PUT Clients/BankAccount/{clientBankAccountID}	No documentation available.
DELETE Clients/BankAccount/{clientBankAccountID}/{purge}	No documentation available.

InvoiceBatch

Invoice Batch Controller

API	Description
GET Invoices/Batch	Get invoiceBatches from criteria
GET Invoices/Batch/Initialize?RootInvoiceBatchID={RootInvoiceBatchID}&BatchType={BatchType}&WeekEndingDate={WeekEndingDate}&DepatureStopDate={DepatureStopDate}	Get empty invoiceBatch
GET Invoices/Batch/{invoiceBatchID}	Get invoiceBatch
POST Invoices/Batch?validateOnly={validateOnly}	Add invoiceBatch
PUT Invoices/Batch/{invoiceBatchID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/Batch/{invoiceBatchID}/{purge}	Delete invoiceBatch
PUT Invoices/Batch/Close/{rootInvoiceBatchID}	No documentation available.
POST Invoices/Batch/GenerateClientInvoices	Start process for invoice generation
POST Invoices/Batch/InvoiceBatchProcess	No documentation available.
GET Invoices/Batch/calculateWeekEndingDate	No documentation available.
POST Invoices/Batch/GenerateDepartureBatchOnResale/{deferredManagementFeeExtensionID}	No documentation available.
POST Invoices/Batch/Reset/{rootInvoiceBatchID}	Reset Batch Invoices

Journal

Journal Controller

API	Description
GET Journals/Journal	Get Journal from criteria
GET Journals/Journal/Initialize?InvoiceId={InvoiceId}	Get empty journals
GET Journals/Journal/{journalID}	Get Journal
POST Journals/Journal?validateOnly={validateOnly}	Add Journal
PUT Journals/Journal/{journalID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Journals/Journal/{journalID}/{purge}	Delete Journal
PUT Journals/Journal/{journalID}/Post	No documentation available.
POST Journals/Journal/Reverse	Reverse JournalItem
POST Journals/Journal/ReverseDraftSettlement/{parentJournalItemId}/{account}	Reverse Draft JournalItem

InvoiceBatchResult

Invoice Batch Result Controller

API	Description
GET Invoices/BatchResult	Get InvoiceBatchResult from criteria
GET Invoices/BatchResult/Initialize?GroupID={GroupID}&BUID={BUID}	Get empty invoiceBatchResults
GET Invoices/BatchResult/{invoiceBatchResultID}	Get InvoiceBatchResult
POST Invoices/BatchResult?validateOnly={validateOnly}	Add InvoiceBatchResult
PUT Invoices/BatchResult/{invoiceBatchResultID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/BatchResult/{invoiceBatchResultID}/{purge}	Delete InvoiceBatchResult

UserAuthGroup

API	Description
GET Users/UserAuthGroup	Get userAuthGroups from criteria
GET Users/UserAuthGroup/Initialize?AuthGroupID={AuthGroupID}	Get empty userAuthGroup
GET Users/UserAuthGroup/{userID}/{authGroupID}	Get userAuthGroup
POST Users/UserAuthGroup?validateOnly={validateOnly}	Add userAuthGroup
PUT Users/UserAuthGroup/bulk	No documentation available.
PUT V2/Users/UserAuthGroup/{userID}/{orgID}/BulkUpdateUserAuthGroups	Bulk-updates UserAuthGroups for a given user and organization
PUT Users/UserAuthGroup/{userID}/{authGroupID}?validateOnly={validateOnly}	Update userAuthGroup
DELETE Users/UserAuthGroup/{userID}/{authGroupID}/{purge}	Delete userAuthGroup
GET V2/Users/UserAuthGroup/Initialize?AuthGroupID={AuthGroupID}	Initializes a new UserAuthGroup object
GET V2/Users/UserAuthGroup	Get authGroups from criteria

ClientMedicationEntry

API	Description
GET Clients/MedicationEntry	Get clientMedicationEntries from criteria
GET Clients/MedicationEntry/Initialize?ClientMedicationID={ClientMedicationID}&MedicationCategory={MedicationCategory}	Get empty clientMedicationEntry
GET Clients/MedicationEntry/{clientMedicationEntryID}	Get clientMedicationEntry
POST Clients/MedicationEntry?validateOnly={validateOnly}	Add clientMedicationEntry
PUT Clients/MedicationEntry/{clientMedicationEntryID}?validateOnly={validateOnly}	Update clientMedicationEntry
DELETE Clients/MedicationEntry/{clientMedicationEntryID}/{purge}	Delete clientMedicationEntry

FormEntry

API	Description
GET Forms/FormEntry	Get form entries
GET Forms/FormEntry/{formEntryID}?includeBinaries={includeBinaries}	Get formEntry
GET Forms/FormEntry/Initialize	Get empty form entry
GET Forms/FormEntry/NavInfo/{clientID}	Get basic form info for displaying a navigation bar in the Charts section
GET Forms/FormEntry/GetVitalHistory?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&IncludeError={IncludeError}&FormFieldLinkID={FormFieldLinkID}&EntityID={EntityID}&CreatedDateUtcMin={CreatedDateUtcMin}&CreatedDateUtcMax={CreatedDateUtcMax}	Get Vital History
POST Forms/FormEntry/InitializeNote	Get empty form entry note
POST Forms/FormEntry/Recalculate	Recalculate form entry
POST Forms/FormEntry/CarePlanRecalculate	Recalculate care plan recommendations for a form entry
POST Forms/FormEntry?validateOnly={validateOnly}	Add formEntry
PUT Forms/FormEntry/{formEntryID}?validateOnly={validateOnly}	Update formEntry
DELETE Forms/FormEntry/{formEntryID}/{purge}	Delete formEntry

Allergy

API	Description
GET Setup/Allergy	Get allergies from criteria
GET Setup/Allergy/Initialize?AllergyTableID={AllergyTableID}	Get empty allergy
GET Setup/Allergy/{allergyID}	Get allergy
POST Setup/Allergy?validateOnly={validateOnly}	Add allergy
PUT Setup/Allergy/{allergyID}?validateOnly={validateOnly}	Update allergy
DELETE Setup/Allergy/{allergyID}/{purge}	Delete allergy

FormScore

API	Description
GET Forms/Score	Get scores
GET Forms/Score/{scoreID}	Get score
GET Forms/Score/Initialize?FormID={FormID}	Get empty form
POST Forms/Score?validateOnly={validateOnly}	Add formScore
PUT Forms/Score/{formScoreID}?validateOnly={validateOnly}	Update formScore
DELETE Forms/Score/{formScoreID}/{purge}	Delete formScore
PUT Forms/Score/{formScoreID}/Move/{afterFormScoreID}	Update formScore

OrganizationDatabaseInfo

API	Description
GET System/OrganizationDatabaseInfo	Get organizationDatabases from criteria
GET System/OrganizationDatabaseInfo/{dbID}	Get masterOrgDatabase

ContactFile

API	Description
GET Contacts/File	Get entityFiles from criteria
GET Contacts/File/Initialize?FileTypeID={FileTypeID}	Get empty entityFile
GET Contacts/File/{entityFileID}/{includePayload}	Get ContactFile
POST Contacts/File?validateOnly={validateOnly}	Add ContactFile
PUT Contacts/File/{entityFileID}?validateOnly={validateOnly}	Update ContactFile
DELETE Contacts/File/{entityFileID}/{purge}	Delete entityFile

BusinessUnit

API	Description
GET Setup/BusinessUnit	Get businessUnits from criteria
GET Setup/BusinessUnit/Initialize?OUID={OUID}	Get empty businessUnit
GET Setup/BusinessUnit/{bUID}	Get businessUnit
GET Setup/BusinessUnit/EntityBusinessUnits	No documentation available.
POST Setup/BusinessUnit?validateOnly={validateOnly}	Add businessUnit
PUT Setup/BusinessUnit/{bUID}?validateOnly={validateOnly}	Update businessUnit
PUT Setup/BusinessUnit/Generated/{bUID}	Finalize the events generation in businessUnit and move to next period
DELETE Setup/BusinessUnit/{bUID}/{purge}	Delete businessUnit
GET V2/Setup/BusinessUnit	Get businessUnits from criteria

BillingMedicareEBusinessValidationResult

API	Description
GET Billings/MedicareEBusinessValidationResult	Get MedicareEBusinessValidationResults
GET Billings/MedicareEBusinessValidationResult/Initialize	Get empty MedicareEBusinessValidationResult
GET Billings/MedicareEBusinessValidationResult/{validationResultID}	Get MedicareEBusinessValidationResult
POST Billings/MedicareEBusinessValidationResult?validateOnly={validateOnly}	Add MedicareEBusinessValidationResult
PUT Billings/MedicareEBusinessValidationResult/{validationResultID}?validateOnly={validateOnly}	Update MedicareEBusinessValidationResult
DELETE Billings/MedicareEBusinessValidationResult/{validationResultID}/{purge}	Delete MedicareEBusinessValidationResult

HealthCheck

API	Description
GET health	No documentation available.

SystemFileViaKey

API	Description
GET Setup/File/ViaKey/{key}/{resultAsBase64}	No documentation available.

OrganizationFile

API	Description
GET Setup/Organization/File/Initialize?FileTypeID={FileTypeID}	Get empty orgFile
GET Setup/Organization/File	Get current org File
POST Setup/Organization/File?validateOnly={validateOnly}	Add org File
POST Setup/Organization/File/Multipart/{saveAsPhysical}?validateOnly={validateOnly}	Add org File via multipart

GroupAddress

API	Description
GET Groups/Address	Get groupAddresses from criteria
GET Groups/Address/Initialize	Get empty groupAddress
GET Groups/Address/{addressID}	Get groupAddress
POST Groups/Address?validateOnly={validateOnly}	Add groupAddress
PUT Groups/Address/{addressID}?validateOnly={validateOnly}	Update groupAddress
DELETE Groups/Address/{addressID}/{purge}	Delete groupAddress

UserFile

API	Description
GET Users/File	Get entityFiles from criteria
GET Users/File/Initialize?FileTypeID={FileTypeID}	Get empty entityFile
GET Users/File/{entityFileID}/{includePayload}	Get UserFile
POST Users/File?validateOnly={validateOnly}	Add UserFile
PUT Users/File/{entityFileID}?validateOnly={validateOnly}	Update UserFile
DELETE Users/File/{entityFileID}/{purge}	Delete entityFile

Info

API	Description
GET Auth/Info/{refresh}	Get user session information via Authentication-Token
GET Auth/Info/Report	Get report user session information via Authentication-Token

SystemSetting

API	Description
GET Setup/Setting?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&Name={Name}	Get settings from criteria
GET Setup/Setting/Initialize?DBID={DBID}	Get empty setting
GET Setup/Setting/SMTP	Get SMTP setting
GET Setup/Setting/{settingID}	Get setting
POST Setup/Setting?validateOnly={validateOnly}	Add setting
POST Setup/Setting/Import	API endpoint for the bulk import of settings to an organization.
GET Setup/Setting/{orgID}/Export	No documentation available.
PUT Setup/Setting/{settingID}?validateOnly={validateOnly}	Update setting
DELETE Setup/Setting/{settingID}/{purge}	Delete setting
GET Setup/Setting/MasterConfigurationLevelSettingDetails?SettingName={SettingName}&GroupID={GroupID}&BusinessUnitID={BusinessUnitID}	Get details for the Master Configuration Level Settings

ContactLanguage

API	Description
GET Contacts/Language	Get contactLanguages from criteria
GET Contacts/Language/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty contactLanguage
GET Contacts/Language/{contactID}/{languageEntryID}	Get contactLanguage
POST Contacts/Language?validateOnly={validateOnly}	Add contactLanguage
PUT Contacts/Language/{contactID}/{languageEntryID}?validateOnly={validateOnly}	Update contactLanguage
DELETE Contacts/Language/{contactID}/{languageEntryID}/{purge}	Delete contactLanguage

NoteFile

API	Description
GET V2/Notes/File	Get noteFiles from criteria
GET V2/Notes/File/{noteFileID}/{noteEntityID}/{includePayload}	Get noteFile
POST V2/Notes/File/{noteEntityID}?validateOnly={validateOnly}	Add noteFile
POST V2/Notes/File/Multipart/{noteEntityID}?validateOnly={validateOnly}	Add note file via multipart
POST Notes/File/Multipart?validateOnly={validateOnly}	Add note file via multipart
PUT V2/Notes/File/{noteFileID}/Multipart/{noteEntityID}?validateOnly={validateOnly}	Update note file via multipart
PUT Notes/File/{noteFileID}/Multipart?validateOnly={validateOnly}	Update note file via multipart
PUT V2/Notes/File/{noteFileID}/{noteEntityID}?validateOnly={validateOnly}	Update clientFile
PUT Notes/File/{noteFileID}?validateOnly={validateOnly}	Update clientFile
DELETE V2/Notes/File/{noteFileID}/{noteEntityID}/{purge}	Delete noteFile
DELETE Notes/File/{noteFileID}/{purge}	Delete entityFile
GET Notes/File	Get entityFiles from criteria
GET Notes/File/Initialize?FileTypeID={FileTypeID}	Get empty entityFile
GET Notes/File/{noteFileID}/{includePayload}	Get clientFile
POST Notes/File?validateOnly={validateOnly}	Add clientFile

ReportSync

API	Description
POST Reports/Sync/ViaManifest?dbid={dbid}	Synchronization report server based on manifest
POST Reports/Sync/ViaZip?dbid={dbid}&orgProvisioning={orgProvisioning}	No documentation available.
POST Reports/Sync/ViaFolder?dbid={dbid}	Synchronization report server based on manifest
GET Reports/Sync/ViaFolder	Synchronization report server based on manifest

SubsidyReconciliationBatch

SubsidyReconciliationBatch Controller

API	Description
GET Billings/SubsidyReconciliationBatch	Get SubsidyReconciliationBatch from criteria
GET Billings/SubsidyReconciliationBatch/Initialize	Get empty subsidyReconciliationBatches
GET Billings/SubsidyReconciliationBatch/{subsidyReconciliationBatchID}	Get SubsidyReconciliationBatch
POST Billings/SubsidyReconciliationBatch?validateOnly={validateOnly}	Add SubsidyReconciliationBatch
POST Billings/SubsidyReconciliationBatch/ImportRecordFromFile	No documentation available.
PUT Billings/SubsidyReconciliationBatch/UpdateReconcilableItems/{subsidyReconciliationBatchID}	Update and re-match reconcilable items for given subsidy reconciliation batch id
PUT Billings/SubsidyReconciliationBatch/{subsidyReconciliationBatchID}?validateOnly={validateOnly}	Update invoiceBatch
POST Billings/SubsidyReconciliationBatch/Parse	Parses records from csv file. Read from mime multipart content
DELETE Billings/SubsidyReconciliationBatch/{subsidyReconciliationBatchID}/{purge}	Delete SubsidyReconciliationBatch
POST Billings/SubsidyReconciliationBatch/BatchTotalAmounts	No documentation available.
GET Billings/SubsidyReconciliationBatch/{subsidyReconciliationBatchID}/csv?csvType={csvType}	No documentation available.

RoleCategory

API	Description
GET Setup/RoleCategory	Get roleCategories from criteria
GET Setup/RoleCategory/Initialize	Get empty roleCategory
GET Setup/RoleCategory/{categoryID}	Get roleCategory
POST Setup/RoleCategory?validateOnly={validateOnly}	Add roleCategory
PUT Setup/RoleCategory/{categoryID}?validateOnly={validateOnly}	Update roleCategory
DELETE Setup/RoleCategory/{categoryID}/{purge}	Delete roleCategory

BillingRateTable

API	Description
GET Billing/BillingRateTable	Get billingRateTables from criteria
GET Billing/BillingRateTable/Initialize	Get empty billingRateTable
GET Billing/BillingRateTable/{billingRateTableID}	Get billingRateTable
POST Billing/BillingRateTable?validateOnly={validateOnly}	Add billingRateTable
PUT Billing/BillingRateTable/{billingRateTableID}?validateOnly={validateOnly}	Update billingRateTable
DELETE Billing/BillingRateTable/{billingRateTableID}/{purge}	Delete billingRateTable

ContactFileViaKey

API	Description
GET Contacts/File/ViaKey/{key}?resultAsBase64={resultAsBase64}	No documentation available.

CarePlanBusinessUnit

API	Description
GET CarePlans/BusinessUnit	Get carePlanBusinessUnits from criteria
GET CarePlans/BusinessUnit/Initialize?BUID={BUID}	Get empty carePlanBusinessUnit
GET CarePlans/BusinessUnit/{bUID}/{carePlanID}	Get carePlanBusinessUnit
POST CarePlans/BusinessUnit?validateOnly={validateOnly}	Add carePlanBusinessUnit
PUT CarePlans/BusinessUnit/{bUID}/{carePlanID}?validateOnly={validateOnly}	Update carePlanBusinessUnit
DELETE CarePlans/BusinessUnit/{bUID}/{carePlanID}/{purge}	Delete carePlanBusinessUnit

API	Description
POST Auth/Login	Login and obtain an Authentication-Token for subsequent method calls
POST Auth/Login/ResetPassword	No documentation available.
POST Auth/Login/ChangePassword	Allows an anonymous user to change a their password
PUT Auth/Login/ChangePassword	Allows an authenticated user to change their password
POST V2/Auth/Login	Login and obtain an Authentication-Token for subsequent method calls
POST V2/Auth/Login/ResetPassword	No documentation available.
POST V2/Auth/Login/ChangePassword	Allows an anonymous user to change a their password
PUT V2/Auth/Login/ChangePassword	Allows an authenticated user to change their password

OrganizationLicense

API	Description
GET System/OrganizationLicense	Get organizationLicenses from criteria
GET System/OrganizationLicense/Initialize?OrgID={OrgID}&LicenseCode={LicenseCode}&ExpirtyDateUtc={ExpirtyDateUtc}	Get empty organizationLicense
GET System/OrganizationLicense/{licenseID}	Get organizationLicense
POST System/OrganizationLicense?validateOnly={validateOnly}	Add organizationLicense
PUT System/OrganizationLicense/{licenseID}?validateOnly={validateOnly}	Update organizationLicense
DELETE System/OrganizationLicense/{licenseID}/{purge}	Delete organizationLicense

NoteType

API	Description
GET Setup/NoteType	Get noteTypes from criteria
GET Setup/NoteType/Initialize	Get empty noteType
GET Setup/NoteType/{noteTypeID}	Get noteType
POST Setup/NoteType?validateOnly={validateOnly}	Add noteType
PUT Setup/NoteType/{noteTypeID}?validateOnly={validateOnly}	Update noteType
DELETE Setup/NoteType/{noteTypeID}/{purge}	Delete noteType

ClientMedicationReconciliationDetail

API	Description
GET Clients/MedicationReconciliationDetail	Get clientMedicationReconciliationDetails from criteria
GET Clients/MedicationReconciliationDetail/Initialize	Get empty clientMedicationReconciliationDetail
GET Clients/MedicationReconciliationDetail/{clientMedicationReconciliationDetailID}	Get clientMedicationReconciliationDetail
POST Clients/MedicationReconciliationDetail?validateOnly={validateOnly}	Add clientMedicationReconciliationDetail
PUT Clients/MedicationReconciliationDetail/{clientMedicationReconciliationDetailID}?validateOnly={validateOnly}	Update clientMedicationReconciliationDetail
DELETE Clients/MedicationReconciliationDetail/{clientMedicationReconciliationDetailID}/{purge}	Delete clientMedicationReconciliationDetail

PaymentPlan

Payment Controller

API	Description
GET Billings/PaymentPlan	Get Payment Plan from criteria
GET Billings/PaymentPlan/{paymentPlanID}	Get Payment Plan
GET Billings/PaymentPlan/Initialize	Get empty Payment Plan
POST Billings/PaymentPlan?validateOnly={validateOnly}	Add Payment Plan
PUT Billings/PaymentPlan/{paymentPlanID}?validateOnly={validateOnly}	Update Payment Plan
DELETE Billings/PaymentPlan/{paymentPlanID}/{purge}	Delete Payment Plan
POST Billings/PaymentPlan/UpdatePaymentPlanAndRecalculate	No documentation available.

FormBinary

API	Description
GET Forms/Binary/{binaryID}/{includePayload}	Get formBinary
POST Forms/Binary?validateOnly={validateOnly}	Add formBinary
PUT Forms/Binary/{binaryID}?validateOnly={validateOnly}	Update formBinary
DELETE Forms/Binary/{binaryID}	Purge formBinary
POST Forms/Binary/Multipart?validateOnly={validateOnly}	Add formBinary via multipart
PUT Forms/Binary/{binaryID}/Multipart?validateOnly={validateOnly}	Add formBinary via multipart

Worker

API	Description
GET V2/Workers/Worker	Get workers
GET Workers/Worker	Get workers
GET Workers/Worker/Initialize	Get empty worker
GET Workers/Worker/{workerID}	Get worker
POST Workers/Worker?validateOnly={validateOnly}	Add worker
PUT Workers/Worker/{workerID}?validateOnly={validateOnly}	Update worker
DELETE Workers/Worker/{workerID}/{purge}	Delete worker
POST Workers/Worker/{formID}/updateExtensions	Update form extension

InvoiceItemDetail

Invoice Item Detail Controller

API	Description
GET Invoices/ItemDetail	Get InvoiceItemDetail from criteria
GET Invoices/ItemDetail/Initialize	Get empty invoiceItemDetails
GET Invoices/ItemDetail/{invoiceItemDetailID}	Get InvoiceItemDetail
POST Invoices/ItemDetail?validateOnly={validateOnly}	Add InvoiceItemDetail
PUT Invoices/ItemDetail/{invoiceItemDetailID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/ItemDetail/{invoiceItemDetailID}/{purge}	Delete InvoiceItemDetail

CarePlanItemLink

API	Description
GET CarePlans/ItemLink	Get carePlanItemLinks from criteria
GET CarePlans/ItemLink/Initialize?BUID={BUID}&CarePlanID={CarePlanID}&CarePlanItemID={CarePlanItemID}&ParentCarePlanItemLinkID={ParentCarePlanItemLinkID}	Get empty carePlanItemLink
GET CarePlans/ItemLink/{carePlanItemLinkID}	Get carePlanItemLink
POST CarePlans/ItemLink?validateOnly={validateOnly}	Add carePlanItemLink
PUT CarePlans/ItemLink/{carePlanItemLinkID}?validateOnly={validateOnly}	Update carePlanItemLink
DELETE CarePlans/ItemLink/{carePlanItemLinkID}/{purge}	Delete carePlanItemLink

FormSection

API	Description
GET Forms/Section	Get sections
GET Forms/Section/{sectionID}	Get section
GET Forms/Section/Initialize?FormID={FormID}	Get empty form
POST Forms/Section?validateOnly={validateOnly}	Add formSection
PUT Forms/Section/{formSectionID}?validateOnly={validateOnly}	Update formSection
DELETE Forms/Section/{formSectionID}/{purge}	Delete formSection
PUT Forms/Section/{formSectionID}/Move/{afterFormSectionID}	Update formSection

ContactBusinessUnit

API	Description
GET Contacts/BusinessUnit	Get contactBusinessUnits from criteria
GET Contacts/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty contactBusinessUnit
GET Contacts/BusinessUnit/{contactID}/{bUID}	Get contactBusinessUnit
POST Contacts/BusinessUnit?validateOnly={validateOnly}	Add contactBusinessUnit
PUT Contacts/BusinessUnit/{contactID}/{bUID}?validateOnly={validateOnly}	Update contactBusinessUnit
DELETE Contacts/BusinessUnit/{contactID}/{bUID}/{purge}	Delete contactBusinessUnit

JournalItem

JournalItem Controller

API	Description
GET Journals/JournalItems	Get JournalItem from criteria
GET Journals/JournalItems/Initialize	Get empty journalItems
GET Journals/JournalItems/{journalItemID}	Get JournalItem
PUT Journals/JournalItems/{journalItemID}/SettleToInvoices	Settle journal item to invoices
PUT Journals/JournalItems/{journalItemID}/SettleToClientOrders	Settle JournalItem to ClientOrders
POST Journals/JournalItems?validateOnly={validateOnly}	Add JournalItem
PUT Journals/JournalItems/{journalItemID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Journals/JournalItems/{journalItemID}/{purge}	Delete JournalItem
POST Journals/JournalItems/{journalItemID}/Copy	Copy JournalItem

Role

API	Description
GET Setup/Role	Get roles from criteria
GET Setup/Role/Initialize	Get empty role
GET Setup/Role/{roleID}	Get role
POST Setup/Role?validateOnly={validateOnly}	Add role
PUT Setup/Role/{roleID}?validateOnly={validateOnly}	Update role
DELETE Setup/Role/{roleID}/{purge}	Delete role

BedMaximum

API	Description
GET Groups/BedMaximum	Get bedMaximums from criteria
GET Groups/BedMaximum/Initialize?BedID={BedID}&GroupMaximumID={GroupMaximumID}	Get empty bedMaximum
GET Groups/BedMaximum/{bedMaximumID}	Get bedMaximum
POST Groups/BedMaximum?validateOnly={validateOnly}	Add bedMaximum
PUT Groups/BedMaximum/{bedMaximumID}?validateOnly={validateOnly}	Update bedMaximum
DELETE Groups/BedMaximum/{bedMaximumID}/{purge}	Delete bedMaximum

ClientInvoicePaymentMethod

API	Description
PUT Clients/InvoicePaymentMethod/{clientID}/{billingRateType}/{paymentMethod}	No documentation available.

InvoiceItem

Invoice Item Controller

API	Description
GET Invoices/Item	Get InvoiceItem from criteria
GET Invoices/Item/Initialize	Get empty invoiceItems
GET Invoices/Item/{invoiceItemID}	Get InvoiceItem
POST Invoices/Item?validateOnly={validateOnly}	Add InvoiceItem
PUT Invoices/Item/{invoiceItemID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/Item/{invoiceItemID}/{purge}	Delete InvoiceItem

ClientMedicationReconciliationDetailDiscrepancy

API	Description
GET Clients/MedicationReconciliationDetailDiscrepancy	Get clientMedicationReconciliationDetailDiscrepancies from criteria
GET Clients/MedicationReconciliationDetailDiscrepancy/Initialize	Get empty clientMedicationReconciliationDetailDiscrepancy
GET Clients/MedicationReconciliationDetailDiscrepancy/{clientMedicationReconciliationDetailDiscrepancyID}	Get clientMedicationReconciliationDetailDiscrepancy
POST Clients/MedicationReconciliationDetailDiscrepancy?validateOnly={validateOnly}	Add clientMedicationReconciliationDetailDiscrepancy
PUT Clients/MedicationReconciliationDetailDiscrepancy/{clientMedicationReconciliationDetailDiscrepancyID}?validateOnly={validateOnly}	Update clientMedicationReconciliationDetailDiscrepancy
DELETE Clients/MedicationReconciliationDetailDiscrepancy/{clientMedicationReconciliationDetailDiscrepancyID}/{purge}	Delete clientMedicationReconciliationDetailDiscrepancy

UserActivity

API	Description
GET Users/Activity	Get userActivities from criteria
GET Users/Activity/Initialize	Get empty userActivity
GET Users/Activity/{userActivityID}	Get userActivity
POST Users/Activity?validateOnly={validateOnly}	Add userActivity
PUT Users/Activity/{userActivityID}?validateOnly={validateOnly}	Update userActivity
DELETE Users/Activity/{userActivityID}/{purge}	Delete userActivity

UserEntity

API	Description
GET Users/Entity?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&EntityID={EntityID}&EntityType={EntityType}&ExceptUserID={ExceptUserID}&MaxRows={MaxRows}	Get userEntities from criteria
GET Users/Entity/Initialize?BUID={BUID}	Get empty userEntity
GET Users/Entity/{userID}/{entityID}	Get userEntity
POST Users/Entity?validateOnly={validateOnly}	Add userEntity
PUT Users/Entity/{userID}/{entityID}?validateOnly={validateOnly}	Update userEntity
DELETE Users/Entity/{userID}/{entityID}/{purge}	Delete userEntity
GET V2/Users/Entity?OrgID={OrgID}&IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&UserID={UserID}&EntityID={EntityID}&EntityType={EntityType}&ExceptUserID={ExceptUserID}&MaxRows={MaxRows}	Get userEntities from criteria
GET V2/Users/Entity/Initialize?OrgID={OrgID}&BUID={BUID}	Get empty userEntity
POST V2/Users/Entity?validateOnly={validateOnly}	Add userEntity

NoteFileViaKey

API	Description
GET Notes/File/ViaKey/{key}/{resultAsBase64}	No documentation available.

WorkerRelationshipDetail

API	Description
GET Workers/RelationshipDetail	Get workerRelationshipDetails from criteria
GET Workers/RelationshipDetail/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty workerRelationshipDetail
GET Workers/RelationshipDetail/{workerID}/{entityRelationshipID}	Get workerRelationshipDetail
POST Workers/RelationshipDetail?validateOnly={validateOnly}	Add workerRelationshipDetail
PUT Workers/RelationshipDetail/{workerID}/{entityRelationshipID}?validateOnly={validateOnly}	Update workerRelationshipDetail
DELETE Workers/RelationshipDetail/{workerID}/{entityRelationshipID}/{purge}	Delete workerRelationshipDetail

ClientOrderFrequency

API	Description
GET Clients/OrderFrequency	Get clientOrderFrequencies from criteria
GET Clients/OrderFrequency/Initialize?ClientOrderID={ClientOrderID}	Get empty clientOrderFrequency
GET Clients/OrderFrequency/{clientOrderFrequencyID}	Get clientOrderFrequency
POST Clients/OrderFrequency?validateOnly={validateOnly}	Add clientOrderFrequency
POST Clients/OrderFrequency/Description	Get description for clientOrderFrequency
PUT Clients/OrderFrequency/{clientOrderFrequencyID}?validateOnly={validateOnly}	Update clientOrderFrequency
DELETE Clients/OrderFrequency/{clientOrderFrequencyID}/{purge}	Delete clientOrderFrequency

ClientFundingInformation

API	Description
GET Clients/FundingInformation/{clientID}/Latest	Get the Latest Funding form entry for Client Group when there is no Current Funding form entry
POST Clients/FundingInformation/{statusID}/{formEntryID}	No documentation available.

Deposit

Deposits Controller

API	Description
GET Deposits/Deposit	Get Deposit from criteria
GET Deposits/Deposit/Initialize	Get empty deposits
GET Deposits/Deposit/{depositID}	Get Deposit
PUT Deposits/Deposit/{depositID}/SettleToInvoices	Settle deposit to invoices
POST Deposits/Deposit?validateOnly={validateOnly}	Add Deposit
PUT Deposits/Deposit/{depositID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Deposits/Deposit/{depositID}/{purge}	Delete Deposit
POST Deposits/Deposit/Refund	Refund Deposit(s)
POST Deposits/Deposit/ManualInterestDeposit	Adding an interest Deposit based on existing deposit
POST Deposits/Deposit/Refund/OnDischarge	Refund Deposit(s)
POST Deposits/Deposit/postAdjustment	Adjust a deposit A new journal and two journal items will be inserted for each adjustment
POST Deposits/Deposit/SeparationInterest/{clientID}	No documentation available.
POST Deposits/Deposit/SeparationInterest/Generate	No documentation available.
GET Deposits/Deposit/SeparationInterest	No documentation available.
POST Deposits/Deposit/SeparationInterest/Calculate	No documentation available.
POST Deposits/Deposit/SeparationInterest/Finalize	No documentation available.
PUT Deposits/Deposit/BulkUpdate	No documentation available.
POST Deposits/Deposit/Transfer	No documentation available.

GroupRelationshipDetail

API	Description
GET Groups/RelationshipDetail	Get groupRelationshipDetails from criteria
GET Groups/RelationshipDetail/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty groupRelationshipDetail
GET Groups/RelationshipDetail/{groupID}/{entityRelationshipID}	Get groupRelationshipDetail
POST Groups/RelationshipDetail?validateOnly={validateOnly}	Add groupRelationshipDetail
PUT Groups/RelationshipDetail/{groupID}/{entityRelationshipID}?validateOnly={validateOnly}	Update groupRelationshipDetail
DELETE Groups/RelationshipDetail/{groupID}/{entityRelationshipID}/{purge}	Delete groupRelationshipDetail

CarePlanItemCategory

API	Description
GET CarePlans/ItemCategory	Get carePlanItemCategories from criteria
GET CarePlans/ItemCategory/Initialize?BUID={BUID}	Get empty carePlanItemCategory
GET CarePlans/ItemCategory/{carePlanItemCategoryID}	Get carePlanItemCategory
POST CarePlans/ItemCategory?validateOnly={validateOnly}	Add carePlanItemCategory
PUT CarePlans/ItemCategory/{carePlanItemCategoryID}?validateOnly={validateOnly}	Update carePlanItemCategory
DELETE CarePlans/ItemCategory/{carePlanItemCategoryID}/{purge}	Delete carePlanItemCategory

GroupBusinessUnitStatus

API	Description
GET Groups/BusinessUnitStatus	Get groupBusinessUnitStatuses from criteria
GET Groups/BusinessUnitStatus/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty groupBusinessUnitStatus
GET Groups/BusinessUnitStatus/{statusID}	Get groupBusinessUnitStatus
POST Groups/BusinessUnitStatus?validateOnly={validateOnly}	Add groupBusinessUnitStatus
PUT Groups/BusinessUnitStatus/{statusID}?validateOnly={validateOnly}	Update groupBusinessUnitStatus
DELETE Groups/BusinessUnitStatus/{statusID}/{purge}	Delete groupBusinessUnitStatus

WorkerCommunicationMethod

API	Description
GET Workers/CommunicationMethod	Get workerCommunicationMethods from criteria
GET Workers/CommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}	Get empty workerCommunicationMethod
GET Workers/CommunicationMethod/{communicationMethodID}	Get workerCommunicationMethod
POST Workers/CommunicationMethod?validateOnly={validateOnly}	Add workerCommunicationMethod
PUT Workers/CommunicationMethod/{workerID}/{communicationMethodID}?validateOnly={validateOnly}	Update workerCommunicationMethod
DELETE Workers/CommunicationMethod/{communicationMethodID}/{purge}	Delete workerCommunicationMethod

ContactAddress

API	Description
GET Contacts/Address	Get contactAddresses from criteria
GET Contacts/Address/Initialize	Get empty contactAddress
GET Contacts/Address/{addressID}	Get contactAddress
POST Contacts/Address?validateOnly={validateOnly}	Add contactAddress
PUT Contacts/Address/{addressID}?validateOnly={validateOnly}	Update contactAddress
DELETE Contacts/Address/{addressID}/{purge}	Delete contactAddress

AttendanceTypeAddress

API	Description
GET Setup/AttendanceType/Address	Get AttendanceTypeAddresss from criteria
GET Setup/AttendanceType/Address/Initialize	Get empty AttendanceTypeAddress
GET Setup/AttendanceType/Address/{addressID}	Get AttendanceTypeAddress
POST Setup/AttendanceType/Address	Add AttendanceTypeAddress
PUT Setup/AttendanceType/Address/{addressID}	Update AttendanceTypeAddress
DELETE Setup/AttendanceType/Address/{addressID}/{purge}	Delete AttendanceTypeAddress

ContactRelationshipDetail

API	Description
GET Contacts/RelationshipDetail	Get contactRelationshipDetails from criteria
GET Contacts/RelationshipDetail/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty contactRelationshipDetail
GET Contacts/RelationshipDetail/{contactID}/{entityRelationshipID}	Get contactRelationshipDetail
POST Contacts/RelationshipDetail?validateOnly={validateOnly}	Add contactRelationshipDetail
PUT Contacts/RelationshipDetail/{contactID}/{entityRelationshipID}?validateOnly={validateOnly}	Update contactRelationshipDetail
DELETE Contacts/RelationshipDetail/{contactID}/{entityRelationshipID}/{purge}	Delete contactRelationshipDetail

UnitPriceSummary

UnitPriceSummary Controller

API	Description
GET Billings/UnitPriceSummary	Get UnitPriceSummary from criteria

InvoiceOutput

Invoice Output Controller

API	Description
GET Invoices/Output	Get InvoiceOutput from criteria
GET Invoices/Output/Initialize	Get empty invoiceOutputs
GET Invoices/Output/{invoiceOutputID}	Get InvoiceOutput
POST Invoices/Output?validateOnly={validateOnly}	Add InvoiceOutput
PUT Invoices/Output/{invoiceOutputID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Invoices/Output/{invoiceOutputID}/{purge}	Delete InvoiceOutput

BusinessUnitCommunicationMethod

API	Description
GET Setup/BusinessUnitCommunicationMethod	Get businessUnitCommunicationMethods from criteria
GET Setup/BusinessUnitCommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}	Get empty businessUnitCommunicationMethod
GET Setup/BusinessUnitCommunicationMethod/{communicationMethodID}	Get businessUnitCommunicationMethod
POST Setup/BusinessUnitCommunicationMethod?validateOnly={validateOnly}	Add businessUnitCommunicationMethod
PUT Setup/BusinessUnitCommunicationMethod/{businessUnitID}/{communicationMethodID}?validateOnly={validateOnly}	Update businessUnitCommunicationMethod
DELETE Setup/BusinessUnitCommunicationMethod/{communicationMethodID}/{purge}	Delete businessUnitCommunicationMethod

EntityNote

API	Description
GET Notes/Entity	Get noteDetails from criteria
GET Notes/Entity/Initialize	Get empty entityNote
GET Notes/Entity/{entityID}/{bUID}?noteID={noteID}	Get entityNote
POST Notes/Entity?validateOnly={validateOnly}	Add entityNote
PUT Notes/Entity/{entityID}/{bUID}?noteID={noteID}&validateOnly={validateOnly}	Update noteDetail
DELETE Notes/Entity/{entityID}/{noteID}/{purge}	Delete noteDetail

Form

API	Description
GET Forms/Form	Get forms
GET Forms/Form/{formID}/{includePayload}	Get form
GET Forms/Form/Initialize	Get empty form
GET Forms/Form/FormsWithSubFormInfo	Get basic form info, along with its sub forms. This should behave the same as 'Get forms', but the results are in FormNavListInfoDTO
POST Forms/Form?validateOnly={validateOnly}	Add form
PUT Forms/Form/{formID}?validateOnly={validateOnly}	Update form
DELETE Forms/Form/{formID}/{purge}/{purgeUnusedFields}	Delete form
GET Forms/Form/{formID}/used	Is form used
GET Forms/Form/{formID}/versioned	Is form versioned
POST Forms/Form/Recalculate	Recalculate form
POST Forms/Form/{formID}/upgrade	Upgrade form
POST Forms/Form/{formID}/updateSortOrder?sortOrder={sortOrder}	Update form sort order
POST Forms/Form/{formID}/retire	Retire form

WorkerNotification

API	Description
GET Workers/Notification	Get workerNotifications from criteria
GET Workers/Notification/Initialize?BUID={BUID}	Get empty workerNotification
GET Workers/Notification/{workerID}/{type}	Get workerNotification
POST Workers/Notification?validateOnly={validateOnly}	Add workerNotification
PUT Workers/Notification/{workerID}/{type}?validateOnly={validateOnly}	Update workerNotification
DELETE Workers/Notification/{workerID}/{type}/{purge}	Delete workerNotification

ReportPath

API	Description
GET Reports/ReportPath	Get report paths

FeeCapStatus

FeeCapStatus Controller

API	Description
GET FeeCapStatuses/FeeCapStatus	Get FeeCapStatuses from criteria
GET FeeCapStatuses/FeeCapStatus/Initialize	Get empty FeeCapStatus
POST FeeCapStatuses/FeeCapStatus?validateOnly={validateOnly}	Add FeeCapStatus
PUT FeeCapStatuses/FeeCapStatus/{feeCapStatusID}?validateOnly={validateOnly}	Update FeeCapStatus
GET FeeCapStatuses/FeeCapStatus/GetLimits	No documentation available.
PUT FeeCapStatuses/FeeCapStatus/ExternalChange	No documentation available.
POST FeeCapStatuses/FeeCapStatus/ClientExtension/IsReadOnly	No documentation available.
PUT FeeCapStatuses/FeeCapStatus/EditFeeCapExternalAmounts	No documentation available.

UserPreferences

API	Description
GET Users/Preferences/{userID}	Get a user's preference
PUT Users/Preferences/{userID}?validateOnly={validateOnly}	Update a user

SystemRebuild

API	Description
POST System/Rebuild	Update standard tables for all databases

Medication

API	Description
GET Setup/Medication	Get medications from criteria
GET Setup/Medication/Initialize	Get empty medication
GET Setup/Medication/{medicationID}	Get medication
POST Setup/Medication?validateOnly={validateOnly}	Add medication
PUT Setup/Medication/{medicationID}?validateOnly={validateOnly}	Update medication
DELETE Setup/Medication/{medicationID}/{purge}	Delete medication

ClientQuickAddForms

API	Description
GET Clients/Client/{clientID}/QuickAddForms?businessUnits[0]={businessUnits[0]}&businessUnits[1]={businessUnits[1]}	Get quick add form items for client (and optionally business unit)

MasterLogin

API	Description
GET Users/Login	Get users from criteria
GET Users/Login/Initialize?BUID={BUID}&WorkerID={WorkerID}	Get empty user
GET Users/Login/{userID}	Get user
POST Users/Login?validateOnly={validateOnly}	Add user
PUT Users/Login/{userID}?validateOnly={validateOnly}	Update user
PUT Users/Login/ChangePassword	Change user's password
DELETE Users/Login/{userID}/{purge}	Delete user

ClientCarePlanEntry

API	Description
GET Clients/CarePlanEntry	Get clientCarePlanEntries from criteria
GET Clients/CarePlanEntry/Initialize?BUID={BUID}&CarePlanID={CarePlanID}&ClientCarePlanID={ClientCarePlanID}	Get empty clientCarePlanEntry
GET Clients/CarePlanEntry/{clientCarePlanEntryID}	Get clientCarePlanEntry
POST Clients/CarePlanEntry?validateOnly={validateOnly}	Add clientCarePlanEntry
PUT Clients/CarePlanEntry/{clientCarePlanEntryID}?validateOnly={validateOnly}	Update clientCarePlanEntry
DELETE Clients/CarePlanEntry/{clientCarePlanEntryID}/{purge}	Delete clientCarePlanEntry

EntityGPSEntry

API	Description
GET Entities/GPSEntry	Get entityGPSEntries from criteria
GET Entities/GPSEntry/Initialize	Get empty entityGPSEntry
GET Entities/GPSEntry/{entityGPSEntryID}	Get entityGPSEntry
POST Entities/GPSEntry?validateOnly={validateOnly}	Add entityGPSEntry
PUT Entities/GPSEntry/{entityGPSEntryID}?validateOnly={validateOnly}	Update entityGPSEntry
DELETE Entities/GPSEntry/{entityGPSEntryID}/{purge}	Delete entityGPSEntry

ClientOrderBillingRate

API	Description
GET Clients/OrderBillingRate/{clientOrderBillingRateID}	No documentation available.
GET Clients/OrderBillingRate	No documentation available.
POST Clients/OrderBillingRate	No documentation available.
PUT Clients/OrderBillingRate/UpdatePaymentMethod/{clientID}/{billingRateType}/{paymentMethod}	No documentation available.
PUT Clients/OrderBillingRate/{clientOrderBillingRateID}	No documentation available.
DELETE Clients/OrderBillingRate/{clientOrderBillingRateID}/{purge}	No documentation available.
GET Clients/OrderBillingRate/Initialize?Type={Type}	No documentation available.
GET Clients/OrderBillingRate/GetAccessibleAccommodationsTypes	No documentation available.
GET Clients/OrderBillingRate/GetFundingScores	No documentation available.
POST Clients/OrderBillingRate/Calculate	No documentation available.
POST Clients/OrderBillingRate/RecalculateFeeSchedule	No documentation available.
POST Clients/OrderBillingRate/CalculateAgreedMaxDAC	No documentation available.
PUT Clients/OrderBillingRate/{clientOrderBillingRateID}/Replace	No documentation available.
GET Clients/OrderBillingRate/FindBulkCOBRExport	Finds client order billing rates for a user to export
GET Clients/OrderBillingRate/CanAddDmf/{clientID}	No documentation available.

FormEntrySummary

API	Description
GET Forms/FormEntrySummary	Get form entrie summaries

UserTokens

API	Description
GET Users/Tokens/{userID}	Get a user's token
PUT Users/Tokens/{userID}?validateOnly={validateOnly}	Update a user

EventBinaryViaKey

API	Description
GET Events/Binary/ViaKey/{key}/{resultAsBase64}	No documentation available.

FunderService

API	Description
GET Setup/FunderService	Get FunderServices from criteria
GET Setup/FunderService/Initialize	Get empty FunderService
GET Setup/FunderService/{funderServiceId}	Get FunderService
POST Setup/FunderService?validateOnly={validateOnly}	Add FunderService
PUT Setup/FunderService/{funderServiceId}?validateOnly={validateOnly}	Update FunderService
PUT Setup/FunderService/Generated/{funderServiceId}	Finalize the events generation in FunderService and move to next period
DELETE Setup/FunderService/{funderServiceId}/{purge}	Delete FunderService

AuthGroupNoteType

API	Description
GET Users/AuthGroupNoteType	Get authGroupNoteTypes from criteria
GET Users/AuthGroupNoteType/Initialize?AuthGroupID={AuthGroupID}	Get empty authGroupNoteType
GET Users/AuthGroupNoteType/{authGroupID}/{noteTypeID}	Get authGroupNoteType
POST Users/AuthGroupNoteType?validateOnly={validateOnly}	Add authGroupNoteType
PUT Users/AuthGroupNoteType/bulk	No documentation available.
PUT Users/AuthGroupNoteType/{authGroupID}/{noteTypeID}?validateOnly={validateOnly}	Update authGroupNoteType
DELETE Users/AuthGroupNoteType/{authGroupID}/{noteTypeID}/{purge}	Delete authGroupNoteType

AuthGroupReport

API	Description
GET Users/AuthGroupReport?IncludeActive={IncludeActive}&IncludeInactive={IncludeInactive}&IncludeDeleted={IncludeDeleted}&Match={Match}&AuthGroupID={AuthGroupID}&ReportID={ReportID}	Get authGroupReports from criteria
GET Users/AuthGroupReport/Initialize?AuthGroupID={AuthGroupID}	Get empty authGroupReport
GET Users/AuthGroupReport/{authGroupID}/{reportID}	Get authGroupReport
POST Users/AuthGroupReport?validateOnly={validateOnly}	Add authGroupReport
PUT Users/AuthGroupReport/bulk	No documentation available.
PUT Users/AuthGroupReport/{authGroupID}/{reportID}?validateOnly={validateOnly}	Update authGroupReport
DELETE Users/AuthGroupReport/{authGroupID}/{reportID}/{purge}	Delete authGroupReport

FinanceUtils

API	Description
GET Finance/EBusinessEvents/Utils/EventTypes	No documentation available.
GET Finance/EBusinessEvents/Utils/OrganizationTypes	No documentation available.
GET Finance/EBusinessEvents/Utils/LiabilityTypes	No documentation available.

CarePlanResponseCodeTable

API	Description
GET CarePlans/ResponseCodeTable	Get carePlanResponseCodeTables from criteria
GET CarePlans/ResponseCodeTable/Initialize?BUID={BUID}	Get empty carePlanResponseCodeTable
GET CarePlans/ResponseCodeTable/{carePlanResponseCodeTableID}	Get carePlanResponseCodeTable
POST CarePlans/ResponseCodeTable?validateOnly={validateOnly}	Add carePlanResponseCodeTable
PUT CarePlans/ResponseCodeTable/{carePlanResponseCodeTableID}?validateOnly={validateOnly}	Update carePlanResponseCodeTable
DELETE CarePlans/ResponseCodeTable/{carePlanResponseCodeTableID}/{purge}	Delete carePlanResponseCodeTable

AuthGroupForm

API	Description
GET Users/AuthGroupForm	Get authGroupForm from criteria
GET Users/AuthGroupForm/Initialize	Get empty authGroupForm
GET Users/AuthGroupForm/{authGroupID}/{formID}	Get authGroupForm
POST Users/AuthGroupForm?validateOnly={validateOnly}	Add authGroupForm
PUT Users/AuthGroupForm/bulk	No documentation available.
PUT Users/AuthGroupForm/{authGroupID}/{formID}?validateOnly={validateOnly}	Update authGroupForm
DELETE Users/AuthGroupForm/{authGroupID}/{formID}/{purge}	Delete authGroupForm

ReportLog

Responsible for logging JReport reports execution information.

API	Description
POST Reports/Logs/{reportID}	Logs in our Log DB all necessary information about a JReport Report execution.

EntitySetting

API	Description
GET Setup/EntitySetting	Get entitySettings from criteria
GET Setup/EntitySetting/Initialize?SettingID={SettingID}&EntityID={EntityID}	Get empty entitySetting
GET Setup/EntitySetting/Defaults?SettingID={SettingID}&EntityID={EntityID}&EntityType={EntityType}	Get default entitySettings
GET Setup/EntitySetting/{settingID}	Get entitySetting
POST Setup/EntitySetting?validateOnly={validateOnly}	Add entitySetting
POST Setup/EntitySetting/{entityID}/Import	Import entity settings
GET Setup/EntitySetting/{entityID}/Export	Export entity settings
PUT Setup/EntitySetting/{settingID}?validateOnly={validateOnly}	Update entitySetting
DELETE Setup/EntitySetting/{settingID}/{purge}	Delete entitySetting

WorkflowRuleTrigger

API	Description
GET Workflows/RuleTrigger	Get WorkflowRuleTriggers from criteria
GET Workflows/RuleTrigger/Initialize	Get empty WorkflowRuleTrigger
GET Workflows/RuleTrigger/{workflowRuleTriggerID}	Get WorkflowRuleTrigger
POST Workflows/RuleTrigger?validateOnly={validateOnly}	Add WorkflowRuleTrigger
PUT Workflows/RuleTrigger/{workflowRuleTriggerID}?validateOnly={validateOnly}	Update WorkflowRuleTrigger
DELETE Workflows/RuleTrigger/{workflowRuleTriggerID}/{purge}	Delete WorkflowRuleTrigger
POST Workflows/RuleTrigger/UpdateSummary?includeChild={includeChild}	return WorkflowRuleTrigger Summary

WorkerBusinessUnit

API	Description
GET Workers/BusinessUnit	Get workerBusinessUnits from criteria
GET Workers/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty workerBusinessUnit
GET Workers/BusinessUnit/{workerID}/{bUID}	Get workerBusinessUnit
POST Workers/BusinessUnit?validateOnly={validateOnly}	Add workerBusinessUnit
PUT Workers/BusinessUnit/{workerID}/{bUID}?validateOnly={validateOnly}	Update workerBusinessUnit
DELETE Workers/BusinessUnit/{workerID}/{bUID}/{purge}	Delete workerBusinessUnit

EventForm

API	Description
GET Events/Form	Get eventForms from criteria
GET Events/Form/Initialize?FormID={FormID}	Get empty eventForm
GET Events/Form/{eventFormID}	Get eventForm
POST Events/Form?validateOnly={validateOnly}	Add eventForm
PUT Events/Form/{eventFormID}?validateOnly={validateOnly}	Update eventForm
DELETE Events/Form/{eventFormID}/{purge}	Delete eventForm

FormField

API	Description
GET Forms/Field	Get fields
GET Forms/Field/{fieldID}	Get field
GET Forms/Field/Initialize?Type={Type}	Get empty field
POST Forms/Field/GetFormFields	Get fields
GET Forms/Field/{fieldID}/choices?ClientOrderID={ClientOrderID}	Get field choices
GET Forms/Field/{fieldID}/entitychoices	Get field entity choices
POST Forms/Field?validateOnly={validateOnly}	Add field
PUT Forms/Field/{fieldID}?validateOnly={validateOnly}	Update form
DELETE Forms/Field/{fieldID}/{purge}	Delete field
GET Forms/Field/{fieldID}/used/{formIDToExclude}	Is field used
GET Forms/Field/{fieldID}/versioned	Is field versioned
POST Forms/Field/{formID}/validate	Is Script Valid
POST Forms/Field/{fieldID}/upgrade/{formFieldLinkID}	Upgrade field
POST Forms/Field/RefreshModel	Refresh answer

Localize

API	Description
POST Utils/Localize	Get localized strings

ContactGroupStatus

API	Description
GET Contacts/GroupStatus	Get contactGroupStatuses from criteria
GET Contacts/GroupStatus/Initialize?BUID={BUID}&EntityID={EntityID}&GroupID={GroupID}	Get empty contactGroupStatus
GET Contacts/GroupStatus/{statusID}	Get contactGroupStatus
POST Contacts/GroupStatus?validateOnly={validateOnly}	Add contactGroupStatus
PUT Contacts/GroupStatus/{statusID}?validateOnly={validateOnly}	Update contactGroupStatus
DELETE Contacts/GroupStatus/{statusID}/{purge}	Delete contactGroupStatus

OrganizationImage

API	Description
GET Setup/Organization/Image/Initialize?FileTypeID={FileTypeID}	Get empty orgImage
GET Setup/Organization/Image	Get current org image
POST Setup/Organization/Image?validateOnly={validateOnly}	Add org image
POST Setup/Organization/Image/Multipart?validateOnly={validateOnly}	Add org image via multipart

JournalType

Journal Type Controller

API	Description
GET Billings/JournalTypes	Get JournalType from criteria
GET Billings/JournalTypes/Initialize	Get empty journalTypes
GET Billings/JournalTypes/{journalTypeID}	Get JournalType
POST Billings/JournalTypes?validateOnly={validateOnly}	Add JournalType
PUT Billings/JournalTypes/{journalTypeID}?validateOnly={validateOnly}	Update invoiceBatch
DELETE Billings/JournalTypes/{journalTypeID}/{purge}	Delete JournalType

PostingPeriod

PostingPeriod Controller

API	Description
GET Billings/PostingPeriod	Get PostingPeriod from criteria
GET Billings/PostingPeriod/{postingPeriodID}	Get PostingPeriod
GET Billings/PostingPeriod/Initialize	Get empty PostingPeriod
GET Billings/PostingPeriod/IsValidForPosting?date={date}	No documentation available.
POST Billings/PostingPeriod?validateOnly={validateOnly}	Add PostingPeriod
GET Billings/PostingPeriod/IsPostingDateValidForProcessSettlement	No documentation available.
PUT Billings/PostingPeriod/{postingPeriodID}?validateOnly={validateOnly}	Update PostingPeriod

BedStatus

API	Description
GET Groups/BedStatus	Get bedStatuses from criteria
GET Groups/BedStatus/Initialize?BUID={BUID}&BedID={BedID}	Get empty bedStatus
GET Groups/BedStatus/{bedStatusID}	Get bedStatus
POST Groups/BedStatus?validateOnly={validateOnly}	Add bedStatus
PUT Groups/BedStatus/{bedStatusID}?validateOnly={validateOnly}	Update bedStatus
DELETE Groups/BedStatus/{bedStatusID}/{purge}	Delete bedStatus
DELETE Groups/BedStatus/RollBackOldBedStatus/{bedID}	No documentation available.

BusinessUnitStatus

API	Description
GET Setup/BusinessUnitStatus	Get businessUnitStatuses from criteria
GET Setup/BusinessUnitStatus/Initialize?BUID={BUID}&Type={Type}	Get empty businessUnitStatus
GET Setup/BusinessUnitStatus/Defaults?BUID={BUID}&Type={Type}&IncludeClientResidentialStatuses={IncludeClientResidentialStatuses}&IncludeClientGroupStatuses={IncludeClientGroupStatuses}&IncludeWorkerStatuses={IncludeWorkerStatuses}&IncludeWorkerGroupStatuses={IncludeWorkerGroupStatuses}&IncludeGroupStatuses={IncludeGroupStatuses}&IncludeContactStatuses={IncludeContactStatuses}	Get default businessUnitStatuses
GET Setup/BusinessUnitStatus/{businessUnitStatusID}	Get businessUnitStatus
POST Setup/BusinessUnitStatus?validateOnly={validateOnly}	Add businessUnitStatus
PUT Setup/BusinessUnitStatus/{businessUnitStatusID}?validateOnly={validateOnly}	Update businessUnitStatus
DELETE Setup/BusinessUnitStatus/{businessUnitStatusID}/{purge}	Delete businessUnitStatus

FunderBusinessUnit

API	Description
GET Setup/FunderBusinessUnit	Get funderBusinessUnits from criteria
GET Setup/FunderBusinessUnit/Initialize?BUID={BUID}	Get empty funderBusinessUnit
GET Setup/FunderBusinessUnit/{funderID}/{bUID}	Get funderBusinessUnit
POST Setup/FunderBusinessUnit?validateOnly={validateOnly}	Add funderBusinessUnit
PUT Setup/FunderBusinessUnit/{funderID}/{bUID}?validateOnly={validateOnly}	Update funderBusinessUnit
DELETE Setup/FunderBusinessUnit/{funderID}/{bUID}/{purge}	Delete funderBusinessUnit

Log

API	Description
GET Setup/Log?StartUtc={StartUtc}&StopUtc={StopUtc}&Match={Match}&User={User}&UserID={UserID}&Title={Title}&Category={Category}&Details={Details}&ExternalID={ExternalID}&Severity={Severity}&Priority={Priority}	Get logs from criteria
GET Setup/Log/Initialize?DBID={DBID}	Get empty log
GET Setup/Log/{logID}	Get log
POST Setup/Log?validateOnly={validateOnly}	Add log
PUT Setup/Log/{logID}?validateOnly={validateOnly}	Update log
DELETE Setup/Log/{logID}	Delete log

ClientBusinessUnit

API	Description
GET Clients/BusinessUnit	Get clientBusinessUnits from criteria
GET Clients/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty clientBusinessUnit
GET Clients/BusinessUnit/{clientID}/{bUID}	Get clientBusinessUnit
POST Clients/BusinessUnit?validateOnly={validateOnly}	Add clientBusinessUnit
PUT Clients/BusinessUnit/{clientID}/{bUID}?validateOnly={validateOnly}	Update clientBusinessUnit
DELETE Clients/BusinessUnit/{clientID}/{bUID}/{purge}	Delete clientBusinessUnit
PUT Clients/BusinessUnit/UpdateCurrentStatus	Update clientBusinessUnit with active clientBusinessUnitStatuses

Statement

Statements Batch Controller

API	Description
GET Statements/Statement	Get Statement from criteria
GET Statements/Statement/Initialize	Get empty Statement
GET Statements/Statement/{statementID}	Get Statement
GET Statements/Statement/{statementID}/pdf	Get Statement PDF
POST Statements/Statement?validateOnly={validateOnly}	Add Statement
PUT Statements/Statement/{statementID}?validateOnly={validateOnly}	Update Statement
PUT Statements/Statement/{StatementID}/regenerate	Regenerate Statement
PUT Statements/Statement/{StatementID}/email	Send statement email
DELETE Statements/Statement/{statementID}/{purge}	Delete Statement

GroupBusinessUnit

API	Description
GET Groups/BusinessUnit	Get groupBusinessUnits from criteria
GET Groups/BusinessUnit/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty groupBusinessUnit
GET Groups/BusinessUnit/{groupID}/{bUID}	Get groupBusinessUnit
PUT Groups/BusinessUnit/{groupID}/{bUID}?validateOnly={validateOnly}	Update groupBusinessUnit
DELETE Groups/BusinessUnit/{groupID}/{bUID}/{purge}	Delete groupBusinessUnit

WorkerRelationship

API	Description
GET Workers/Relationship	Get workerRelationships from criteria
GET Workers/Relationship/Initialize	Get empty workerRelationship
GET Workers/Relationship/{workerRelationshipID}	Get workerRelationship
POST Workers/Relationship?validateOnly={validateOnly}	Add workerRelationship
PUT Workers/Relationship/{workerRelationshipID}?validateOnly={validateOnly}	Update workerRelationship
DELETE Workers/Relationship/{workerRelationshipID}/{purge}	Delete workerRelationship

EventShiftCode

API	Description
GET Events/ShiftCode	Get eventShiftCodes from criteria
GET Events/ShiftCode/Initialize?BUID={BUID}	Get empty eventShiftCode
GET Events/ShiftCode/{eventShiftCodeID}	Get eventShiftCode
POST Events/ShiftCode?validateOnly={validateOnly}	Add eventShiftCode
PUT Events/ShiftCode/{eventShiftCodeID}?validateOnly={validateOnly}	Update eventShiftCode
DELETE Events/ShiftCode/{eventShiftCodeID}/{purge}	Delete eventShiftCode

EntityEventTemplateDetail

API	Description
GET Events/EntityTemplateDetail	Get entityEventTemplateDetails from criteria
GET Events/EntityTemplateDetail/Initialize	Get empty entityEventTemplateDetail
GET Events/EntityTemplateDetail/{entityEventTemplateDetailID}	Get entityEventTemplateDetail
POST Events/EntityTemplateDetail?validateOnly={validateOnly}	Add entityEventTemplateDetail
PUT Events/EntityTemplateDetail/{entityEventTemplateDetailID}?validateOnly={validateOnly}	Update entityEventTemplateDetail
DELETE Events/EntityTemplateDetail/{entityEventTemplateDetailID}/{purge}	Delete entityEventTemplateDetail

StatementBatch

Statements Batch Controller

API	Description
GET Statements/StatementBatch	Get StatementBatch from criteria
GET Statements/StatementBatch/Initialize	Get empty StatementBatch
GET Statements/StatementBatch/{statementBatchID}?batchPdfType={batchPdfType}	Get StatementBatch
POST Statements/StatementBatch/generatePdf	Initiate the asynchronous generation of Statement Batch combined PDF
POST Statements/StatementBatch/{statementBatchID}/email	Trigger sending statement emails for the batch.
POST Statements/StatementBatch?validateOnly={validateOnly}	Add StatementBatch
PUT Statements/StatementBatch/{statementBatchID}?validateOnly={validateOnly}	Update StatementBatchBatch
DELETE Statements/StatementBatch/{statementBatchID}/{purge}	Delete StatementBatch

AllergyTable

API	Description
GET Setup/AllergyTable	Get allergyTables from criteria
GET Setup/AllergyTable/Initialize?BUID={BUID}	Get empty allergyTable
GET Setup/AllergyTable/{allergyTableID}	Get allergyTable
POST Setup/AllergyTable?validateOnly={validateOnly}	Add allergyTable
PUT Setup/AllergyTable/{allergyTableID}?validateOnly={validateOnly}	Update allergyTable
DELETE Setup/AllergyTable/{allergyTableID}/{purge}	Delete allergyTable

WorkerBusinessUnitRole

API	Description
GET Workers/Role	Get WorkerBusinessUnitRoles from criteria
GET Workers/Role/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty WorkerBusinessUnitRole
GET Workers/Role/{entityBusinessUnitRoleID}	Get WorkerBusinessUnitRole
POST Workers/Role?validateOnly={validateOnly}	Add WorkerBusinessUnitRole
PUT Workers/Role/{entityBusinessUnitRoleID}?validateOnly={validateOnly}	Update WorkerBusinessUnitRole
DELETE Workers/Role/{entityBusinessUnitRoleID}/{purge}	Delete WorkerBusinessUnitRole

ClientGroup

API	Description
GET Clients/Group	Get clientGroups from criteria
GET Clients/Group/Initialize?BUID={BUID}&EntityID={EntityID}	Get empty clientGroup
GET Clients/Group/{clientID}/{bUID}/{groupID}	Get clientGroup
POST Clients/Group?validateOnly={validateOnly}	Add clientGroup
PUT Clients/Group/{clientID}/{bUID}/{groupID}?validateOnly={validateOnly}	Update clientGroup
DELETE Clients/Group/{clientID}/{bUID}/{groupID}/{purge}	Delete clientGroup
PUT Clients/Group/UpdateCurrentStatus	Update clientGroup with active clientGroupStatuses

AttendanceTypeBusinessUnitStatus

API	Description
GET Setup/AttendanceType/BusinessUnitStatus	Get AttendanceTypeBusinessUnitStatuses from criteria
GET Setup/AttendanceType/BusinessUnitStatus/Initialize?EntityID={EntityID}&BUID={BUID}	Get empty AttendanceTypeBusinessUnitStatus
GET Setup/AttendanceType/BusinessUnitStatus/{statusID}	Get AttendanceTypeBusinessUnitStatus
POST Setup/AttendanceType/BusinessUnitStatus	Add AttendanceTypeBusinessUnitStatus
PUT Setup/AttendanceType/BusinessUnitStatus/{statusID}	Update AttendanceTypeBusinessUnit
DELETE Setup/AttendanceType/BusinessUnitStatus/{statusID}/{purge}	Delete AttendanceTypeBusinessUnitStatus

RoleBusinessUnit

API	Description
GET Setup/RoleBusinessUnit	Get roleBusinessUnits from criteria
GET Setup/RoleBusinessUnit/Initialize?BUID={BUID}&RoleID={RoleID}	Get empty roleBusinessUnit
GET Setup/RoleBusinessUnit/{bUID}/{roleID}	Get roleBusinessUnit
POST Setup/RoleBusinessUnit?validateOnly={validateOnly}	Add roleBusinessUnit
PUT Setup/RoleBusinessUnit/{bUID}/{roleID}?validateOnly={validateOnly}	Update roleBusinessUnit
DELETE Setup/RoleBusinessUnit/{bUID}/{roleID}/{purge}	Delete roleBusinessUnit

WorkflowGroupBusinessUnit

API	Description
GET Workflows/GroupBusinessUnit	Get WorkflowGroupBusinessUnits from criteria
GET Workflows/GroupBusinessUnit/Initialize	Get empty WorkflowGroupBusinessUnit
GET Workflows/GroupBusinessUnit/{workflowID}/{bUID}/{groupID}	Get WorkflowGroupBusinessUnit
POST Workflows/GroupBusinessUnit?validateOnly={validateOnly}	Add WorkflowGroupBusinessUnit
PUT Workflows/GroupBusinessUnit/{workflowID}/{bUID}/{groupID}?validateOnly={validateOnly}	Update WorkflowGroupBusinessUnit
DELETE Workflows/GroupBusinessUnit/{workflowID}/{bUID}/{groupID}/{purge}	Delete WorkflowGroupBusinessUnit

GroupCommunicationMethod

API	Description
GET Groups/CommunicationMethod	Get groupCommunicationMethods from criteria
GET Groups/CommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}	Get empty groupCommunicationMethod
GET Groups/CommunicationMethod/{communicationMethodID}	Get groupCommunicationMethod
POST Groups/CommunicationMethod?validateOnly={validateOnly}	Add groupCommunicationMethod
PUT Groups/CommunicationMethod/{communicationMethodID}?validateOnly={validateOnly}	Update groupCommunicationMethod
DELETE Groups/CommunicationMethod/{communicationMethodID}/{purge}	Delete groupCommunicationMethod

ContactRelationship

API	Description
GET Contacts/Relationship	Get contactRelationships from criteria
GET Contacts/Relationship/Initialize	Get empty contactRelationship
GET Contacts/Relationship/{contactRelationshipID}	Get contactRelationship
POST Contacts/Relationship?validateOnly={validateOnly}	Add contactRelationship
PUT Contacts/Relationship/{contactRelationshipID}?validateOnly={validateOnly}	Update contactRelationship
DELETE Contacts/Relationship/{contactRelationshipID}/{purge}	Delete contactRelationship
POST Contacts/Relationship/{formID}/updateExtensions	Update form extension

FormBinaryViaKey

API	Description
GET Forms/Binary/ViaKey/{key}/{resultAsBase64}	No documentation available.

Payment

Payment Controller

API	Description
GET Payments/Payment	Get Payment from criteria
POST Payments/Payment/{paymentID}/PaymentInvoice	Get Payment Invoice from criteria
GET Payments/Payment/{paymentID}	Get Payment
GET Payments/Payment/Initialize?PaymentMethod={PaymentMethod}	Get empty Payment
POST Payments/Payment?validateOnly={validateOnly}	Add Payment
POST Payments/Payment/GenerateItems?validateOnly={validateOnly}	Add Payment and generate Payment Items from Direct Debit Invoices property
PUT Payments/Payment/{paymentID}?validateOnly={validateOnly}	Update Payment
PUT Payments/Payment/{paymentID}/GenerateItems?validateOnly={validateOnly}	Update Payment and generate Payment Items from Direct Debit Invoices property
POST Payments/Payment/PaymentPlanInstallments	No documentation available.
POST Payments/Payment/RecalculatePaymentPlansInstallments	No documentation available.
POST Payments/Payment/RecalculateClientsInstallmentsAmounts	No documentation available.
POST Payments/Payment/PaymentSummary	No documentation available.
POST Payments/Payment/{paymentID}/PostTransactionForPayment	No documentation available.
DELETE Payments/Payment/{paymentID}/{purge}	Delete Payment

Report

API	Description
GET Reports/Report	Get reports
GET Reports/Report/{reportID}	No documentation available.
PUT Reports/Report/{reportID}?favorite={favorite}	Updates report favorite

BusinessUnitAddress

API	Description
GET Setup/BusinessUnitAddress	Get businessUnitAddress from criteria
GET Setup/BusinessUnitAddress/Initialize	Get empty businessUnitAddress
GET Setup/BusinessUnitAddress/{addressID}	Get businessUnitAddress
POST Setup/BusinessUnitAddress?validateOnly={validateOnly}	Add businessUnitAddress
PUT Setup/BusinessUnitAddress/{addressID}?validateOnly={validateOnly}	Update businessUnitAddress
DELETE Setup/BusinessUnitAddress/{addressID}/{purge}	Delete businessUnitAddress

BillingMedicareEBusiness

API	Description
GET Billings/MedicareEBusiness	Get MedicareEBusinesss
GET Billings/MedicareEBusiness/Initialize?IncludeDetail={IncludeDetail}	Get empty MedicareEBusiness
GET Billings/MedicareEBusiness/{eventID}	Get MedicareEBusiness
POST Billings/MedicareEBusiness?validateOnly={validateOnly}	Add MedicareEBusiness
PUT Billings/MedicareEBusiness/{eventID}?validateOnly={validateOnly}	Update MedicareEBusiness
DELETE Billings/MedicareEBusiness/{eventID}/{purge}	Delete MedicareEBusiness
POST Billings/MedicareEBusiness/{eventID}/Sign	Delete MedicareEBusiness
POST Billings/MedicareEBusiness/{eventID}/Send	Delete MedicareEBusiness

FormFieldLink

API	Description
GET Forms/FieldLink	Get formFieldLinks from criteria
GET Forms/FieldLink/Initialize?FieldID={FieldID}&FormID={FormID}	Get empty formFieldLink
GET Forms/FieldLink/{formFieldLinkID}	Get formFieldLink
POST Forms/FieldLink?validateOnly={validateOnly}	Add formFieldLink
PUT Forms/FieldLink/{formFieldLinkID}?validateOnly={validateOnly}	Update formFieldLink
DELETE Forms/FieldLink/{formFieldLinkID}/{purge}/{includeDuplicateLinks}	Delete formFieldLink
PUT Forms/FieldLink/{formFieldLinkID}/Move/{afterFormFieldLinkID}/{sectionID}	Update formFieldLink

Visit

API	Description
GET Events/Visit	Get events from criteria
GET Events/Visit/Initialize?BUID={BUID}&PrimaryServiceReceiverEntityID={PrimaryServiceReceiverEntityID}&PrimaryServiceProviderEntityID={PrimaryServiceProviderEntityID}&PrimaryGroupEntityID={PrimaryGroupEntityID}&EventSubType={EventSubType}&StartDateUtc={StartDateUtc}&StopDateUtc={StopDateUtc}&StartDateDays={StartDateDays}&StartTime={StartTime}&StopDateDays={StopDateDays}&StopTime={StopTime}&NotifyDateDays={NotifyDateDays}&NotifyTime={NotifyTime}	Get empty event
GET Events/Visit/{eventID}	Get event
POST Events/Visit?validateOnly={validateOnly}	Add event
POST Events/Visit/Generate?EventID={EventID}&GenerationDateUtcMin={GenerationDateUtcMin}&GenerationDateUtcMax={GenerationDateUtcMax}&SupressReturn={SupressReturn}	Generate visits
PUT Events/Visit/{eventID}?validateOnly={validateOnly}	Update event
DELETE Events/Visit/{eventID}/{purge}	Delete event

SyncPackage

API	Description
GET Setup/SyncPackage	Get syncPackages from criteria
GET Setup/SyncPackage/Initialize	Get empty syncPackage
GET Setup/SyncPackage/{syncPackageID}	Get syncPackage
POST Setup/SyncPackage?validateOnly={validateOnly}	Add syncPackage
PUT Setup/SyncPackage/{syncPackageID}?validateOnly={validateOnly}	Update syncPackage
DELETE Setup/SyncPackage/{syncPackageID}/{purge}	Delete syncPackage