Create FinancialAccount

Create a new FinancialAccount record.

POST /api/billing/financialaccounts

Create FinancialAccount

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/financialaccounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Code": "<string>",
  "AccountType": 123
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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:

AccountType	Value	Purpose
Sales	1	Revenue from products, services and bookings
Payments	2	Incoming payment receipts
Deposits	3	Security 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-Create role.

Enums

eFinancialAccountType — AccountType values

Value	Name
0	None
1	Sales
2	Payments
3	Deposits

Request Body

Required Fields

BusinessId · integer · required

ID of the business linked to this record.

Name · string · required

Display name for this financial account.

Code · string · required

Short reference code, typically matching the account code in an external accounting system.

AccountType · integer · required

Category of the account: Sales (1), Payments (2) or Deposits (3). Defaults to eFinancialAccountType.Sales.

Optional Fields

Description · string

Optional free-text description of the account’s purpose.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/billing/financialaccounts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Code": "",
    "AccountType": 0
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the financialaccount was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FinancialAccount was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}