Search Invoices - Nexudus Platform

GET

api

billing

invoices

Search Invoices

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/invoices \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

Invoice_Business

integer

Filter by iD of the business linked to this record.

Invoice_InvoiceNumber

string

Filter by unique sequential invoice number assigned at issuance (e.g. INV-00042).

Invoice_BillToName

string

Filter by name of the person or organisation being billed, captured at invoice time.

Invoice_BillToAddress

string

Filter by billing street address, captured at invoice time.

Invoice_BillToCity

string

Filter by billing city, captured at invoice time.

Invoice_BillToTaxIDNumber

string

Filter by tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.

Invoice_BillToPostCode

string

Filter by billing postal/ZIP code, captured at invoice time.

Invoice_BillToPhone

string

Filter by billing phone number, captured at invoice time.

Invoice_BillToFax

string

Filter by billing fax number, captured at invoice time.

Invoice_BillToCountry

integer

Filter by iD of the bill to country linked to this record.

Invoice_BillToCountry_Name

string

Filter by display name of the billing country (read-only, resolved from BillToCountryId).

Invoice_Description

string

Filter by free-text description or notes for this invoice.

Invoice_DiscountAmount

number

Filter by total discount applied to the invoice, in the invoice currency.

Invoice_DueDate

string

Filter by date by which payment is expected.

Invoice_InvoiceFromDate

string

Filter by start date of the billing period covered by this invoice.

Invoice_InvoiceToDate

string

Filter by end date of the billing period covered by this invoice.

Invoice_SubscriptionAmount

number

Filter by portion of the total that corresponds to recurring subscription charges.

Invoice_ResellerAmount

number

Filter by portion of the total attributed to the reseller (partner) channel.

Invoice_TotalAmount

number

Filter by grand total of the invoice including all line items, taxes, and discounts.

Invoice_Currency

integer

Filter by iD of the currency linked to this record.

Invoice_Currency_Code

string

Filter by iSO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.

Invoice_TaxAmount

number

Filter by total tax amount calculated for the invoice.

Invoice_Paid

boolean

Filter by whether the invoice has been fully paid.

Invoice_PaidOn

string

Filter by date and time when full payment was recorded.

Invoice_CustomData

string

Filter by arbitrary JSON or text blob for storing integration-specific metadata.

Invoice_PaymentAttemptsCount

integer

Filter by number of automatic payment collection attempts made for this invoice.

Range Filters

from_Invoice_DiscountAmount

number

Filter by total discount applied to the invoice, in the invoice currency greater than or equal to this value.

to_Invoice_DiscountAmount

number

Filter by total discount applied to the invoice, in the invoice currency less than or equal to this value.

from_Invoice_DueDate

string

Filter by date by which payment is expected greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Invoice_DueDate

string

Filter by date by which payment is expected less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Invoice_InvoiceFromDate

string

Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Invoice_InvoiceFromDate

string

Filter by start date of the billing period covered by this invoice less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Invoice_InvoiceToDate

string

Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Invoice_InvoiceToDate

string

Filter by end date of the billing period covered by this invoice less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Invoice_SubscriptionAmount

number

Filter by portion of the total that corresponds to recurring subscription charges greater than or equal to this value.

to_Invoice_SubscriptionAmount

number

Filter by portion of the total that corresponds to recurring subscription charges less than or equal to this value.

from_Invoice_ResellerAmount

number

Filter by portion of the total attributed to the reseller (partner) channel greater than or equal to this value.

to_Invoice_ResellerAmount

number

Filter by portion of the total attributed to the reseller (partner) channel less than or equal to this value.

from_Invoice_TotalAmount

number

Filter by grand total of the invoice including all line items, taxes, and discounts greater than or equal to this value.

to_Invoice_TotalAmount

number

Filter by grand total of the invoice including all line items, taxes, and discounts less than or equal to this value.

from_Invoice_TaxAmount

number

Filter by total tax amount calculated for the invoice greater than or equal to this value.

to_Invoice_TaxAmount

number

Filter by total tax amount calculated for the invoice less than or equal to this value.

from_Invoice_PaidOn

string

Filter by date and time when full payment was recorded greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Invoice_PaidOn

string

Filter by date and time when full payment was recorded less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Invoice_PaymentAttemptsCount

integer

Filter by number of automatic payment collection attempts made for this invoice greater than or equal to this value.

to_Invoice_PaymentAttemptsCount

integer

Filter by number of automatic payment collection attempts made for this invoice less than or equal to this value.

from_Invoice_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Invoice_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_Invoice_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Invoice_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/invoices?page=1&size=15&orderBy=InvoiceNumber&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by InvoiceNumber

curl -X GET \
  "https://spaces.nexudus.com/api/billing/invoices?Invoice_InvoiceNumber=example-value&orderBy=InvoiceNumber&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/invoices?from_Invoice_UpdatedOn=2025-01-01T00:00&to_Invoice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

Invoice[]

The list of Invoice records matching the query. See the Get one Invoice endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Invoice. The following fields are not populated in the Records[] response: BillToAddress, BillToCity, BillToTaxIDNumber, BillToPostCode, BillToPhone, BillToFax.To get all fields, fetch the full record using the Get one Invoice endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "InvoiceNumber": "",
      "BillToName": "",
      "BillToCountryId": 0,
      "BillToCountryName": null,
      "Description": null,
      "DiscountAmount": 0,
      "DueDate": null,
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "SubscriptionAmount": 0,
      "ResellerAmount": 0,
      "TotalAmount": 0,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxAmount": 0,
      "Paid": false,
      "PaidOn": null,
      "CustomData": null,
      "PaymentAttemptsCount": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "Invoice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "InvoiceNumber",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one InvoiceRetrieve a single Invoice record by its Id.

Search Invoices

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/invoices \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Documentation Index

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by InvoiceNumber

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by InvoiceNumber

Range filters

Response

200