Create BusinessCharge

Create a new BusinessCharge record.

POST /api/billing/businesscharges

Create BusinessCharge

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/businesscharges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Description": "<string>",
  "CallBackUrl": "<string>",
  "PercentageDiscount": 123,
  "TotalAmount": 123,
  "TaxAmount": 123
}
'

200

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

Request Body

Required Fields

BusinessId · integer · required

Business Id.

Description · string · required

Human-readable description of what this charge is for.

CallBackUrl · string · required

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

PercentageDiscount · number · required

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

TotalAmount · number · required

Total amount of the charge before tax.

TaxAmount · number · required

Tax amount applied to this charge.

Optional Fields

ApplicationId · integer

Application Id.

DueDate · string

Date by which the charge must be paid.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/billing/businesscharges" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Description": "",
    "CallBackUrl": "",
    "PercentageDiscount": 0,
    "TotalAmount": 0,
    "TaxAmount": 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 businesscharge was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "BusinessCharge 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": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}