Search CoworkerProducts

GET

api

billing

coworkerproducts

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

import requests

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

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/coworkerproducts', 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 product sale (CoworkerProduct) records a product sold to a customer, either as a one-off purchase or a recurring charge, and can grant the product’s included passes, time credit, and booking credit.

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

Enums

eRecurrentChargePattern — RepeatCycle values

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

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 customer purchasing this product; the customer must be accessible at the selected location..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.BillingName..

string

Filter by display value for Coworker.Email..

integer

Filter by iD of the location that owns and issues this product sale; set automatically from the tool’s location context..

integer

Filter by iD of the product being sold; the product must be available to the selected customer at this location..

string

Filter by display value for Product.Name..

number

Filter by display value for Product.Price..

boolean

Filter by display value for Product.ApplyProRating..

string

Filter by display value for Product.Currency.Code..

integer

Filter by display value for Product.FinancialAccount.Id..

string

Filter by display value for Product.FinancialAccount.Name..

string

Filter by display value for Product.FinancialAccount.AccountType..

string

Filter by optional internal notes about this product sale..

string

Filter by optional customer purchase-order reference for this sale..

string

Filter by read-only order reference assigned by the purchasing workflow..

boolean

Filter by whether included benefits have been activated and granted to the customer; controlled by activation processing..

boolean

Filter by whether to activate included passes, time credit, and booking credit immediately, before the sale is invoiced or paid..

boolean

Filter by whether to invoice this customer directly instead of the paying customer in their team..

number

Filter by optional unit-price override in the product currency; when omitted, the product’s current price is used, then multiplied by Quantity..

integer

Filter by number of product units to sell; must be at least 1 and multiplies price and included benefits..

boolean

Filter by whether this is a recurring product sale rather than a one-off sale; requires scheduling values for non-PricePlan repeat cycles..

integer

Filter by recurring schedule pattern: PricePlan, Day, Week, Month, Year, or LastDayOfMonth. PricePlan follows the customer’s main contract; prefer ContractProduct for plan-linked recurring products..

integer

Filter by positive number of RepeatCycle units between recurring charges; required when RegularCharge is true and RepeatCycle is not PricePlan..

string

Filter by date and time when this sale is next due for invoicing; required for recurring sales whose RepeatCycle is not PricePlan..

string

Filter by optional date and time from which recurring invoicing begins; a future value delays activation until that date..

string

Filter by optional exclusive end date for recurring invoicing; no later charge is created when the next invoicing date reaches this value..

string

Filter by optional sale date for this product sale; when omitted, reports use the record creation date..

string

Filter by optional date and time by which payment is due; benefits can auto-activate when it has passed and the discounted price is zero..

boolean

Filter by whether this sale has been included on an invoice; set by the invoicing process..

string

Filter by read-only date and time when the invoicing process invoiced this sale..

boolean

Filter by internal flag showing the sale was created from a plan; manage the originating contract or ContractProduct instead..

string

Filter by internal GUID link to the booking that generated this sale; manage the booking rather than setting this field..

boolean

Filter by internal reminder-processing flag set after product reminders are handled..

boolean

Filter by whether the sale price is prorated against the customer’s main contract billing period; the product’s prorating setting can also apply..

string

Filter by internal GUID link to the contract that generated this sale; manage the originating contract instead..

string

Filter by internal GUID link to the contract deposit that generated this sale; manage the originating deposit instead..

string

Filter by internal GUID link to the ContractProduct that generated this sale; manage the originating ContractProduct instead..

string

Filter by internal GUID link to the delivery record that generated this sale; managed by the delivery workflow..

string

Filter by internal GUID link to the proposal that created this sale; manage the proposal instead..

integer

Filter by read-only internal ID of the invoice containing this sale, populated by the invoicing process..

string

Filter by read-only invoice number containing this sale, populated by the invoicing process..

boolean

Filter by read-only payment status of the invoice containing this sale, populated from the invoice..

string

Filter by internal snapshot of the customer’s teams when the sale was created, populated by the create handler..

number

Filter by read-only monetary amount from the customer’s available booking credit applied to this sale by the BookingProduct workflow..

number

Filter by monetary discount amount applied to this sale in the invoice currency..

boolean

Filter by whether the deposit represented by this sale is refunded when its connected contract is cancelled; applies only to deposit products..

Range Filters

number

Filter by display value for Product.Price. greater than or equal to this value.

number

Filter by display value for Product.Price. less than or equal to this value.

integer

Filter by display value for Product.FinancialAccount.Id. greater than or equal to this value.

