GET /agreements
Retrieves all client agreements.Default limit is 200 items if not specified.
GET /agreements?fromDate=2023-01-01&toDate=2023-12-31&limit=10000&includeItems=TRUE
Parameters:
| Parameter | Default | Description |
|---|---|---|
limit | 200 | Number of items to return |
page | 0 | Pagination offset (skips N records) |
fromDate | - | Agreements with start date >= value. Format: YYYY-MM-DD |
toDate | - | Agreements with end date <= value. Format: YYYY-MM-DD |
payerId | - | Filter by payer ID |
clientId | - | Filter by client ID |
area | - | Filter by area |
includeItems | - | If TRUE, returns all AgreementItems for each agreement |
| Field | Type | Notes |
|---|---|---|
AgreementId | integer | |
AgreementType | string | |
ClientId | integer | |
PayerId | integer | |
ChargeLevel | integer | |
MMMLevel | integer | |
AgreementCode | string | |
Reference | string | |
Reference2 | string | |
Reference3 | string | |
StartDate | string | Date |
EndDate | string | Date |
AlertDate | string | Date |
Current | integer | 0/1 |
GST | integer | 0/1 |
Area | string | |
ZoneId | integer | |
IncomeType | integer | |
conDVAZone | string | |
conDVAServicePlanNo | integer | |
conHeadContractId | integer | |
DVASXNo | string | |
DVAPlanId | string | |
Status | string | |
AllowAdHoc | integer | 0/1 |
RatesOverride | integer | 0/1 |
RatesOverrideCharge | integer | 0/1 |
Budget | string | Decimal |
BudgetPeriod | string | e.g. "FORTNIGHTLY" |
BudgetHour | integer | |
KM | integer | |
KmPayer | integer | |
KmPayerId | integer | |
KmToTime | integer | |
KmChargeOverride | integer | |
KmChargeCode | string | |
KMChargeNDIS | string | |
KmOverrideChargeRate | string | Decimal |
ExclPh | integer | 0/1 |
NDISActivityType | string | e.g. "ROSTER" |
NDISMgnt | string | e.g. "AGENCY" |
NDISPlanId | string | |
IsClosed | integer | 0/1 |
CHSPPayer | string | |
Note | string | |
_LastModTime | string | Datetime |
_LastModUser | string | |
_CreateTime | string | Datetime |
_CreateUser | string |
includeItems=TRUE):
| Field | Type | Notes |
|---|---|---|
AgreementItemId | integer | |
AgreementId | integer | |
ServiceId | integer | |
ChargeRate | float | |
PayRate | integer | |
CHSPRate | integer | |
CHSPType | string | e.g. "UNIT" |
CHSPPayrollCode | null/string | |
DEXCaseId | integer | |
DEXServiceTypeId | integer | |
DVAPeriodCode | integer | |
Quantity | integer | |
Unit | string | |
Period | null/string | |
PeriodTotal | integer | |
BudgetAmount | integer | |
BudgetHours | integer | |
Comments | null/string | |
ListId | integer | |
Timestamp | null/string | |
GST | integer | 0/1 |
Ratio | float |