Invoice item types

An invoice or credit note. Invoices are raised against service users and typically cover the cost of care or service users.

Endpoints

The invoice item type object

Attributes

  • _id
    string

    A unique Id for the invoice item type code.

  • created
    string

    The date/time the invoice item type was created.

  • description
    string

    A description to help users select the relevant item type.

  • invoice_line_item_description
    string

    An optional description that will be included in invoice line items generated for this invoice item type.

  • modified
    string

    The date/time the invoice item type was modified.

  • nominal_code
    string

    The default nominal code for invoice items of this type.

  • tax_rate
    string

    The default tax rate for invoice items of this type.

  • use_for_funding_types
    list of strings

    A list of funding/contribution types that this invoice item type is the default for (when setting up a billing contract the invoice item type will for the contract will by default be set based on the selected contribution type based on this relationship).

The invoice item type object 
{
    "_id": "6724fbc74f73a2cebf6377ee",
    "created": "2024-11-01 16:03:19",
    "description": "Care fees",
    "invoice_line_item_description": "Care fees",
    "modified": "2024-11-01 16:03:19",
    "nominal_code": "6724fbc74f73a2cebf637706",
    "tax_rate": "6724fbc74f73a2cebf63770c",
    "use_for_funding_types": [
        "local_authority",
        "contribution",
        "fnc",
        "fpc",
        "chc",
        "top_up",
        "lifestyle",
        "block_bed"
    ]
}

List all invoice item types

Return a list of invoice item types setup for your account on CareHQ.

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-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; description.

  • 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
    • description
    • modified

Response

Returns a page of invoice item types.

GET
/v1/invoice-item-types
var invoiceItemTypes = apiClient.Request(
    HttpMethod.Get,
    "invoice-item-types",
    new MultiValueDict()
        .Add("attributes", "description")
);

<?php

$invoice_item_types = $api_client->request(
    'GET',
    'invoice-item-types',
    [
        'attributes'=>['description']
    ]
);

invoice_item_types = api_client(
    'GET',
    'invoice-item-types',
    params={
        'attributes': ['description']
    }
)

invoice_item_types = api_client.request(
    'GET',
    'invoice-item-types',
    params: {
        'attributes' => ['description']
    }
)
Response 
{
    "item_count": 2,
    "items": [
        {
            "_id": "6724fbc74f73a2cebf6377ee",
            "description": "Care fees"
        },
        {
            "_id": "6724fbc74f73a2cebf6377f0",
            "description": "Expenses"
        }
    ],
    "page": 1,
    "page_count": 1,
    "per_page": 10
}

Retrieve an invoice item type

Retrieve an invoice item type object.

Response

Returns a invoice item type object.

GET
/v1/invoice-item-types/<invoice_item_type_id>
var invoiceItemType = apiClient.Request(
    HttpMethod.Get,
    $"invoice-item-types/{invoiceItemTypeId}"
);

<?php

$invoice_item_type = $api_client->request(
    'GET',
    'invoice-item-types/' . $invoice_item_type_id
);

invoice_item_type = api_client(
    'GET',
    f'invoice-item-types/{invoice_item_type_id}')

invoice_item_type = api_client.request(
    'GET',
    "invoice-item-types/#{invoice_item_type_id}"
)
Response 
{
    "_id": "6724fbc74f73a2cebf6377ee",
    "created": "2024-11-01 16:03:19",
    "description": "Care fees",
    "invoice_line_item_description": "Care fees",
    "modified": "2024-11-01 16:03:19",
    "nominal_code": "6724fbc74f73a2cebf637706",
    "tax_rate": "6724fbc74f73a2cebf63770c",
    "use_for_funding_types": [
        "local_authority",
        "contribution",
        "fnc",
        "fpc",
        "chc",
        "top_up",
        "lifestyle",
        "block_bed"
    ]
}