A location such as a care home or an office from which home care is provided.
A unique Id for the location.
Flag indicating that the location accepts service users with dementia.
The VMN (virtual mobile number) for the location.
The Id of the brands the location falls under. If not set the location will use the account brand.
The name of the company running the location. If not set the account company name is used. This field appears on emails invoices and statements.
The registration number for the company running the location. If not set the account company registration number is used. This field appears on emails invoices and statements.
The date/time the location was created.
An email address for the location. This will appear on emails and documents (such as invoices).
A list of location groups that the location belongs to.
The default payment instructions included at the bottom of invoices for this location when either no payment method is defined for the billing party or no instructions are defined for the payment method.
The payment instructions included at the bottom of invoices for BAC payments for this location.
The payment instructions included at the bottom of invoices for card payments for this location.
The payment instructions included at the bottom of invoices for cash payments for this location.
The payment instructions included at the bottom of invoices for cheque payments for this location.
The payment instructions included at the bottom of invoices for direct debit payments for this location.
The payment instructions included at the bottom of invoices for standing order payments for this location.
The address that will appear on invoices for the location, if not set the locations street address will be used.
Address line 1 (e.g. house name/number).
Address line 2 (e.g. street).
Town, city or village.
County.
Postal code.
Country.
The email address that will appear on invoices for the location, if not set the locations street address will be used.
The geographical coordinates of the location in longitude and latitude.
The date/time the location was created.
The name of the location.
Flag indicating that the location offers day care for service users.
Flag indicating that the location offers respite stays for service users.
A phone number for the location. This will appear on emails and documents (such as invoices).
The reason for the location's suspension (if suspended).
A settable unique reference for the location.
The user actions regarding service user expense billing for this location are assigned to.
The rule for determining when an invoice for service user expenses will fall due;day_current_month, day_following_month, days_after_invoice_date, days_after_invoice_month.
The day or number of days from the date of invoice after which an invoice for service user expenses is due.
The day of the month when invoices for service user expenses are typically raised.
Flag indicating that invoicing of service user expenses is enabled for this location.
The tax rate set for any invoice line item raised for service user expenses.
A list of services the location supports: assisted_living, residential_home, nursing_home, learning_disability_care, bariatric_care, specialist_care, home_care, live_in_care.
The street (geographical) address for the location, see Address.
Address line 1 (e.g. house name/number).
Address line 2 (e.g. street).
Town, city or village.
County.
Postal code.
Country.
The date/time the location was suspended (if suspended).
The VAT number for the company running the location. If not set the account VAT number is used. This field appears on emails invoices and statements.
The URL of the location's website. This will appear on emails and documents (such as invoices).
{
"_id": "6724fbc74f73a2cebf6377fa",
"accepts_dementia": true,
"app_number": "+447380307491",
"brand": null,
"company_name": null,
"company_reg_no": null,
"created": "2024-11-01 16:03:19",
"email": "douglascourt@marshallcare.co.uk",
"groups": [
"6724fbc74f73a2cebf6377ec"
],
"invoice_payment_instructions": "Bank transfers should be made to Account Holder: Marshall Care, Douglas court / Sort code: 00-00-00 / Account No. 00000000",
"invoice_payment_instructions_bac": null,
"invoice_payment_instructions_card": null,
"invoice_payment_instructions_cash": null,
"invoice_payment_instructions_cheque": null,
"invoice_payment_instructions_direct_debit": null,
"invoice_payment_instructions_standing_order": null,
"invoicing_address": {
"address_1": "",
"address_2": "",
"country": "",
"county": "",
"postcode": "",
"town": ""
},
"invoicing_email": null,
"lon_lat": [
-0.9075,
51.7
],
"modified": "2024-11-01 16:03:19",
"name": "Douglas Court",
"offers_daycare": null,
"offers_respite": true,
"phone": "01865 680331",
"reason_for_suspension": null,
"ref": null,
"service_user_expenses_assigned_to": "6724fbc74f73a2cebf637800",
"service_user_expenses_invoices_due_rule": "days_after_invoice_date",
"service_user_expenses_invoices_due_unit": 7,
"service_user_expenses_invoicing_day": 1,
"service_user_expenses_invoicing_enabled": true,
"service_user_expenses_tax_rate": "6724fbc74f73a2cebf63770c",
"services": [
"residential_home",
"nursing_home"
],
"street_address": {
"address_1": "Douglas Court",
"address_2": "Station Road",
"country": "",
"county": "Oxfordshire",
"postcode": "OX39 4HA",
"town": "Chinnor"
},
"suspended": null,
"vat_number": null,
"website_url": "https://marshallcare.co.uk/douglas-court"
}
Return a list of CareHQ locations (care homes and home care offices) for your organisation.
['_id']
A list of attributes to include for fetched objects.
unset
A filter that allows locations to be filtered by whether they accept dementia service users or not.
A filter that accepts a list of brand Ids and filters locations by the brand they are assigned.
A filter that accepts a list of location group (Group) Ids and filters locations by the group they belong to.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
unset
A filter that allows locations to be filtered by whether they offer respite or not.
A case insensitive keyword filter applied to the following fields; name, ref.
A filter that accepts a list of services a location can offer and filters locations by the services they offer.
no
A filter that allows locations that are currently suspended to be included or excluded.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of locations.
var locations = apiClient.Request(
HttpMethod.Get,
"locations",
new MultiValueDict()
.Add("attributes", "name")
.Add("filters-services", "residential_home")
);
<?php
$locations = $api_client->request(
'GET',
'locations',
[
'attributes'=>['name'],
'filters-services'=>['residential_home']
]
);
locations = api_client(
'GET',
'locations',
params={
'attributes': ['name'],
'filters-services': ['residential_home']
}
)
locations = api_client.request(
'GET',
'locations',
params: {
'attributes' => ['name'],
'filters-services' => ['residential_home']
}
)
{
"item_count": 2,
"items": [
{
"_id": "6724fbc74f73a2cebf6377fa",
"name": "Douglas Court"
},
{
"_id": "6724fbc74f73a2cebf6377fc",
"name": "Upton House"
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
Retreive a location (care home or home care office) object.
Returns a location object.
var location = apiClient.Request(HttpMethod.Get, $"locations/{locationId}");
<?php
$location = $api_client->request(
'GET',
'locations/' . $location_id
);
location = api_client('GET', f'locations/{location_id}')
location = api_client.request('GET', "locations/#{location_id}")
{
"_id": "6724fbc74f73a2cebf6377fa",
"accepts_dementia": true,
"app_number": "+447380307491",
"brand": null,
"company_name": null,
"company_reg_no": null,
"created": "2024-11-01 16:03:19",
"email": "douglascourt@marshallcare.co.uk",
"groups": [
"6724fbc74f73a2cebf6377ec"
],
"invoice_payment_instructions": "Bank transfers should be made to Account Holder: Marshall Care, Douglas court / Sort code: 00-00-00 / Account No. 00000000",
"invoice_payment_instructions_bac": null,
"invoice_payment_instructions_card": null,
"invoice_payment_instructions_cash": null,
"invoice_payment_instructions_cheque": null,
"invoice_payment_instructions_direct_debit": null,
"invoice_payment_instructions_standing_order": null,
"invoicing_address": {
"address_1": "",
"address_2": "",
"country": "",
"county": "",
"postcode": "",
"town": ""
},
"invoicing_email": null,
"lon_lat": [
-0.9075,
51.7
],
"modified": "2024-11-01 16:03:19",
"name": "Douglas Court",
"offers_daycare": null,
"offers_respite": true,
"phone": "01865 680331",
"reason_for_suspension": null,
"ref": null,
"service_user_expenses_assigned_to": "6724fbc74f73a2cebf637800",
"service_user_expenses_invoices_due_rule": "days_after_invoice_date",
"service_user_expenses_invoices_due_unit": 7,
"service_user_expenses_invoicing_day": 1,
"service_user_expenses_invoicing_enabled": true,
"service_user_expenses_tax_rate": "6724fbc74f73a2cebf63770c",
"services": [
"residential_home",
"nursing_home"
],
"street_address": {
"address_1": "Douglas Court",
"address_2": "Station Road",
"country": "",
"county": "Oxfordshire",
"postcode": "OX39 4HA",
"town": "Chinnor"
},
"suspended": null,
"vat_number": null,
"website_url": "https://marshallcare.co.uk/douglas-court"
}