Invoices
Search Invoices
Search and list Invoice records with filtering, sorting, and pagination.
GET
An Invoice represents a bill issued by Nexudus to the operator (the business running the coworking space). Invoices are generated automatically by the billing engine or can be created manually via the API.
Each invoice captures a snapshot of the billing details at issuance time — bill-to address, currency, tax amounts, and line items. Once issued, the invoice record is immutable with respect to these captured values; changes to the underlying financial accounts, products or customer details do not retroactively update existing invoices.
Invoices support
list, get, and create operations. They cannot be updated or deleted through the API.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Invoice-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by unique sequential invoice number assigned at issuance (e.g. INV-00042).
Filter by name of the person or organisation being billed, captured at invoice time.
Filter by billing street address, captured at invoice time.
Filter by billing city, captured at invoice time.
Filter by tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
Filter by billing postal/ZIP code, captured at invoice time.
Filter by billing phone number, captured at invoice time.
Filter by billing fax number, captured at invoice time.
Filter by Bill To Country Id.
Filter by display name of the billing country (read-only, resolved from BillToCountryId).
Filter by free-text description or notes for this invoice.
Filter by total discount applied to the invoice, in the invoice currency.
Filter by date by which payment is expected.
Filter by start date of the billing period covered by this invoice.
Filter by end date of the billing period covered by this invoice.
Filter by portion of the total that corresponds to recurring subscription charges.
Filter by portion of the total attributed to the reseller (partner) channel.
Filter by grand total of the invoice including all line items, taxes, and discounts.
Filter by Currency Id.
Filter by iSO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.
Filter by total tax amount calculated for the invoice.
Filter by whether the invoice has been fully paid.
Filter by date and time when full payment was recorded.
Filter by arbitrary JSON or text blob for storing integration-specific metadata.
Filter by number of automatic payment collection attempts made for this invoice.
Range Filters
Filter by total discount applied to the invoice, in the invoice currency greater than or equal to this value.
Filter by total discount applied to the invoice, in the invoice currency less than or equal to this value.
Filter by date by which payment is expected greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date by which payment is expected less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by start date of the billing period covered by this invoice less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end date of the billing period covered by this invoice less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by portion of the total that corresponds to recurring subscription charges greater than or equal to this value.
Filter by portion of the total that corresponds to recurring subscription charges less than or equal to this value.
Filter by portion of the total attributed to the reseller (partner) channel greater than or equal to this value.
Filter by portion of the total attributed to the reseller (partner) channel less than or equal to this value.
Filter by grand total of the invoice including all line items, taxes, and discounts greater than or equal to this value.
Filter by grand total of the invoice including all line items, taxes, and discounts less than or equal to this value.
Filter by total tax amount calculated for the invoice greater than or equal to this value.
Filter by total tax amount calculated for the invoice less than or equal to this value.
Filter by date and time when full payment was recorded greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date and time when full payment was recorded less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by number of automatic payment collection attempts made for this invoice greater than or equal to this value.
Filter by number of automatic payment collection attempts made for this invoice less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by InvoiceNumber
Range filters
Response
200
The list of Invoice records matching the query. See the Get one Invoice endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response