integer

Filter by display value for Product.FinancialAccount.Id. less than or equal to this value.

number

Filter by optional unit-price override in the product currency; when omitted, the product’s current price is used, then multiplied by Quantity. greater than or equal to this value.

number

Filter by optional unit-price override in the product currency; when omitted, the product’s current price is used, then multiplied by Quantity. less than or equal to this value.

integer

Filter by number of product units to sell; must be at least 1 and multiplies price and included benefits. greater than or equal to this value.

integer

Filter by number of product units to sell; must be at least 1 and multiplies price and included benefits. less than or equal to this value.

integer

Filter by positive number of RepeatCycle units between recurring charges; required when RegularCharge is true and RepeatCycle is not PricePlan. greater than or equal to this value.

integer

Filter by positive number of RepeatCycle units between recurring charges; required when RegularCharge is true and RepeatCycle is not PricePlan. less than or equal to this value.

string

Filter by date and time when this sale is next due for invoicing; required for recurring sales whose RepeatCycle is not PricePlan. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time when this sale is next due for invoicing; required for recurring sales whose RepeatCycle is not PricePlan. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date and time from which recurring invoicing begins; a future value delays activation until that date. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date and time from which recurring invoicing begins; a future value delays activation until that date. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional exclusive end date for recurring invoicing; no later charge is created when the next invoicing date reaches this value. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional exclusive end date for recurring invoicing; no later charge is created when the next invoicing date reaches this value. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional sale date for this product sale; when omitted, reports use the record creation date. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional sale date for this product sale; when omitted, reports use the record creation date. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date and time by which payment is due; benefits can auto-activate when it has passed and the discounted price is zero. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date and time by which payment is due; benefits can auto-activate when it has passed and the discounted price is zero. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only date and time when the invoicing process invoiced this sale. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only date and time when the invoicing process invoiced this sale. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only internal ID of the invoice containing this sale, populated by the invoicing process. greater than or equal to this value.

integer

Filter by read-only internal ID of the invoice containing this sale, populated by the invoicing process. less than or equal to this value.

number

Filter by read-only monetary amount from the customer’s available booking credit applied to this sale by the BookingProduct workflow. greater than or equal to this value.

number

Filter by read-only monetary amount from the customer’s available booking credit applied to this sale by the BookingProduct workflow. less than or equal to this value.

number

Filter by monetary discount amount applied to this sale in the invoice currency. greater than or equal to this value.

number

Filter by monetary discount amount applied to this sale in the invoice currency. less than or equal to this value.

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerproducts?' + 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/coworkerproducts',
    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/coworkerproducts?CoworkerProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({
    CoworkerProduct_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/coworkerproducts',
    params={
        'CoworkerProduct_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/coworkerproducts?from_CoworkerProduct_UpdatedOn=2025-01-01T00:00&to_CoworkerProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({
    from_CoworkerProduct_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerProduct_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/coworkerproducts',
    params={
        'from_CoworkerProduct_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerProduct_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerProduct[]

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

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,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerEmail": null,
      "BusinessId": 0,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": null,
      "ProductApplyProRating": null,
      "ProductCurrencyCode": null,
      "ProductFinancialAccountId": null,
      "ProductFinancialAccountName": null,
      "ProductFinancialAccountAccountType": null,
      "Notes": null,
      "PurchaseOrder": null,
      "OrderNumber": null,
      "Activated": false,
      "ActivateNow": false,
      "InvoiceThisCoworker": false,
      "Price": null,
      "Quantity": 0,
      "RegularCharge": false,
      "RepeatCycle": 0,
      "RepeatUnit": null,
      "InvoiceOn": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "SaleDate": null,
      "DueDate": null,
      "Invoiced": false,
      "InvoicedOn": null,
      "FromTariff": false,
      "BookingUniqueId": null,
      "MrmReminded": false,
      "ApplyProRating": false,
      "CoworkerContractUniqueId": null,
      "ContractDepositUniqueId": null,
      "ContractProductUniqueId": null,
      "CoworkerDeliveryUniqueId": null,
      "ProposalUniqueId": null,
      "CoworkerInvoiceId": null,
      "CoworkerInvoiceNumber": null,
      "CoworkerInvoicePaid": false,
      "TeamsAtTheTimeOfPurchase": null,
      "CreditAmount": 0,
      "DiscountAmount": 0,
      "Refundable": false,
      "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": "CoworkerProduct 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
}

Search CoworkerProducts

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

import requests

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

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/coworkerproducts', 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