Get one BusinessCharge

GET

api

billing

businesscharges

{id}

Get one BusinessCharge

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

import requests

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

{
  "BusinessId": 123,
  "ApplicationId": 123,
  "Description": "<string>",
  "CallBackUrl": "<string>",
  "DueDate": "<string>",
  "PercentageDiscount": 123,
  "TotalAmount": 123,
  "TaxAmount": 123,
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "ApprovedByBusiness": true,
  "ApprovedBySender": true,
  "Recurrent": true,
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A BusinessCharge represents a charge issued by Nexudus to a specific location for platform services or subscription fees. Only Nexudus staff can create or manage these charges. Charges can be one-off or recurring. Set Recurrent to true and provide RepeatFrom and RepeatUntil to define the recurrence window. A charge moves through an approval workflow before it is invoiced. Use ApprovedByBusiness and ApprovedBySender to reflect the approval state. Once invoiced, the Invoiced flag will be set and InvoicedOn will record the date.

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 BusinessCharge-Read role.

Path Parameters

integer

required

The Id of the BusinessCharge record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer

ID of the application linked to this record.

string

Human-readable description of what this charge is for.

string

URL that Nexudus will call back once the charge is processed or its status changes.

string

Date by which the charge must be paid.

number

Percentage discount to apply to the charge amount (0–100).

number

Total amount of the charge before tax.

number

Tax amount applied to this charge.

boolean

True once the charge has been added to an invoice.

string

Date and time when the charge was included in an invoice. Set automatically by Nexudus.

boolean

True when the business (location) has approved the charge. Both parties must approve before the charge can be invoiced.

boolean

True when Nexudus (the sender) has approved the charge. Both parties must approve before the charge can be invoiced.

boolean

Set to true to make this a recurring charge. Use with RepeatFrom and RepeatUntil to define the recurrence window.

string

Start date of the recurrence window. Required when Recurrent is true.

string

End date of the recurrence window. The charge will not be issued after this date.

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,
  "ApplicationId": null,
  "Description": "",
  "CallBackUrl": "",
  "DueDate": null,
  "PercentageDiscount": 0,
  "TotalAmount": 0,
  "TaxAmount": 0,
  "Invoiced": false,
  "InvoicedOn": null,
  "ApprovedByBusiness": false,
  "ApprovedBySender": false,
  "Recurrent": false,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "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": "BusinessCharge Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple BusinessChargesRetrieve multiple BusinessCharge records by their Ids in a single request.

Get one BusinessCharge

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

import requests

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

{
  "BusinessId": 123,
  "ApplicationId": 123,
  "Description": "<string>",
  "CallBackUrl": "<string>",
  "DueDate": "<string>",
  "PercentageDiscount": 123,
  "TotalAmount": 123,
  "TaxAmount": 123,
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "ApprovedByBusiness": true,
  "ApprovedBySender": true,
  "Recurrent": true,
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "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