Location contact departments

A department within a location contact.

The location contact department object

Attributes

  • _id
    string

    A unique Id for the location contact department.

  • billing_comms_preference
    list of strings

    The billing party's preference for receiving billing related commsemail, post, do_not_send.

  • billing_enabled
    boolean

    A flag indiciating if billing is enabled for the location contact department.

  • billing_fao
    string

    A reference (such as an XX reference), person or company that invoices for this department should be flagged as for the attention of (FAO).

  • created
    string

    The date/time the location contact department was created.

  • email
    string

    The location contact department's primary email address.

  • email_invoices_to
    list of strings

    A list of email addresses to send invoices (and related documents) to.

  • future_billing_disabled
    boolean

    A flag indicating that while billing is enabled for the location contact depatment they cannot appear as an option for new contracts or invoices.

  • location_contact
    string

    The Id of the location contact this department relates to.

  • locations
    list of strings

    A list of locations the location contact department relates to.

  • modified
    string

    The date/time the location contact department was created.

  • name
    string

    The name of the location contact department.

  • notes
    string

    Additional notes for the location contact department.

  • payment_method
    string

    The method the billing party is expected to use for making paymentscard, cash, cheque, standing_order, direct_debit, bac.

  • phone
    string

    The location contact department's phone number.

  • postal_address
    hash

    The location contact department's postal address.

    • postal_address.address_1
      string

      Address line 1 (e.g. house name/number).

    • postal_address.address_2
      string

      Address line 2 (e.g. street).

    • postal_address.town
      string

      Town, city or village.

    • postal_address.county
      string

      County.

    • postal_address.postcode
      string

      Postal code.

    • postal_address.country
      string

      Country.

The location contact department object
{
    "_id": "6a56c6c169209a7d72be9c34",
    "billing_comms_preference": null,
    "billing_enabled": true,
    "billing_fao": "10Q",
    "created": "2026-07-14 23:31:13",
    "email": "billing@ouh.nhs.uk",
    "email_invoices_to": null,
    "future_billing_disabled": null,
    "location_contact": "6a56c6c169209a7d72be9c26",
    "locations": [
        "6a56c6c169209a7d72be9bfe"
    ],
    "modified": "2026-07-14 23:31:13",
    "name": "Oxfordshire",
    "notes": "Previously Oxfordshire CCG",
    "payment_method": null,
    "phone": "01865 223493",
    "postal_address": {
        "address_1": "",
        "address_2": "",
        "country": "",
        "county": "",
        "postcode": "",
        "town": ""
    }
}

List all location contact departments

Return a list of location contact departments.

Parameters

  • attributes
    optional
    default ['_id']

    A list of attributes to include for fetched objects.

  • filters-ids
    optional

    A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.

  • filters-location
    optional

    A filter that accepts a list of location Ids and filters location contact departments by the location they relate to.

  • filters-location_contact
    optional

    A filter that accepts a list of location contact Ids and filters location contact departments by the location contact they relate to.

  • filters-modified_after
    optional

    A filter that accepts a date/time and filters the items returned to those modified after the date/time.

  • filters-modified_before
    optional

    A filter that accepts a date/time and filters the items returned to those modified before the date/time.

  • filters-q
    optional

    A case insensitive keyword filter applied to the following fields; billing_fao, name.

  • page
    optional
    default 1

    The page number to fetch.

  • per_page
    optional
    default 10

    The number of items to return per page.

  • sort_by
    optional
    default _id

    A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.

    • _id
    • created
    • modified
    • name

Response

Returns a page of location contact departments.

GET
/v1/location-contact-departments
var locationContactDepartments = apiClient.Request(
    HttpMethod.Get,
    "location-contact-departments",
    new MultiValueDict()
        .Add("attributes", "billing_fao", "name")
        .Add("filters-location", locationId)
);
const locationContactDepartments = await apiClient.request(
    "GET",
    "location-contact-departments",
    {
        "params": {
            "attributes": ["billing_fao", "name"],
            "filters-location": [locationId]
        }
    }
)
<?php

$location_contact_departments = $api_client->request(
    'GET',
    'location-contact-departments',
    [
        'attributes'=>['billing_fao', 'name'],
        'filters-location'=>[location_id]
    ]
);
location_contact_departments = api_client(
    'GET',
    'location-contact-departments',
    params={
        'attributes': ['billing_fao', 'name'],
        'filters-location': [location_id]
    }
)
location_contacts_departments = api_client.request(
    'GET',
    'location-contact-departments',
    params: {
        'attributes' => ['billing_fao', 'name'],
        'filters-location' => [location_id]
    }
)
Response
{
    "item_count": 0,
    "items": [],
    "page": 1,
    "page_count": 1,
    "per_page": 10
}

Retrieve a location contact department

Retreive a location contact department object.

Response

Returns a location contact department object.

GET
/v1/location-contact-departments/<location_contact_department_id>
var locationContactDepartment = apiClient.Request(
    HttpMethod.Get,
    $"location-contact-departments/{locationContactDepartmentId}"
);
const locationContactDepartment = await apiClient.request(
    "GET",
    `location-contact-departments/${locationContactDepartmentId}`
)
<?php

$location_contact_department = $api_client->request(
    'GET',
    'location-contact-departments/' . $location_contact_department_id
);
location_contact_department = api_client(
    'GET',
    f'location-contact-departments/{location_contact_department_id}'
)
location_contact_department = api_client.request(
    'GET',
    "location-contact-departments/#{location_contact_department_id}"
)
Response
{
    "_id": "6a56c6c169209a7d72be9c34",
    "billing_comms_preference": null,
    "billing_enabled": true,
    "billing_fao": "10Q",
    "created": "2026-07-14 23:31:13",
    "email": "billing@ouh.nhs.uk",
    "email_invoices_to": null,
    "future_billing_disabled": null,
    "location_contact": "6a56c6c169209a7d72be9c26",
    "locations": [
        "6a56c6c169209a7d72be9bfe"
    ],
    "modified": "2026-07-14 23:31:13",
    "name": "Oxfordshire",
    "notes": "Previously Oxfordshire CCG",
    "payment_method": null,
    "phone": "01865 223493",
    "postal_address": {
        "address_1": "",
        "address_2": "",
        "country": "",
        "county": "",
        "postcode": "",
        "town": ""
    }
}