An invoice. Invoices are raised against service users and typically cover the cost of .
A unique Id for the invoice item type code.
Flag indicating if the invoice is approved (if not approved the invoice is considered draft).
The balance remaining unpaid against the invoice (in pence).
The date/time the invoice item type was created.
A list of invoices the credit note has been allocated against.
The date at which the invoice is due.
Flag indicating if the invoice has been exported to the external accounts package.
Flag indicating the invoice is currently in dispute.
The type of invoice; forcredit_note, invoice, overpayment.
The date at which the invoice was issued.
The location that raised the invoice.
The location contact the invoice was issued to.
Flag indicating if the invoice has been exported to the external accounts package via an integration, once synced in this way the invoice cannot be reverted from the exported state and therefore cannot be updated afterwards.
The date/time the invoice item type was modified.
A unique number for the invoice.
Flag indicating if the invoice has been paid.
The date the invoice was paid.
A description of why the invoice is currently in dispute.
A reference for the invoice.
Flag indicating if the invoice has been sent (to the client).
The service user contact the invoice was issued to.
A list of service users the invoice relates to.
The subtotal (total excluding tax) (in pence).
The account code of the billing party the invoice was raised for.
The address of the billing party invoice was raised for.
Address line 1 (e.g. house name/number).
Address line 2 (e.g. street).
Town, city or village.
County.
Postal code.
Country.
The name of the billing party company the invoice was raised for.
The name of the billing party contact the invoice was raised for.
The email address of the billing party the invoice was raised for.
The payment method of the billing party the invoice was raisedfor; card, cash, cheque, standing_order, direct_debit, bac.
The total (total including tax) (in pence).
Flag indicating if the invoice has been voided.
Flag indicating if the invoice was raised for the service user.
{
"_id": "66bfb4d19ab4e3d6eb735fd2",
"approved": true,
"balance": 584228,
"created": "2024-08-16 20:21:37",
"credited_invoices": [],
"due_date": "2024-08-12",
"exported": true,
"in_dispute": false,
"invoice_type": "invoice",
"issue_date": "2024-07-13",
"location": "66bfb4bb9ab4e3d6eb734900",
"location_contact": null,
"locked": false,
"modified": "2024-08-16 20:21:37",
"number": "INV-0001",
"paid": false,
"paid_date": null,
"reason_for_dispute": null,
"ref": null,
"sent": true,
"service_user_contact": "66bfb4c19ab4e3d6eb73591c",
"service_users": [
"66bfb4c19ab4e3d6eb735834"
],
"subtotal": 584228,
"tax_amount": 0,
"to_account_code": "PH0472",
"to_address": null,
"to_company_name": "",
"to_contact_name": "Paige Howarth",
"to_email": "paige.howarth@gmail.com",
"to_payment_method": "",
"total": 584228,
"void": false,
"with_self": false
}
Return a list of invoices.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a date and filters invoices to those issued 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 invoices by the location they relate to.
A filter that accepts a list of location contact Ids and filters invoices to those where the billing party is one of the location contacts.
A filter that accepts a fee (in pence) and filters invoices to those with a total equal to or less than the given fee.
A filter that accepts a fee (in pence) and filters invoices to those with a total equal to or higher than the given fee.
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; number, ref, to_company_name, to_contact_name.
A filter that accepts a list of service user Ids and filters invoices by the service user they are for.
A filter that accepts a list of service user contact Ids and filters invoices to those where the billing party is one of the service user contacts.
A filter that accepts a date and filters invoices to those issued after the given date.
unset
A filter that allows invoices to be filtered by whether the invoice is with the associated service users.
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 invoices.
var invoices = apiClient.Request(
HttpMethod.Get,
"invoices",
new MultiValueDict()
.Add("attributes", "to_company_name", "to_contact_name", "total")
);
<?php
$invoices = $api_client->request(
'GET',
'invoices',
[
'attributes'=>['to_company_name', 'to_contact_name', 'total']
]
);
invoices = api_client(
'GET',
'invoices',
params={
'attributes': ['to_company_name', 'to_contact_name', 'total']
}
)
invoices = api_client.request(
'GET',
'invoices',
params: {
'attributes' => ['to_company_name', 'to_contact_name', 'total']
}
)
{
"item_count": 4,
"items": [
{
"_id": "66bfb4d19ab4e3d6eb735fd2",
"tax_amount": 0,
"to_company_name": "",
"to_contact_name": "Paige Howarth",
"total": 584228
},
{
"_id": "66bfb4d19ab4e3d6eb735fd6",
"tax_amount": 0,
"to_company_name": "",
"to_contact_name": "Dawn Bell",
"total": 581610
},
{
"_id": "66bfb4d19ab4e3d6eb735fd9",
"tax_amount": 0,
"to_company_name": "",
"to_contact_name": "Francesca Jones",
"total": 717900
},
{
"_id": "66bfb4d19ab4e3d6eb735fdc",
"tax_amount": 0,
"to_company_name": "",
"to_contact_name": "Francesca Jones",
"total": 717900
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var invoice = apiClient.Request(HttpMethod.Get, $"invoices/{invoiceId}")
<?php
$invoice = $api_client->request('GET', 'invoices/' . $invoice_id);
invoice = api_client(
'GET',
f'invoices/{invoice_id}')
invoice = api_client.request('GET', "invoices/#{invoice_id}")
{
"_id": "66bfb4d19ab4e3d6eb735fd2",
"approved": true,
"balance": 584228,
"created": "2024-08-16 20:21:37",
"credited_invoices": [],
"due_date": "2024-08-12",
"exported": true,
"in_dispute": false,
"invoice_type": "invoice",
"issue_date": "2024-07-13",
"location": "66bfb4bb9ab4e3d6eb734900",
"location_contact": null,
"locked": false,
"modified": "2024-08-16 20:21:37",
"number": "INV-0001",
"paid": false,
"paid_date": null,
"reason_for_dispute": null,
"ref": null,
"sent": true,
"service_user_contact": "66bfb4c19ab4e3d6eb73591c",
"service_users": [
"66bfb4c19ab4e3d6eb735834"
],
"subtotal": 584228,
"tax_amount": 0,
"to_account_code": "PH0472",
"to_address": null,
"to_company_name": "",
"to_contact_name": "Paige Howarth",
"to_email": "paige.howarth@gmail.com",
"to_payment_method": "",
"total": 584228,
"void": false,
"with_self": false
}