CoworkerProducts
Get one CoworkerProduct
Retrieve a single CoworkerProduct record by its Id.
GET
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
The Id of the CoworkerProduct record to retrieve.
Code Examples
Response
200
Coworker Id.
Coworker type.
Coworker full name.
Coworker company name.
Coworker billing name.
Coworker email.
Business Id.
Product Id.
Product name.
Product price.
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).
Product currency code.
Notes.
Purchase order.
Order number.
Whether the product is activated.
Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
Invoice this customer for this product instead of the paying member of their team.
Price override.
Quantity.
Whether this is a regular charge.
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.Number of repeat units.
Invoice on date.
Repeat from date.
Repeat until date.
Sale date.
Due date.
Whether it has been invoiced.
Date invoiced.
Whether added from tariff.
Links to the Booking that generated this sale (GUID UniqueId, not integer ID).
Mrm Reminded.
Apply pro-rating.
Links to the CoworkerContract that generated this sale (GUID UniqueId, not integer ID).
Links to the ContractDeposit that generated this sale (GUID UniqueId, not integer ID).
Links to the ContractProduct that generated this sale (GUID UniqueId, not integer ID).
Links to the CoworkerDelivery that generated this sale (GUID UniqueId, not integer ID).
Proposal Unique Id.
Coworker invoice ID.
Coworker invoice number.
Whether coworker invoice is paid.
Teams at the time of purchase.
Credit amount.
Discount amount.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response