> ## 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 CoworkerExtraServices

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

A **CoworkerExtraService** records a charge or credit assigned to a customer. It covers three use cases:

* **Booking charges** — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via `BookingId` and track the resource, time range, and price.
* **Time credit** — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the `ChargePeriod` of the linked extra service (minutes, days, uses, etc.). `TotalUses` and `RemainingUses` track the allowance.
* **Printing credit** — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has `IsPrintingCredit = true`. `TotalUses` and `RemainingUses` track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When `IsFromTariff` is `true`, the record was provisioned by a customer's contract (CoworkerContract) and is linked via `CoworkerContractUniqueId`.

## 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 **`CoworkerExtraService-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="CoworkerExtraService_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

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

<ParamField query="CoworkerExtraService_ExtraService" type="integer">
  Filter by Extra Service Id.
</ParamField>

<ParamField query="CoworkerExtraService_ExtraService_Name" type="string">
  Filter by name of the linked extra service.
</ParamField>

<ParamField query="CoworkerExtraService_ExtraService_Currency_Code" type="string">
  Filter by currency code of the linked extra service (e.g., USD, EUR).
</ParamField>

<ParamField query="CoworkerExtraService_ExtraService_IsPrintingCredit" type="boolean">
  Filter by true if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.
</ParamField>

<ParamField query="CoworkerExtraService_Description" type="string">
  Filter by free-text description of this charge or credit.
</ParamField>

<ParamField query="CoworkerExtraService_Notes" type="string">
  Filter by internal notes.
</ParamField>

<ParamField query="CoworkerExtraService_RemainingUses" type="integer">
  Filter by remaining credit (time or printing) the customer can still use.
</ParamField>

<ParamField query="CoworkerExtraService_TotalUses" type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
</ParamField>

<ParamField query="CoworkerExtraService_Free" type="boolean">
  Filter by whether this charge or credit is free (no cost to the customer).
</ParamField>

<ParamField query="CoworkerExtraService_Price" type="number">
  Filter by price charged for this extra service.
</ParamField>

<ParamField query="CoworkerExtraService_LastMinutePriceAdjustment" type="number">
  Filter by price adjustment applied for last-minute bookings.
</ParamField>

<ParamField query="CoworkerExtraService_DynamicPriceAdjustment" type="number">
  Filter by price adjustment applied by demand-based dynamic pricing.
</ParamField>

<ParamField query="CoworkerExtraService_PriceFactorLastMinute" type="number">
  Filter by multiplier applied for last-minute booking pricing.
</ParamField>

<ParamField query="CoworkerExtraService_PriceFactorDemand" type="number">
  Filter by multiplier applied for demand-based pricing.
</ParamField>

<ParamField query="CoworkerExtraService_ValidFrom" type="string">
  Filter by date from which this credit becomes usable.
</ParamField>

<ParamField query="CoworkerExtraService_ExpireDate" type="string">
  Filter by date when this credit expires and can no longer be used.
</ParamField>

<ParamField query="CoworkerExtraService_DueDate" type="string">
  Filter by payment due date for the charge.
</ParamField>

<ParamField query="CoworkerExtraService_PurchaseOrder" type="string">
  Filter by purchase order.
</ParamField>

<ParamField query="CoworkerExtraService_ChargePeriod" type="integer">
  Filter by unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).
</ParamField>

<ParamField query="CoworkerExtraService_Invoiced" type="boolean">
  Filter by whether this charge has already been invoiced.
</ParamField>

<ParamField query="CoworkerExtraService_InvoiceDate" type="string">
  Filter by invoice date.
</ParamField>

<ParamField query="CoworkerExtraService_IsFromTariff" type="boolean">
  Filter by whether this credit was automatically provisioned from the customer's plan (tariff).
</ParamField>

<ParamField query="CoworkerExtraService_TariffTimePassUniqueId" type="string">
  Filter by links this credit back to the time pass definition in the plan.
</ParamField>

<ParamField query="CoworkerExtraService_CoworkerProductUniqueId" type="string">
  Filter by links this credit back to the customer product that provisioned it.
</ParamField>

<ParamField query="CoworkerExtraService_BookingUniqueId" type="string">
  Filter by unique ID of the booking that generated this charge.
</ParamField>

<ParamField query="CoworkerExtraService_AutomaticallyAdded" type="boolean">
  Filter by whether this record was automatically created (e.g., from a booking or plan renewal).
</ParamField>

<ParamField query="CoworkerExtraService_InvoiceThisCoworker" type="boolean">
  Filter by invoice the customer directly instead of the team or company paying member.
</ParamField>

<ParamField query="CoworkerExtraService_DiscountCode" type="string">
  Filter by discount code.
</ParamField>

<ParamField query="CoworkerExtraService_CoworkerDiscountUniqueId" type="string">
  Filter by unique ID of the discount applied to this charge.
</ParamField>

<ParamField query="CoworkerExtraService_DiscountAmount" type="number">
  Filter by amount discounted from the price.
</ParamField>

