Get one Invoice

GET

api

billing

invoices

{id}

Get one Invoice

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "InvoiceNumber": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToTaxIDNumber": "<string>",
  "BillToPostCode": "<string>",
  "BillToPhone": "<string>",
  "BillToFax": "<string>",
  "BillToCountryId": 123,
  "BillToCountryName": "<string>",
  "Description": "<string>",
  "DiscountAmount": 123,
  "DueDate": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "SubscriptionAmount": 123,
  "ResellerAmount": 123,
  "TotalAmount": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxAmount": 123,
  "Paid": true,
  "PaidOn": "<string>",
  "CustomData": "<string>",
  "PaymentAttemptsCount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the Invoice record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/invoices/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/invoices/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/invoices/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Unique sequential invoice number assigned at issuance (e.g. INV-00042).

string

Name of the person or organisation being billed, captured at invoice time.

string

Billing street address, captured at invoice time.

string

Billing city, captured at invoice time.

string

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

string

Billing postal/ZIP code, captured at invoice time.

string

Billing phone number, captured at invoice time.

string

Billing fax number, captured at invoice time.

integer

ID of the bill to country linked to this record.

string

Display name of the billing country (read-only, resolved from BillToCountryId).

string

Free-text description or notes for this invoice.

number

Total discount applied to the invoice, in the invoice currency.

string

Date by which payment is expected.

string

Start date of the billing period covered by this invoice.

string

End date of the billing period covered by this invoice.

number

Portion of the total that corresponds to recurring subscription charges.

number

Portion of the total attributed to the reseller (partner) channel.

number

Grand total of the invoice including all line items, taxes, and discounts.

integer

ID of the currency linked to this record.

string

ISO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.

number

Total tax amount calculated for the invoice.

boolean

Whether the invoice has been fully paid.

string

Date and time when full payment was recorded.

string

Arbitrary JSON or text blob for storing integration-specific metadata.

integer

Number of automatic payment collection attempts made for this invoice.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "InvoiceNumber": "",
  "BillToName": "",
  "BillToAddress": "",
  "BillToCity": "",
  "BillToTaxIDNumber": null,
  "BillToPostCode": "",
  "BillToPhone": null,
  "BillToFax": null,
  "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
}

Get multiple InvoicesRetrieve multiple Invoice records by their Ids in a single request.

Get one Invoice

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "InvoiceNumber": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToTaxIDNumber": "<string>",
  "BillToPostCode": "<string>",
  "BillToPhone": "<string>",
  "BillToFax": "<string>",
  "BillToCountryId": 123,
  "BillToCountryName": "<string>",
  "Description": "<string>",
  "DiscountAmount": 123,
  "DueDate": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "SubscriptionAmount": 123,
  "ResellerAmount": 123,
  "TotalAmount": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxAmount": 123,
  "Paid": true,
  "PaidOn": "<string>",
  "CustomData": "<string>",
  "PaymentAttemptsCount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200