Quotes

GET /quotes

By default, quote line items are not included.

Example: GET /quotes?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100&includeItems=TRUE Query parameters:

Parameter	Default	Description
`limit`	200	Items per page
`page`	0	Pagination offset
`fromDate`	-	Quotes with `DateOfQuote` >= value. Format: `YYYY-MM-DD`
`toDate`	-	Quotes with `DateOfQuote` <= value. Format: `YYYY-MM-DD`
`payerId`	-	Filter by payer ID
`clientId`	-	Filter by client ID
`includeItems`	-	If `TRUE`, returns `QuoteLineItems`

Response fields:

Field	Type	Notes
`QuoteId`	integer
`ClientId`	integer
`PayerId`	integer
`FundingTypeId`	integer
`QuoteStatus`	string/null	for example `"pending"`, `"in_progress"`
`Finalised`	integer	0/1
`DateOfQuote`	string	Date
`FollowUpDate`	string	Date. `0000-00-00` when not set
`QuoteTotal`	number	Decimal
`QuoteTotalHours`	integer
`QuoteStart`	string	Date
`QuoteEnd`	string	Date
`FirstName`	string
`LastName`	string
`Address1`	string
`Address2`	string
`Subrub`	string	Typo in API - should be `Suburb`
`Postcode`	string
`State`	string
`Phone1`	string
`Email`	string
`DOB`	string	Date
`NDISNo`	string
`_CreateUser`	string
`_UpdateUser`	string	Email
`_UpdateComment`	string
`Status`	string

The quote object also returns funding and package fields that are not listed above, including QuoteType, FundType, ClientNumber, LocationId, Area, ApprovedBy, ApprovedClient, QuoteNote, MyAgedCareReference, NDIS fields (NDISActivityType, NDISMgnt, MMMLevel) and Support at Home fields (sah_living, sah_independence, sah_clinical, SAHRestorative, SAHEndOfLife, SAHAssistiveTechnology, SAHHomeModifications). Money values in these fields are returned as strings such as "0.00".

QuoteLineItems (when includeItems=TRUE):

Field	Type	Notes
`QuoteItemId`	integer
`QuoteId`	integer
`LineNo`	integer
`ServiceId`	integer
`Description`	string
`Price`	number	Decimal
`Quantity`	integer
`TotalQuantity`	integer
`Total`	number	Decimal
`Budget`	integer
`StartTime`	string	Time
`FreqTye`	string	Typo in API - should be `FreqType`. for example `"weekly"`
`FreqQty`	integer
`FreqDaysStr`	string	for example `"MO;WE;FR"`
`FreqDays`	array	for example `["MO", "WE", "FR"]`

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

GET /quotes

​GET /quotes

GET /quotes