CoworkerContracts
Get one CoworkerContract
Retrieve a single CoworkerContract record by its Id.
GET
A CoworkerContract is the foundation for automatic billing. It links a customer (
Coworker) to a plan (Tariff) that drives the billing frequency, benefits and default settings for the contract. A customer can hold as many contracts as needed, each pointing to the same or different plans.
A customer with at least one active contract is regarded as a Member; customers with no active contracts are Contacts. Nexudus uses this distinction to enforce policies on products, resources, events, pricing and many other entities that expose OnlyForMembers or OnlyForContacts properties.
Pricing — The contract price can be fixed (Price is not null) or derived from the plan it is for. The Value field is used in reporting to compare with the actual price. Automatic price adjustments over time can be set up via ContractSchedule child entities.
Billing cycle — RenewalDate is the date on which the contract will next be automatically invoiced; it advances automatically each time the contract is invoiced. InvoicedPeriod is the period the next invoice will cover. For a new contract these two dates are usually the same. If Tariff.AdvanceInvoiceCycles is greater than 1, Nexudus invoices several periods in one go the first time, pushing InvoicedPeriod ahead of RenewalDate from the first invoice onwards. When the contract is cancelled, Nexudus stops invoicing once InvoicedPeriod reaches the cancellation date.
Benefits — The plan may include benefits (booking credits, time passes, etc.) which are released and assigned to the contract-holder customer based on the contract cycle or other expiration criteria (month, week, day, etc.).
Cancellation — Contracts support minimum contract length (ContractTerm), cancellation policies (CancellationLimitDays, ProRateCancellation) and cancellation reasons. CancelTeamContracts can cascade cancellation to team members.
Additional charges — Contracts can optionally include products (ContractProduct entities) to be billed alongside the plan, as well as security deposits/retainers (ContractDeposit entities).
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-Read role.Path Parameters
The Id of the CoworkerContract record to retrieve.
Code Examples
Response
200
Issued By Id.
Name of the business issuing this contract.
Coworker Id.
Coworker Coworker Type.
Full name of the customer holding this contract.
Company name of the customer holding this contract.
Billing name of the customer holding this contract.
Email address of the customer holding this contract.
Coworker Active.
Tariff Id.
Name of the plan this contract is for.
Tariff Invoice Every.
Tariff Invoice Every Weeks.
Default price of the plan. Used when the contract has no fixed Price override.
Currency code of the plan.
Next Tariff Id.
Name of the next plan the contract will switch to.
Free-text notes for this contract.
Contract start date.
Day of month on which billing occurs.
Date on which the contract will next be automatically invoiced. Updated automatically every time the contract is invoiced, advancing by the plan’s renewal period.
Period the next invoice will cover. For new contracts this equals RenewalDate. If Tariff.AdvanceInvoiceCycles > 1, Nexudus invoices several periods at once on the first invoice, pushing InvoicedPeriod ahead of RenewalDate. Nexudus stops invoicing when InvoicedPeriod reaches the cancellation date.
Minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.
Fixed price override for this contract. If null, the contract uses the plan’s default price (TariffPrice).
Contract value used in reporting to compare against the actual invoiced price.
Desks.
Variants.
Quantity.
Whether the contract is active. Active contracts make the customer a Member; inactive contracts make them a Contact.
Whether this is the customer’s main contract. The main contract drives the customer’s primary plan assignment.
Whether this contract has been cancelled.
Purchase order.
Whether to include the plan’s signup fee when creating this contract.
Whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.
Whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.
Date of the next automatic invoice generation for this contract.
Whether the customer has accepted the plan’s terms and conditions.
Date on which the customer accepted the plan’s terms and conditions.
Date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.
Minimum number of days’ notice required before cancellation takes effect.
Whether to pro-rate the final invoice when the contract is cancelled mid-cycle.
Whether to cascade cancellation to contracts of team members under this customer.
Reason for cancellation.
Free-text notes about the cancellation.
Delivery handling preference for checks.
Delivery handling preference for mail.
Delivery handling preference for parcels.
Delivery handling preference for publicity.
Free-text delivery instructions for this contract’s mail handling.
Date by which identity verification checks must be completed for this contract.
Date by which address verification checks must be completed for this contract.
Start Date Local.
Renewal Date Local.
Next Auto Invoice Local.
Price Plan Terms Accepted On Local.
Cancellation Date Local.
Contract Term Local.
Unique ID of the proposal that originated this contract.
Unique ID of the proposal contract line that originated this contract.
Course Member Unique Id.
Invoiced Period Local.
Comma-separated IDs of floor-plan items assigned to this contract.
Comma-separated names of floor-plan items assigned to this contract.
Comma-separated IDs of floor-plan item variants assigned to this contract.
Comma-separated names of floor-plan item variants assigned to this contract.
Total contract price including linked products (CoworkerProducts) and security deposits.
Total contract price including linked products (CoworkerProducts) but excluding security deposits.
PO box number.
Whether the contract is currently in a paused period. Paused contracts are not invoiced.
Start date of the current pause period.
End date of the current pause period. The contract resumes billing after this date.
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