Skip to main content
GET
/
api
/
billing
/
financialaccounts
/
{id}
Get one FinancialAccount
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/financialaccounts/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "Code": "<string>",
  "Description": "<string>",
  "AccountType": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

A FinancialAccount represents a bookkeeping account used for categorising revenue and payments. Financial accounts can be assigned to Products, EventProducts, TimePasses, ExtraServices (resource prices), Tariffs and Charges to control how income is tracked and reported. Each account has a Code (typically matching an external accounting system reference), a Name, and an AccountType that determines where it appears:
AccountTypeValuePurpose
Sales1Revenue from products, services and bookings
Payments2Incoming payment receipts
Deposits3Security deposits held against contracts
Important: Changing a financial account’s details or reassigning it to different items has no effect on existing invoices. The financial account recorded on each invoice line is captured at the time the invoice is issued and is never updated retroactively.

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

​
Path Parameters

​
id
integer
required
The Id of the FinancialAccount record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
Name
string
Display name for this financial account.
​
Code
string
Short reference code, typically matching the account code in an external accounting system.
​
Description
string
Optional free-text description of the account’s purpose.
​
AccountType
integer
Category of the account: Sales (1), Payments (2) or Deposits (3). See eFinancialAccountType enum values: 0 = None, 1 = Sales, 2 = Payments, 3 = Deposits.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "Name": "",
  "Code": "",
  "Description": null,
  "AccountType": 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": "FinancialAccount Example",
  "LocalizationDetails": null,
  "CustomFields": null
}