Create FinancialAccount

POST

api

billing

financialaccounts

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

import requests

url = "https://spaces.nexudus.com/api/billing/financialaccounts"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Code": "<string>",
    "AccountType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Code: '<string>', AccountType: 123})
};

fetch('https://spaces.nexudus.com/api/billing/financialaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eFinancialAccountType — AccountType values

Value	Name
1	Sales
2	Payments
3	Deposits

Request Body

Required Fields

integer

required

ID of the location that owns this financial account..

string

required

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

string

required

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

integer

required

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.. Defaults to eFinancialAccountType.Sales.

Optional Fields

string

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

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/financialaccounts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Code: '',
      AccountType: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/financialaccounts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Code': '',
        'AccountType': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the financialaccount was created successfully.

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": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

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

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

Create FinancialAccount

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

import requests

url = "https://spaces.nexudus.com/api/billing/financialaccounts"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Code": "<string>",
    "AccountType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Code: '<string>', AccountType: 123})
};

fetch('https://spaces.nexudus.com/api/billing/financialaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400