Search BusinessCharges

Search and list BusinessCharge records with filtering, sorting, and pagination.

GET /api/billing/businesscharges

Search BusinessCharges

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

BusinessCharge_Business · integer

Filter by Business Id.

BusinessCharge_Application · integer

Filter by Application Id.

BusinessCharge_Description · string

Filter by human-readable description of what this charge is for.

BusinessCharge_CallBackUrl · string

Filter by uRL that Nexudus will call back once the charge is processed or its status changes.

BusinessCharge_DueDate · string

Filter by date by which the charge must be paid.

BusinessCharge_PercentageDiscount · number

Filter by percentage discount to apply to the charge amount (0–100).

BusinessCharge_TotalAmount · number

Filter by total amount of the charge before tax.

BusinessCharge_TaxAmount · number

Filter by tax amount applied to this charge.

BusinessCharge_Invoiced · boolean

Filter by true once the charge has been added to an invoice.

BusinessCharge_InvoicedOn · string

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

BusinessCharge_ApprovedByBusiness · boolean

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

BusinessCharge_ApprovedBySender · boolean

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

BusinessCharge_Recurrent · boolean

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

BusinessCharge_RepeatFrom · string

Filter by start date of the recurrence window. Required when Recurrent is true.

BusinessCharge_RepeatUntil · string

Filter by end date of the recurrence window. The charge will not be issued after this date.

Range Filters

from_BusinessCharge_DueDate · string

Filter by date by which the charge must be paid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_DueDate · string

Filter by date by which the charge must be paid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_BusinessCharge_PercentageDiscount · number

Filter by percentage discount to apply to the charge amount (0–100) greater than or equal to this value.

to_BusinessCharge_PercentageDiscount · number

Filter by percentage discount to apply to the charge amount (0–100) less than or equal to this value.

from_BusinessCharge_TotalAmount · number

Filter by total amount of the charge before tax greater than or equal to this value.

to_BusinessCharge_TotalAmount · number

Filter by total amount of the charge before tax less than or equal to this value.

from_BusinessCharge_TaxAmount · number

Filter by tax amount applied to this charge greater than or equal to this value.

to_BusinessCharge_TaxAmount · number

Filter by tax amount applied to this charge less than or equal to this value.

from_BusinessCharge_InvoicedOn · string

Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_InvoicedOn · string

Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_BusinessCharge_RepeatFrom · string

Filter by start date of the recurrence window. Required when Recurrent is true greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_RepeatFrom · string

Filter by start date of the recurrence window. Required when Recurrent is true less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_BusinessCharge_RepeatUntil · string

Filter by end date of the recurrence window. The charge will not be issued after this date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_RepeatUntil · string

Filter by end date of the recurrence window. The charge will not be issued after this date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_BusinessCharge_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_BusinessCharge_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_BusinessCharge_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/businesscharges?page=1&size=15&orderBy=Description&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Description

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/businesscharges?BusinessCharge_Description=example-value&orderBy=Description&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/businesscharges?from_BusinessCharge_UpdatedOn=2025-01-01T00:00&to_BusinessCharge_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · BusinessCharge[]

The list of BusinessCharge records matching the query. See the Get one BusinessCharge endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each BusinessCharge. The following fields are not populated in the Records[] response: CallBackUrl, DueDate, TaxAmount.

To get all fields, fetch the full record using the Get one BusinessCharge endpoint.

Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "ApplicationId": null,
      "Description": "",
      "PercentageDiscount": 0,
      "TotalAmount": 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": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "BusinessCharge Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}