Invoices
Get one Invoice
Retrieve a single Invoice record by its Id.
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-Read role.Path Parameters
The Id of the Invoice record to retrieve.
Code Examples
Response
200
Business Id.
Unique sequential invoice number assigned at issuance (e.g. INV-00042).
Name of the person or organisation being billed, captured at invoice time.
Billing street address, captured at invoice time.
Billing city, captured at invoice time.
Tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
Billing postal/ZIP code, captured at invoice time.
Billing phone number, captured at invoice time.
Billing fax number, captured at invoice time.
Bill To Country Id.
Display name of the billing country (read-only, resolved from BillToCountryId).
Free-text description or notes for this invoice.
Total discount applied to the invoice, in the invoice currency.
Date by which payment is expected.
Start date of the billing period covered by this invoice.
End date of the billing period covered by this invoice.
Portion of the total that corresponds to recurring subscription charges.
Portion of the total attributed to the reseller (partner) channel.
Grand total of the invoice including all line items, taxes, and discounts.
Currency Id.
ISO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.
Total tax amount calculated for the invoice.
Whether the invoice has been fully paid.
Date and time when full payment was recorded.
Arbitrary JSON or text blob for storing integration-specific metadata.
Number of automatic payment collection attempts made for this invoice.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response