CoworkerContracts
Create CoworkerContract
Create a new CoworkerContract record.
POST
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-Create role.Enums
eCancellationReason
eCancellationReason
| Value | Name |
|---|---|
| 1 | PriceTooHigh |
| 2 | NewJobRelocation |
| 3 | MovedToOtherSpace |
| 4 | ChangeWorkEnvironment |
| 5 | LackCommunityInterations |
| 6 | PoorSpaceCondition |
| 7 | OtherMembers |
| 8 | Rellocated |
| 9 | BusinessExpansion |
| 10 | Pause |
| 11 | Renewed |
| 12 | Upgraded |
| 13 | Downgraded |
| 19 | Covid19 |
| 99 | Other |
eDeliveryHandlingPreference
eDeliveryHandlingPreference
| Value | Name |
|---|---|
| 1 | StoreForCollection |
| 2 | Forward |
| 3 | OpenScanForward |
| 4 | OpenScanRecycle |
| 5 | OpenScanShred |
| 6 | OpenScanStoreForCollection |
| 7 | Recycle |
| 8 | ReturnToSender |
| 9 | Shred |
| 10 | DepositCheck |
| 11 | Unknown |
Request Body
Required Fields
Issued By Id.
Coworker Id.
Tariff Id.
Day of month on which billing occurs.
Quantity.
Optional Fields
Next Tariff Id.
Free-text notes for this contract.
Contract start date.
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.
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 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. See
eCancellationReason? enum above.Free-text notes about the cancellation.
Delivery handling preference for checks. See
eDeliveryHandlingPreference? enum above.Delivery handling preference for mail. See
eDeliveryHandlingPreference? enum above.Delivery handling preference for parcels. See
eDeliveryHandlingPreference? enum above.Delivery handling preference for publicity. See
eDeliveryHandlingPreference? enum above.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.
Invoiced Period Local.
PO box number.
Children
Scheduled future price changes for this contract. Each entry sets a new Price to apply on a given date
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coworkercontract was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response