Search CoworkerProducts

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

GET /api/billing/coworkerproducts

Search CoworkerProducts

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerproducts \
  --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 CoworkerProduct is a record of a product sold to a customer as a one-off or on a recurrent basis.

RepeatCycle can only be set to PricePlan if the customer has a contract set as their main contract. In general, it is best to use ContractProduct instead of adding CoworkerProducts repeating based on PricePlan.

InvoiceThisCoworker indicates this customer should be invoiced for this product instead of the paying member of their team.

ActivateNow releases any benefits (credits or passes) even before the product is invoiced and paid.

ProductApplyProRating indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (RenewalDate) of the customer’s main contract.

Properties ending in UniqueId link the sale to the originating record using its GUID UniqueId property (not the integer ID). Only one of these will be populated per record:

UniqueId property	Source entity
CoworkerContractUniqueId	CoworkerContract
ContractDepositUniqueId	ContractDeposit
ContractProductUniqueId	ContractProduct
BookingUniqueId	Booking
CoworkerDeliveryUniqueId	CoworkerDelivery

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

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

CoworkerProduct_Coworker · integer

Filter by iD of the coworker linked to this record.

CoworkerProduct_Coworker_CoworkerType · string

Filter by coworker type.

CoworkerProduct_Coworker_FullName · string

Filter by coworker full name.

CoworkerProduct_Coworker_CompanyName · string

Filter by coworker company name.

CoworkerProduct_Coworker_BillingName · string

Filter by coworker billing name.

CoworkerProduct_Coworker_Email · string

Filter by coworker email.

CoworkerProduct_Business · integer

Filter by iD of the business linked to this record.

CoworkerProduct_Product · integer

Filter by iD of the product linked to this record.

CoworkerProduct_Product_Name · string

Filter by product name.

CoworkerProduct_Product_Price · number

Filter by product price.

CoworkerProduct_Product_ApplyProRating · string

Filter by whether the sold product is configured to prorate the price of this sale based on the prorating rules of the customer’s main contract, adjusting the price based on the number of days left until the next invoice date (RenewalDate).

CoworkerProduct_Product_Currency_Code · string

Filter by product currency code.

CoworkerProduct_Notes · string

Filter by optional notes or comments about this coworker product.

CoworkerProduct_PurchaseOrder · string

Filter by purchase order.

CoworkerProduct_OrderNumber · string

Filter by order number.

CoworkerProduct_Activated · boolean

Filter by whether the product is activated.

CoworkerProduct_ActivateNow · boolean

Filter by activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.

CoworkerProduct_InvoiceThisCoworker · boolean

Filter by invoice this customer for this product instead of the paying member of their team.

CoworkerProduct_Price · number

Filter by price override.

CoworkerProduct_Quantity · integer

Filter by number of units.

CoworkerProduct_RegularCharge · boolean

Filter by whether this is a regular charge.

CoworkerProduct_RepeatCycle · integer

Filter by repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan.

CoworkerProduct_RepeatUnit · integer

Filter by number of repeat units.

CoworkerProduct_InvoiceOn · string

Filter by invoice on date.

CoworkerProduct_RepeatFrom · string

Filter by repeat from date.

CoworkerProduct_RepeatUntil · string

Filter by repeat until date.

CoworkerProduct_SaleDate · string

Filter by sale date.

CoworkerProduct_DueDate · string

Filter by due date.

CoworkerProduct_Invoiced · boolean

Filter by whether it has been invoiced.

CoworkerProduct_InvoicedOn · string

Filter by date invoiced.

CoworkerProduct_FromTariff · boolean

Filter by whether added from tariff.

CoworkerProduct_BookingUniqueId · string

Filter by links to the Booking that generated this sale (GUID UniqueId, not integer ID).

CoworkerProduct_MrmReminded · boolean

Filter by whether mrm reminded is enabled.

CoworkerProduct_ApplyProRating · boolean

Filter by apply pro-rating.

CoworkerProduct_CoworkerContractUniqueId · string

