Search Invoices

GET

api

billing

invoices

Search Invoices

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

import requests

url = "https://spaces.nexudus.com/api/billing/invoices"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business linked to this record.

string

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

string

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

string

Filter by billing street address, captured at invoice time.

string

Filter by billing city, captured at invoice time.

string

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

string

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

string

Filter by billing phone number, captured at invoice time.

string

Filter by billing fax number, captured at invoice time.

integer

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

string

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

string

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

number

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

string

Filter by date by which payment is expected.

string

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

string

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

number

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

number

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

number

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

integer

Filter by iD of the currency linked to this record.

string

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

number

Filter by total tax amount calculated for the invoice.

boolean

Filter by whether the invoice has been fully paid.

string

Filter by date and time when full payment was recorded.

string

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

integer

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

Range Filters

number

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

number

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

string

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

string

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

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.

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.

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.

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.

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

string

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

string

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

integer

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

integer

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

string

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

string

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

string

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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'InvoiceNumber',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/invoices',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'InvoiceNumber',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
    Invoice_InvoiceNumber: 'example-value',
    orderBy: 'InvoiceNumber',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/invoices',
    params={
        'Invoice_InvoiceNumber': 'example-value',
        'orderBy': 'InvoiceNumber',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
    from_Invoice_UpdatedOn: '2025-01-01T00:00',
    to_Invoice_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/invoices',
    params={
        'from_Invoice_UpdatedOn': '2025-01-01T00:00',
        'to_Invoice_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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>'

import requests

url = "https://spaces.nexudus.com/api/billing/invoices"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

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

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by InvoiceNumber

Range filters

Response

200