A payment receipt (payment received) entry which can be reconciled against an invoice or overpayment.
A unique Id for the receipt.
The total amount of the receipt.
The bank account the receipt is associated with.
The amount of the receipt that has been clawed back.
The date/time the receipt was created.
A description of the receipt (e.g. Oxfordshire County Council ref).
Whether the receipt has been invalidated.
The location the receipt is associated with.
The location contact the payment was made by.
Whether the receipt is locked.
The date/time the receipt was modified.
The payee reference given (e.g. My Care Business Limited).
The payment method used for the receipt (e.g. Cash, Cheque).
A unique receipt number.
The date the payment was received
Whether the receipt has been reconciled.
A reference for the receipt.
The service user the payment was made by.
The service user contact the payment was made by.
{
"_id": "6932cdf13550e2b34494c26b",
"amount": 572228,
"bank_account": "6932cdf13550e2b34494c257",
"clawback_amount": 0,
"created": "2025-12-05 12:20:01",
"description": "P HOWARTH",
"invalidated": null,
"location": "6932cde23550e2b34494abad",
"location_contact": null,
"locked": false,
"modified": "2025-12-05 12:20:01",
"payee": "MARSHALL CARE LTD",
"payment_method": null,
"receipt_number": null,
"received_date": "2025-11-25",
"reconciled": false,
"reference": "INV-0001",
"service_user": null,
"service_user_contact": null
}
Return a list of receipts setup for your account on CareHQ.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a list of bank account Ids and filters receipts by the bank account they are associated with.
A filter that accepts a date and filters receipts to those received before the given date.
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 list of location Ids and filters receipts by the location they relate to.
A filter that accepts a list of location contact Ids and filters receipts to those where the receipt is assigned to one of the location contacts.
A filter that accepts an amount (in pence) and filters receipts to those with an amount equal to or less than the given amount.
A filter that accepts an amount (in pence) and filters receipts to those with a clawback amount equal to or less than the given amount.
A filter that accepts an amount (in pence) and filters receipts to those with an amount equal to or higher than the given amount.
A filter that accepts an amount (in pence) and filters receipts to those with a clawback amount equal to or higher than the given amount.
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, payee, payment_method, reference.
A filter that accepts a list of service user Ids and filters receipts to those where the receipt is assigned to one of the service users.
A filter that accepts a list of service user contact Ids and filters receipts to those where the receipt is assigned to one of the service user contacts.
A filter that accepts a date and filters invoices to those issued after the given date.
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 receipts.
var receipts = apiClient.Request(
HttpMethod.Get,
"receipts",
new MultiValueDict()
.Add("attributes", "reference", "amount")
);
<?php
$receipts = $api_client->request(
'GET',
'receipts',
[
'attributes'=>['reference', 'amount']
]
);
receipts = api_client(
'GET',
'receipts',
params={
'attributes': ['reference', 'amount']
}
)
receipts = api_client.request(
'GET',
'receipts',
params: {
'attributes' => ['reference', 'amount']
}
)
{
"item_count": 5,
"items": [
{
"_id": "6932cdf13550e2b34494c26b",
"amount": 572228,
"reference": "INV-0001"
},
{
"_id": "6932cdf13550e2b34494c26d",
"amount": 12000,
"reference": "INV-0001"
},
{
"_id": "6932cdf13550e2b34494c26f",
"amount": 581610,
"reference": ""
},
{
"_id": "6932cdf13550e2b34494c271",
"amount": 1435800,
"reference": "INV-0002, 0003"
},
{
"_id": "6932cdf13550e2b34494c273",
"amount": 426216,
"reference": ""
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var receipt = apiClient.Request(
HttpMethod.Get,
$"receipts/{receiptId}"
);
<?php
$receipt = $api_client->request(
'GET',
'receipts/' . $receipt_id
);
receipt = api_client('GET', f'receipts/{receipt_id}')
receipt = api_client.request('GET', "receipts/#{receipt_id}")
{
"_id": "6932cdf13550e2b34494c26b",
"amount": 572228,
"bank_account": "6932cdf13550e2b34494c257",
"clawback_amount": 0,
"created": "2025-12-05 12:20:01",
"description": "P HOWARTH",
"invalidated": null,
"location": "6932cde23550e2b34494abad",
"location_contact": null,
"locked": false,
"modified": "2025-12-05 12:20:01",
"payee": "MARSHALL CARE LTD",
"payment_method": null,
"receipt_number": null,
"received_date": "2025-11-25",
"reconciled": false,
"reference": "INV-0001",
"service_user": null,
"service_user_contact": null
}