> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search BusinessCharges

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

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

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="BusinessCharge_Business" type="integer">
  Filter by Business Id.
</ParamField>

<ParamField query="BusinessCharge_Application" type="integer">
  Filter by Application Id.
</ParamField>

<ParamField query="BusinessCharge_Description" type="string">
  Filter by human-readable description of what this charge is for.
</ParamField>

<ParamField query="BusinessCharge_CallBackUrl" type="string">
  Filter by uRL that Nexudus will call back once the charge is processed or its status changes.
</ParamField>

<ParamField query="BusinessCharge_DueDate" type="string">
  Filter by date by which the charge must be paid.
</ParamField>

<ParamField query="BusinessCharge_PercentageDiscount" type="number">
  Filter by percentage discount to apply to the charge amount (0–100).
</ParamField>

<ParamField query="BusinessCharge_TotalAmount" type="number">
  Filter by total amount of the charge before tax.
</ParamField>

<ParamField query="BusinessCharge_TaxAmount" type="number">
  Filter by tax amount applied to this charge.
</ParamField>

<ParamField query="BusinessCharge_Invoiced" type="boolean">
  Filter by true once the charge has been added to an invoice.
</ParamField>

<ParamField query="BusinessCharge_InvoicedOn" type="string">
  Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus.
</ParamField>

<ParamField query="BusinessCharge_ApprovedByBusiness" type="boolean">
  Filter by true when the business (location) has approved the charge. Both parties must approve before the charge can be invoiced.
</ParamField>

<ParamField query="BusinessCharge_ApprovedBySender" type="boolean">
  Filter by true when Nexudus (the sender) has approved the charge. Both parties must approve before the charge can be invoiced.
</ParamField>

<ParamField query="BusinessCharge_Recurrent" type="boolean">
  Filter by set to true to make this a recurring charge. Use with `RepeatFrom` and `RepeatUntil` to define the recurrence window.
</ParamField>

<ParamField query="BusinessCharge_RepeatFrom" type="string">
  Filter by start date of the recurrence window. Required when `Recurrent` is true.
</ParamField>

<ParamField query="BusinessCharge_RepeatUntil" type="string">
  Filter by end date of the recurrence window. The charge will not be issued after this date.
</ParamField>

### Range Filters

<ParamField query="from_BusinessCharge_DueDate" type="string">
  Filter by date by which the charge must be paid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_BusinessCharge_DueDate" type="string">
  Filter by date by which the charge must be paid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_BusinessCharge_PercentageDiscount" type="number">
  Filter by percentage discount to apply to the charge amount (0–100) greater than or equal to this value.
</ParamField>

<ParamField query="to_BusinessCharge_PercentageDiscount" type="number">
  Filter by percentage discount to apply to the charge amount (0–100) less than or equal to this value.
</ParamField>

<ParamField query="from_BusinessCharge_TotalAmount" type="number">
  Filter by total amount of the charge before tax greater than or equal to this value.
</ParamField>

<ParamField query="to_BusinessCharge_TotalAmount" type="number">
  Filter by total amount of the charge before tax less than or equal to this value.
</ParamField>

<ParamField query="from_BusinessCharge_TaxAmount" type="number">
  Filter by tax amount applied to this charge greater than or equal to this value.
</ParamField>

<ParamField query="to_BusinessCharge_TaxAmount" type="number">
  Filter by tax amount applied to this charge less than or equal to this value.
</ParamField>

<ParamField query="from_BusinessCharge_InvoicedOn" type="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`.
</ParamField>

<ParamField query="to_BusinessCharge_InvoicedOn" type="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`.
</ParamField>

<ParamField query="from_BusinessCharge_RepeatFrom" type="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`.
</ParamField>

<ParamField query="to_BusinessCharge_RepeatFrom" type="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`.
</ParamField>

<ParamField query="from_BusinessCharge_RepeatUntil" type="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`.
</ParamField>

<ParamField query="to_BusinessCharge_RepeatUntil" type="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`.
</ParamField>

<ParamField query="from_BusinessCharge_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_BusinessCharge_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_BusinessCharge_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_BusinessCharge_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges?page=1&size=15&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Description',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Description

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges?BusinessCharge_Description=example-value&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      BusinessCharge_Description: 'example-value',
      orderBy: 'Description',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'BusinessCharge_Description': 'example-value',
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      from_BusinessCharge_UpdatedOn: '2025-01-01T00:00',
      to_BusinessCharge_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'from_BusinessCharge_UpdatedOn': '2025-01-01T00:00',
          'to_BusinessCharge_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BusinessCharge[]">
  The list of BusinessCharge records matching the query. See the [Get one BusinessCharge](/rest-api/billing/get-businesscharges-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **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](/rest-api/billing/get-businesscharges-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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": "admin@example.com",
      "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
}
```