CoworkerContracts
Create CoworkerContract
Create a new CoworkerContract record.
POST
Create CoworkerContract
A contract is a customer’s plan agreement at a location. An active contract categorizes the customer as a Member; without one, they are a Contact. Its plan controls billing and can determine access, pricing, and eligibility for location services and inventory.
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 CoworkerContract-Create role.Enums
eCancellationReason
eCancellationReason
eDeliveryHandlingPreference
eDeliveryHandlingPreference
Request Body
Required Fields
integer
required
ID of the location that issued this contract; it is supplied from the agent’s current location context..
integer
required
ID of the customer this contract belongs to; a customer with an active contract is a Member, while one without an active contract is a Contact..
integer
required
ID of the plan assigned to this contract; its billing interval, price override rules, policies, and plan-based access or eligibility govern the customer..
integer
required
Day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day..
integer
required
Number of plan units on the contract, at least 1; it multiplies price, included time, and contract value..
Optional Fields
integer
ID of the plan scheduled to replace the current plan at a future renewal; leave empty when no change is scheduled..
string
Free-text internal notes about this customer contract..
string
Date when the contract begins; it is used to calculate billing and any minimum contract term..
string
System-calculated UTC date of the next plan invoice, derived from the plan, billing day, and cancellation settings..
string
System-maintained UTC cutoff for the most recently invoiced contract period; do not set it manually..
string
System-calculated UTC end of the minimum contract term; change the plan or start date instead..
number
Optional per-unit price override for this contract; when empty, the assigned plan’s price is used before applying quantity..
number
Optional per-unit contract value used for value calculations; when empty, the effective contract price is used..
integer[]
List of IDs of floor-plan units assigned to this contract; each unit must belong to a location the user can access..
integer[]
List of IDs of floor-plan unit variants assigned to this contract; each variant’s unit must belong to a location the user can access and connected to any of the desks/units associated with the contract..
string
Customer purchase-order reference for this contract..
boolean
Whether the next eligible invoice includes the plan’s sign-up fee..
boolean
Whether invoices include charges from future billing cycles when the plan permits them..
boolean
Whether the contract’s initial charges are prorated for a partial billing period..
string
System-calculated UTC date when automatic additional-charge invoicing next runs; it follows the plan’s auto-invoice settings..
boolean
Whether the customer accepted the assigned plan’s terms and conditions..
string
Optional UTC date on which the contract ends; cancellation policy and invoicing determine the earliest allowed date..
integer
Optional minimum cancellation notice in days before the next billing day; when empty, the assigned plan’s cancellation notice applies..
boolean
Whether the cancellation invoice is prorated for the unused part of the billing period..
boolean
Whether cancelling this contract also cancels the customer’s related team contracts..
integer
Reason recorded for cancellation: PriceTooHigh, NewJobRelocation, MovedToOtherSpace, ChangeWorkEnvironment, LackCommunityInterations, PoorSpaceCondition, OtherMembers, Rellocated, BusinessExpansion, Pause, Renewed, Upgraded, Downgraded, Covid19, or Other.. See
eCancellationReason? enum above.string
Free-text notes explaining the cancellation..
integer
Preferred handling for delivered checks: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. See
eDeliveryHandlingPreference? enum above.integer
Preferred handling for delivered mail: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. See
eDeliveryHandlingPreference? enum above.integer
Preferred handling for delivered parcels: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. See
eDeliveryHandlingPreference? enum above.integer
Preferred handling for delivered publicity: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown.. See
eDeliveryHandlingPreference? enum above.string
Free-text instructions for handling deliveries received for this contract..
string
Optional UTC date when identity verification is due for this contract..
string
Optional UTC date when address verification is due for this contract..
string
Location-timezone projection of StartDate, generated for display and reporting; change StartDate instead..
string
Location-timezone projection of the system-calculated RenewalDate; do not set it directly..
string
Location-timezone projection of the system-calculated NextAutoInvoice date; do not set it directly..
string
Location-timezone projection of the plan-terms acceptance timestamp; it is an audit value..
string
Location-timezone projection of CancellationDate, generated for display; change CancellationDate instead..
string
Location-timezone projection of the system-calculated ContractTerm; do not set it directly..
string
Location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly..
string
Post-office box number associated with this contract..
Children
object[]
Scheduled future price changes for this contract. Each entry sets a new Price to apply on a given date
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the creation.
object
Contains the
Id of the newly created record.boolean
true if the coworkercontract was created successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response