Get one FinancialAccount

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

import requests

url = "https://spaces.nexudus.com/api/billing/financialaccounts/{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/financialaccounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Code": "<string>",
  "Description": "<string>",
  "AccountType": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A financial account is a location-specific bookkeeping category used to track revenue, incoming payments, or security deposits when it is assigned to items and services sold by the location. Issued invoice lines retain a snapshot of the account’s code and name, so later changes to or deletion of the account do not alter them.

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location that owns this financial account..

string

Required display name for this financial account, up to 150 characters..

string

Required accounting reference code, up to 50 characters and unique within the location; it can match an external accounting system’s account code..

string

Optional free-text explanation of this account’s purpose, up to 254 characters..

integer

Category that controls the account’s use: Sales (1) for revenue, Payments (2) for incoming payments, or Deposits (3) for security deposits; defaults to Sales.. See eFinancialAccountType enum values: 1 = Sales, 2 = Payments, 3 = Deposits.

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,
  "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
}

Get one FinancialAccount

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

import requests

url = "https://spaces.nexudus.com/api/billing/financialaccounts/{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/financialaccounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Code": "<string>",
  "Description": "<string>",
  "AccountType": 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