CoworkerProducts
Get one CoworkerProduct
Retrieve a single CoworkerProduct record by its Id.
GET
Get one CoworkerProduct
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-Read role.Path Parameters
Code Examples
Response
200
ID of the customer purchasing this product; the customer must be accessible at the selected location..
ID of the location that owns and issues this product sale; set automatically from the tool’s location context..
ID of the product being sold; the product must be available to the selected customer at this location..
Whether included benefits have been activated and granted to the customer; controlled by activation processing..
Whether to activate included passes, time credit, and booking credit immediately, before the sale is invoiced or paid..
Optional unit-price override in the product currency; when omitted, the product’s current price is used, then multiplied by Quantity..
Number of product units to sell; must be at least 1 and multiplies price and included benefits..
Whether this is a recurring product sale rather than a one-off sale; requires scheduling values for non-PricePlan repeat cycles..
Recurring schedule pattern: PricePlan, Day, Week, Month, Year, or LastDayOfMonth. PricePlan follows the customer’s main contract; prefer ContractProduct for plan-linked recurring products.. See
eRecurrentChargePattern enum values: 1 = PricePlan, 2 = Day, 3 = Week, 4 = Month, 5 = Year, 6 = LastDayOfMonth.Positive number of RepeatCycle units between recurring charges; required when RegularCharge is true and RepeatCycle is not PricePlan..
Date and time when this sale is next due for invoicing; required for recurring sales whose RepeatCycle is not PricePlan..
Optional date and time from which recurring invoicing begins; a future value delays activation until that date..
Optional exclusive end date for recurring invoicing; no later charge is created when the next invoicing date reaches this value..
Optional sale date for this product sale; when omitted, reports use the record creation date..
Optional date and time by which payment is due; benefits can auto-activate when it has passed and the discounted price is zero..
Internal flag showing the sale was created from a plan; manage the originating contract or ContractProduct instead..
Internal GUID link to the booking that generated this sale; manage the booking rather than setting this field..
Whether the sale price is prorated against the customer’s main contract billing period; the product’s prorating setting can also apply..
Internal GUID link to the contract that generated this sale; manage the originating contract instead..
Internal GUID link to the contract deposit that generated this sale; manage the originating deposit instead..
Internal GUID link to the ContractProduct that generated this sale; manage the originating ContractProduct instead..
Internal GUID link to the delivery record that generated this sale; managed by the delivery workflow..
Read-only internal ID of the invoice containing this sale, populated by the invoicing process..
Internal snapshot of the customer’s teams when the sale was created, populated by the create handler..
Read-only monetary amount from the customer’s available booking credit applied to this sale by the BookingProduct workflow..
Whether the deposit represented by this sale is refunded when its connected contract is cancelled; applies only to deposit products..
Example Response