Nominal codes are the codes that are used in the chart of accounts to record income and expenditure, they can be applied to line items in an invoice.
A unique Id for the nominal code.
The date/time the nominal code was created.
A description of the nominal code (e.g. Cleaning supplies).
The date/time the nominal code was modified.
A unique nominal code.
{
"_id": "66bfb4bb9ab4e3d6eb734816",
"created": "2024-08-16 20:21:15",
"description": "Sales",
"modified": "2024-08-16 20:21:15",
"nominal_code": "200"
}
Return a list of nominal codes 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, nominal_code.
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 nominal codes.
var nominalCodes = apiClient.Request(
HttpMethod.Get,
"nominal-codes",
new MultiValueDict()
.Add("attributes", "description")
);
<?php
$nominal_codes = $api_client->request(
'GET',
'nominal-codes',
[
'attributes'=>['description']
]
);
nominal_codes = api_client(
'GET',
'nominal-codes',
params={
'attributes': ['description']
}
)
nominal_codes = api_client.request(
'GET',
'nominal-codes',
params: {
'attributes' => ['description']
}
)
{
"item_count": 4,
"items": [
{
"_id": "66bfb4bb9ab4e3d6eb734810",
"description": "Accounts receivable"
},
{
"_id": "66bfb4bb9ab4e3d6eb734812",
"description": "Expenses"
},
{
"_id": "66bfb4bb9ab4e3d6eb734814",
"description": "Other revenue"
},
{
"_id": "66bfb4bb9ab4e3d6eb734816",
"description": "Sales"
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var nominalCode = apiClient.Request(
HttpMethod.Get,
$"nominal-codes/{nominalCodeId}"
);
<?php
$nominal_code = $api_client->request(
'GET',
'nominal-codes/' . $nominal_code_id
);
nominal_code = api_client('GET', f'nominal-codes/{nominal_code_id}')
nominal_code = api_client.request('GET', "nominal-codes/#{nominal_code_id}")
{
"_id": "66bfb4bb9ab4e3d6eb734816",
"created": "2024-08-16 20:21:15",
"description": "Sales",
"modified": "2024-08-16 20:21:15",
"nominal_code": "200"
}