<ParamField query="CoworkerExtraService_BookingId" type="integer">
  Filter by iD of the booking that generated this charge.
</ParamField>

<ParamField query="CoworkerExtraService_BookingFromTime" type="string">
  Filter by start time of the booking that generated this charge.
</ParamField>

<ParamField query="CoworkerExtraService_BookingToTime" type="string">
  Filter by end time of the booking that generated this charge.
</ParamField>

<ParamField query="CoworkerExtraService_BookingResourceName" type="string">
  Filter by name of the resource booked (e.g., meeting room name).
</ParamField>

<ParamField query="CoworkerExtraService_CoworkerContractUniqueId" type="string">
  Filter by links this credit back to the customer contract that provisioned it.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerExtraService_RemainingUses" type="integer">
  Filter by remaining credit (time or printing) the customer can still use greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_RemainingUses" type="integer">
  Filter by remaining credit (time or printing) the customer can still use less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_TotalUses" type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_TotalUses" type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_Price" type="number">
  Filter by price charged for this extra service greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_Price" type="number">
  Filter by price charged for this extra service less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_LastMinutePriceAdjustment" type="number">
  Filter by price adjustment applied for last-minute bookings greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_LastMinutePriceAdjustment" type="number">
  Filter by price adjustment applied for last-minute bookings less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_DynamicPriceAdjustment" type="number">
  Filter by price adjustment applied by demand-based dynamic pricing greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_DynamicPriceAdjustment" type="number">
  Filter by price adjustment applied by demand-based dynamic pricing less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_PriceFactorLastMinute" type="number">
  Filter by multiplier applied for last-minute booking pricing greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_PriceFactorLastMinute" type="number">
  Filter by multiplier applied for last-minute booking pricing less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_PriceFactorDemand" type="number">
  Filter by multiplier applied for demand-based pricing greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_PriceFactorDemand" type="number">
  Filter by multiplier applied for demand-based pricing less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_ValidFrom" type="string">
  Filter by date from which this credit becomes usable greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_ValidFrom" type="string">
  Filter by date from which this credit becomes usable less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerExtraService_ExpireDate" type="string">
  Filter by date when this credit expires and can no longer be used greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_ExpireDate" type="string">
  Filter by date when this credit expires and can no longer be used less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerExtraService_DueDate" type="string">
  Filter by payment due date for the charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_DueDate" type="string">
  Filter by payment due date for the charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerExtraService_InvoiceDate" type="string">
  Filter by invoice date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_InvoiceDate" type="string">
  Filter by invoice date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerExtraService_DiscountAmount" type="number">
  Filter by amount discounted from the price greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_DiscountAmount" type="number">
  Filter by amount discounted from the price less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_BookingId" type="integer">
  Filter by iD of the booking that generated this charge greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerExtraService_BookingId" type="integer">
  Filter by iD of the booking that generated this charge less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerExtraService_BookingFromTime" type="string">
  Filter by start time of the booking that generated this charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_BookingFromTime" type="string">
  Filter by start time of the booking that generated this charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerExtraService_BookingToTime" type="string">
  Filter by end time of the booking that generated this charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerExtraService_BookingToTime" type="string">
  Filter by end time of the booking that generated this charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_CoworkerExtraService_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/coworkerextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      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/coworkerextraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by CreatedOn

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
      CoworkerExtraService_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      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/coworkerextraservices',
      params={
          'CoworkerExtraService_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          '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/coworkerextraservices?from_CoworkerExtraService_UpdatedOn=2025-01-01T00:00&to_CoworkerExtraService_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/coworkerextraservices?' + new URLSearchParams({
      from_CoworkerExtraService_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerExtraService_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/coworkerextraservices',
      params={
          'from_CoworkerExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerExtraService_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="CoworkerExtraService[]">
  The list of CoworkerExtraService records matching the query. See the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-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 CoworkerExtraService. The following fields are **not populated** in the `Records[]` response: `Notes`, `InvoiceThisCoworker`.

  To get all fields, fetch the full record using the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-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": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceCurrencyCode": null,
      "ExtraServiceIsPrintingCredit": false,
      "Description": null,
      "RemainingUses": 0,
      "TotalUses": 0,
      "Free": false,
      "Price": null,
      "LastMinutePriceAdjustment": null,
      "DynamicPriceAdjustment": null,
      "PriceFactorLastMinute": null,
      "PriceFactorDemand": null,
      "ValidFrom": null,
      "ExpireDate": null,
      "DueDate": null,
      "PurchaseOrder": null,
      "ChargePeriod": 0,
      "Invoiced": false,
      "InvoiceDate": null,
      "IsFromTariff": false,
      "TariffTimePassUniqueId": null,
      "CoworkerProductUniqueId": null,
      "BookingUniqueId": null,
      "AutomaticallyAdded": false,
      "DiscountCode": null,
      "CoworkerDiscountUniqueId": null,
      "DiscountAmount": null,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerContractUniqueId": 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": "CoworkerExtraService Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```