Search CoworkerExtraServices

GET

api

billing

coworkerextraservices

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

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.

Enums

eChargePeriod — ChargePeriod values

Value	Name
1	Minutes
2	Days
3	Weeks
4	Months
5	Uses
6	FourWeekMonths

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the coworker linked to this record.

integer

Filter by iD of the business linked to this record.

integer

Filter by iD of the extra service linked to this record.

string

Filter by name of the linked extra service.

string

Filter by currency code of the linked extra service (e.g., USD, EUR).

boolean

Filter by true if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.

string

Filter by free-text description of this charge or credit.

string

Filter by internal notes.

integer

Filter by remaining credit (time or printing) the customer can still use.

integer

Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.

boolean

Filter by whether this charge or credit is free (no cost to the customer).

number

Filter by price charged for this extra service.

number

Filter by price adjustment applied for last-minute bookings.

number

Filter by price adjustment applied by demand-based dynamic pricing.

number

Filter by multiplier applied for last-minute booking pricing.

number

Filter by multiplier applied for demand-based pricing.

string

Filter by date from which this credit becomes usable.

string

Filter by date when this credit expires and can no longer be used.

string

Filter by payment due date for the charge.

string

Filter by purchase order.

integer

Filter by unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).

boolean

Filter by whether this charge has already been invoiced.

string

Filter by invoice date.

boolean

Filter by whether this credit was automatically provisioned from the customer’s plan (tariff).

string

Filter by links this credit back to the time pass definition in the plan.

string

Filter by links this credit back to the customer product that provisioned it.

string

Filter by unique ID of the booking that generated this charge.

boolean

Filter by whether this record was automatically created (e.g., from a booking or plan renewal).

boolean

Filter by invoice the customer directly instead of the team or company paying member.

string

Filter by discount code.

string

Filter by unique ID of the discount applied to this charge.

number

Filter by amount discounted from the price.

integer

Filter by iD of the booking that generated this charge.

string

Filter by start time of the booking that generated this charge.

string

Filter by end time of the booking that generated this charge.

string

Filter by name of the resource booked (e.g., meeting room name).

string

Filter by links this credit back to the customer contract that provisioned it.

Range Filters

integer

Filter by remaining credit (time or printing) the customer can still use greater than or equal to this value.

integer

Filter by remaining credit (time or printing) the customer can still use less than or equal to this value.

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.

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.

number

Filter by price charged for this extra service greater than or equal to this value.

number

Filter by price charged for this extra service less than or equal to this value.

number

Filter by price adjustment applied for last-minute bookings greater than or equal to this value.

number

Filter by price adjustment applied for last-minute bookings less than or equal to this value.

number

Filter by price adjustment applied by demand-based dynamic pricing greater than or equal to this value.

number

Filter by price adjustment applied by demand-based dynamic pricing less than or equal to this value.

number

Filter by multiplier applied for last-minute booking pricing greater than or equal to this value.

number

Filter by multiplier applied for last-minute booking pricing less than or equal to this value.

number

Filter by multiplier applied for demand-based pricing greater than or equal to this value.

number

Filter by multiplier applied for demand-based pricing less than or equal to this value.

string

Filter by date from which this credit becomes usable greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date from which this credit becomes usable less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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.

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.

string

Filter by payment due date for the charge greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by payment due date for the charge less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by amount discounted from the price greater than or equal to this value.

number

Filter by amount discounted from the price less than or equal to this value.

integer

Filter by iD of the booking that generated this charge greater than or equal to this value.

integer

Filter by iD of the booking that generated this charge less than or equal to this value.

string

Filter by start time of the booking that generated this charge greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start time of the booking that generated this charge less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end time of the booking that generated this charge greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end time of the booking that generated this charge less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

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();

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()

Filtering by CreatedOn

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

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();

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()

Range filters

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"

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();

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()

Response

200

CoworkerExtraService[]

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

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

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "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
}

Get one CoworkerExtraServiceRetrieve a single CoworkerExtraService record by its Id.

Search CoworkerExtraServices

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200