Get one CoworkerProduct

Retrieve a single CoworkerProduct record by its Id.

GET /api/billing/coworkerproducts/{id}

Get one CoworkerProduct

cURL

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

200

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "BusinessId": 123,
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": "<string>",
  "ProductCurrencyCode": "<string>",
  "Notes": "<string>",
  "PurchaseOrder": "<string>",
  "OrderNumber": "<string>",
  "Activated": true,
  "ActivateNow": true,
  "InvoiceThisCoworker": true,
  "Price": 123,
  "Quantity": 123,
  "RegularCharge": true,
  "RepeatCycle": 123,
  "RepeatUnit": 123,
  "InvoiceOn": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "SaleDate": "<string>",
  "DueDate": "<string>",
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "FromTariff": true,
  "BookingUniqueId": "<string>",
  "MrmReminded": true,
  "ApplyProRating": true,
  "CoworkerContractUniqueId": "<string>",
  "ContractDepositUniqueId": "<string>",
  "ContractProductUniqueId": "<string>",
  "CoworkerDeliveryUniqueId": "<string>",
  "ProposalUniqueId": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "TeamsAtTheTimeOfPurchase": "<string>",
  "CreditAmount": 123,
  "DiscountAmount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

id · integer · required

The Id of the CoworkerProduct record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerproducts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

CoworkerId · integer

ID of the coworker linked to this record.

CoworkerCoworkerType · string

Coworker type.

CoworkerFullName · string

Coworker full name.

CoworkerCompanyName · string

Coworker company name.

CoworkerBillingName · string

Coworker billing name.

CoworkerEmail · string

Coworker email.

BusinessId · integer

ID of the business linked to this record.

ProductId · integer

ID of the product linked to this record.

ProductName · string

Product name.

ProductPrice · number

Product price.

ProductApplyProRating · string

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

ProductCurrencyCode · string

Product currency code.

Notes · string

Optional notes or comments about this coworker product.

PurchaseOrder · string

Purchase order.

OrderNumber · string

Order number.

Activated · boolean

Whether the product is activated.

ActivateNow · boolean

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

InvoiceThisCoworker · boolean

Invoice this customer for this product instead of the paying member of their team.

Price · number

Price override.

Quantity · integer

Number of units.

RegularCharge · boolean

Whether this is a regular charge.

RepeatCycle · integer

Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. See eRecurrentChargePattern enum values: 1 = PricePlan, 2 = Day, 3 = Week, 4 = Month, 5 = Year, 6 = LastDayOfMonth.

RepeatUnit · integer

Number of repeat units.

InvoiceOn · string

Invoice on date.

RepeatFrom · string

Repeat from date.

RepeatUntil · string

Repeat until date.

SaleDate · string

Sale date.

DueDate · string

Due date.

Invoiced · boolean

Whether it has been invoiced.

InvoicedOn · string

Date invoiced.

FromTariff · boolean

Whether added from tariff.

BookingUniqueId · string

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

MrmReminded · boolean

Whether mrm reminded is enabled.

ApplyProRating · boolean

Apply pro-rating.

CoworkerContractUniqueId · string

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

ContractDepositUniqueId · string

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

ContractProductUniqueId · string

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

CoworkerDeliveryUniqueId · string

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

ProposalUniqueId · string

ID of the proposal unique associated with this record.

CoworkerInvoiceId · integer

Coworker invoice ID.

CoworkerInvoiceNumber · string

Coworker invoice number.

CoworkerInvoicePaid · boolean

Whether coworker invoice is paid.

TeamsAtTheTimeOfPurchase · string

Teams at the time of purchase.

CreditAmount · number

Credit amount.

DiscountAmount · number

Discount amount.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "BusinessId": 0,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductApplyProRating": null,
  "ProductCurrencyCode": 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,
  "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
}