Skip to main content
GET
/
api
/
billing
/
businesscharges
/
{id}
{
  "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

​
id
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"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
ApplicationId
integer
Application Id.
​
Description
string
Human-readable description of what this charge is for.
​
CallBackUrl
string
URL that Nexudus will call back once the charge is processed or its status changes.
​
DueDate
string
Date by which the charge must be paid.
​
PercentageDiscount
number
Percentage discount to apply to the charge amount (0–100).
​
TotalAmount
number
Total amount of the charge before tax.
​
TaxAmount
number
Tax amount applied to this charge.
​
Invoiced
boolean
True once the charge has been added to an invoice.
​
InvoicedOn
string
Date and time when the charge was included in an invoice. Set automatically by Nexudus.
​
ApprovedByBusiness
boolean
True when the business (location) has approved the charge. Both parties must approve before the charge can be invoiced.
​
ApprovedBySender
boolean
True when Nexudus (the sender) has approved the charge. Both parties must approve before the charge can be invoiced.
​
Recurrent
boolean
Set to true to make this a recurring charge. Use with RepeatFrom and RepeatUntil to define the recurrence window.
​
RepeatFrom
string
Start date of the recurrence window. Required when Recurrent is true.
​
RepeatUntil
string
End date of the recurrence window. The charge will not be issued after this date.
​
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,
  "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
}