An invoice or credit note. Invoices are raised against service users and typically cover the cost of care or service users.
A unique Id for the invoice item type code.
The date/time the invoice item type was created.
A description to help users select the relevant item type.
An optional description that will be included in invoice line items generated for this invoice item type.
The date/time the invoice item type was modified.
The default nominal code for invoice items of this type.
The default tax rate for invoice items of this type.
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).
{
"_id": "66bfb4bb9ab4e3d6eb7348fc",
"created": "2024-08-16 20:21:15",
"description": "Care fees",
"invoice_line_item_description": "Care fees",
"modified": "2024-08-16 20:21:15",
"nominal_code": "66bfb4bb9ab4e3d6eb734816",
"tax_rate": "66bfb4bb9ab4e3d6eb73481c",
"use_for_funding_types": [
"local_authority",
"contribution",
"fnc",
"fpc",
"chc",
"top_up",
"lifestyle",
"block_bed"
]
}
Return a list of invoice item types setup for your account on CareHQ.
['_id']
A list of attributes to include for fetched objects.
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.
A case insensitive keyword filter applied to the following fields; description.
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 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']
}
)
{
"item_count": 2,
"items": [
{
"_id": "66bfb4bb9ab4e3d6eb7348fc",
"description": "Care fees"
},
{
"_id": "66bfb4bb9ab4e3d6eb7348fe",
"description": "Expenses"
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
Retrieve an invoice item type object.
Returns a invoice item type object.
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}"
)
{
"_id": "66bfb4bb9ab4e3d6eb7348fc",
"created": "2024-08-16 20:21:15",
"description": "Care fees",
"invoice_line_item_description": "Care fees",
"modified": "2024-08-16 20:21:15",
"nominal_code": "66bfb4bb9ab4e3d6eb734816",
"tax_rate": "66bfb4bb9ab4e3d6eb73481c",
"use_for_funding_types": [
"local_authority",
"contribution",
"fnc",
"fpc",
"chc",
"top_up",
"lifestyle",
"block_bed"
]
}