Filter by links to the CoworkerContract that generated this sale (GUID UniqueId, not integer ID).

CoworkerProduct_ContractDepositUniqueId · string

Filter by links to the ContractDeposit that generated this sale (GUID UniqueId, not integer ID).

CoworkerProduct_ContractProductUniqueId · string

Filter by links to the ContractProduct that generated this sale (GUID UniqueId, not integer ID).

CoworkerProduct_CoworkerDeliveryUniqueId · string

Filter by links to the CoworkerDelivery that generated this sale (GUID UniqueId, not integer ID).

CoworkerProduct_ProposalUniqueId · string

Filter by iD of the proposal unique associated with this record.

CoworkerProduct_CoworkerInvoiceId · integer

Filter by coworker invoice ID.

CoworkerProduct_CoworkerInvoiceNumber · string

Filter by coworker invoice number.

CoworkerProduct_CoworkerInvoicePaid · boolean

Filter by whether coworker invoice is paid.

CoworkerProduct_TeamsAtTheTimeOfPurchase · string

Filter by teams at the time of purchase.

CoworkerProduct_CreditAmount · number

Filter by credit amount.

CoworkerProduct_DiscountAmount · number

Filter by discount amount.

Range Filters

from_CoworkerProduct_ProductPrice · number

Filter by product price greater than or equal to this value.

to_CoworkerProduct_ProductPrice · number

Filter by product price less than or equal to this value.

from_CoworkerProduct_Price · number

Filter by price override greater than or equal to this value.

to_CoworkerProduct_Price · number

Filter by price override less than or equal to this value.

from_CoworkerProduct_Quantity · integer

Filter by number of units greater than or equal to this value.

to_CoworkerProduct_Quantity · integer

Filter by number of units less than or equal to this value.

from_CoworkerProduct_RepeatUnit · integer

Filter by number of repeat units greater than or equal to this value.

to_CoworkerProduct_RepeatUnit · integer

Filter by number of repeat units less than or equal to this value.

from_CoworkerProduct_InvoiceOn · string

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

to_CoworkerProduct_InvoiceOn · string

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

from_CoworkerProduct_RepeatFrom · string

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

to_CoworkerProduct_RepeatFrom · string

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

from_CoworkerProduct_RepeatUntil · string

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

to_CoworkerProduct_RepeatUntil · string

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

from_CoworkerProduct_SaleDate · string

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

to_CoworkerProduct_SaleDate · string

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

from_CoworkerProduct_DueDate · string

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

to_CoworkerProduct_DueDate · string

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

from_CoworkerProduct_InvoicedOn · string

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

to_CoworkerProduct_InvoicedOn · string

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

from_CoworkerProduct_CoworkerInvoiceId · integer

Filter by coworker invoice ID greater than or equal to this value.

to_CoworkerProduct_CoworkerInvoiceId · integer

Filter by coworker invoice ID less than or equal to this value.

from_CoworkerProduct_CreditAmount · number

Filter by credit amount greater than or equal to this value.

to_CoworkerProduct_CreditAmount · number

Filter by credit amount less than or equal to this value.

from_CoworkerProduct_DiscountAmount · number

Filter by discount amount greater than or equal to this value.

to_CoworkerProduct_DiscountAmount · number

Filter by discount amount less than or equal to this value.

from_CoworkerProduct_CreatedOn · string

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

to_CoworkerProduct_CreatedOn · string

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

from_CoworkerProduct_UpdatedOn · string

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

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

Filtering by CreatedOn

cURL

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

Range filters

cURL

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"

Response

200

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

Partial records — The listing endpoint returns a summary representation of each CoworkerProduct. The following fields are not populated in the Records[] response: Notes, PurchaseOrder, ActivateNow, InvoiceThisCoworker, CreditAmount, DiscountAmount.

To get all fields, fetch the full record using the Get one CoworkerProduct 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": [
    {
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerEmail": null,
      "BusinessId": 0,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductApplyProRating": null,
      "ProductCurrencyCode": null,
      "OrderNumber": null,
      "Activated": 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,
      "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": "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
}