Get one CoworkerContract

GET

api

billing

coworkercontracts

{id}

Get one CoworkerContract

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkercontracts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkercontracts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkercontracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "IssuedById": 123,
  "IssuedByName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerActive": true,
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffCurrencyCode": "<string>",
  "NextTariffId": 123,
  "NextTariffName": "<string>",
  "Notes": "<string>",
  "StartDate": "<string>",
  "BillingDay": 123,
  "RenewalDate": "<string>",
  "InvoicedPeriod": "<string>",
  "ContractTerm": "<string>",
  "Price": 123,
  "Value": 123,
  "Desks": [
    123
  ],
  "Variants": [
    123
  ],
  "Quantity": 123,
  "Active": true,
  "MainContract": true,
  "Cancelled": true,
  "PurchaseOrder": "<string>",
  "IncludeSignupFee": true,
  "InvoiceAdvancedCycles": true,
  "ApplyProRating": true,
  "NextAutoInvoice": "<string>",
  "PricePlanTermsAccepted": true,
  "PricePlanTermsAcceptedOn": "<string>",
  "CancellationDate": "<string>",
  "CancellationLimitDays": 123,
  "ProRateCancellation": true,
  "CancelTeamContracts": true,
  "CancellationReason": 123,
  "CancellationNotes": "<string>",
  "DeliveryHandlingPreferenceChecks": 123,
  "DeliveryHandlingPreferenceMail": 123,
  "DeliveryHandlingPreferenceParcels": 123,
  "DeliveryHandlingPreferencePublicity": 123,
  "DeliveryInstructions": "<string>",
  "IdentityChecksDueOn": "<string>",
  "AddressChecksDueOn": "<string>",
  "StartDateLocal": "<string>",
  "RenewalDateLocal": "<string>",
  "NextAutoInvoiceLocal": "<string>",
  "PricePlanTermsAcceptedOnLocal": "<string>",
  "CancellationDateLocal": "<string>",
  "ContractTermLocal": "<string>",
  "ProposalUniqueId": "<string>",
  "ProposalContractUniqueId": "<string>",
  "CourseMemberUniqueId": "<string>",
  "InvoicedPeriodLocal": "<string>",
  "FloorPlanDeskIds": "<string>",
  "FloorPlanDeskNames": "<string>",
  "FloorPlanDeskVariantIds": "<string>",
  "FloorPlanDeskVariantNames": "<string>",
  "PriceWithProductsAndDeposits": 123,
  "PriceWithProducts": 123,
  "PoBoxNumber": "<string>",
  "InPausedPeriod": true,
  "InPausedPeriodFrom": "<string>",
  "InPausedPeriodUntil": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

integer

required

The Id of the CoworkerContract record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkercontracts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkercontracts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkercontracts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the issued by linked to this record.

string

Name of the business issuing this contract.

integer

ID of the coworker linked to this record.

string

The coworker coworker type value for this coworker contract.

string

Full name of the customer holding this contract.

string

Company name of the customer holding this contract.

string

Billing name of the customer holding this contract.

string

Email address of the customer holding this contract.

boolean

Whether coworker active is enabled.

integer

ID of the tariff linked to this record.

string

Name of the plan this contract is for.

integer

The tariff invoice every value for this coworker contract.

integer

The tariff invoice every weeks value for this coworker contract.

number

Default price of the plan. Used when the contract has no fixed Price override.

string

Currency code of the plan.

integer

ID of the next tariff linked to this record.

string

Name of the next plan the contract will switch to.

string

Free-text notes for this contract.

string

Contract start date.

integer

Day of month on which billing occurs.

string

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.

string

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.

string

Minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.

number

Fixed price override for this contract. If null, the contract uses the plan’s default price (TariffPrice).

number

Contract value used in reporting to compare against the actual invoiced price.

integer[]

List of desks linked to this record.

integer[]

List of variants linked to this record.

integer

Number of units.

boolean

Whether the contract is active. Active contracts make the customer a Member; inactive contracts make them a Contact.

boolean

Whether this is the customer’s main contract. The main contract drives the customer’s primary plan assignment.

boolean

Whether this contract has been cancelled.

string

Purchase order.

Whether to include the plan’s signup fee when creating this contract.

boolean

Whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.

boolean

Whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.

string

Date of the next automatic invoice generation for this contract.

boolean

Whether the customer has accepted the plan’s terms and conditions.

string

Date on which the customer accepted the plan’s terms and conditions.

string

Date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.

integer

Minimum number of days’ notice required before cancellation takes effect.

boolean

Whether to pro-rate the final invoice when the contract is cancelled mid-cycle.

boolean

Whether to cascade cancellation to contracts of team members under this customer.

integer

Reason for cancellation.

string

Free-text notes about the cancellation.

integer

Delivery handling preference for checks.

integer

Delivery handling preference for mail.

integer

Delivery handling preference for parcels.

integer

Delivery handling preference for publicity.

string

Free-text delivery instructions for this contract’s mail handling.

string

Date by which identity verification checks must be completed for this contract.

string

Date by which address verification checks must be completed for this contract.

string

Date/time value for start date local.

string

Date/time value for renewal date local.

string

Date/time value for next auto invoice local.

string

Date/time value for price plan terms accepted on local.

string

Date/time value for cancellation date local.

string

Date/time value for contract term local.

string

Unique ID of the proposal that originated this contract.

string

Unique ID of the proposal contract line that originated this contract.

string

ID of the course member unique associated with this record.

string

Date/time value for invoiced period local.

string

Comma-separated IDs of floor-plan items assigned to this contract.

string

Comma-separated names of floor-plan items assigned to this contract.

string

Comma-separated IDs of floor-plan item variants assigned to this contract.

string

Comma-separated names of floor-plan item variants assigned to this contract.

number

Total contract price including linked products (CoworkerProducts) and security deposits.

number

Total contract price including linked products (CoworkerProducts) but excluding security deposits.

string

PO box number.

boolean

Whether the contract is currently in a paused period. Paused contracts are not invoiced.

string

Start date of the current pause period.

string

End date of the current pause period. The contract resumes billing after this date.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "IssuedById": 0,
  "IssuedByName": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "CoworkerActive": null,
  "TariffId": 0,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": 0,
  "TariffCurrencyCode": null,
  "NextTariffId": null,
  "NextTariffName": null,
  "Notes": null,
  "StartDate": null,
  "BillingDay": 0,
  "RenewalDate": null,
  "InvoicedPeriod": null,
  "ContractTerm": null,
  "Price": null,
  "Value": null,
  "Desks": [],
  "Variants": [],
  "Quantity": 0,
  "Active": false,
  "MainContract": false,
  "Cancelled": false,
  "PurchaseOrder": null,
  "IncludeSignupFee": false,
  "InvoiceAdvancedCycles": false,
  "ApplyProRating": false,
  "NextAutoInvoice": null,
  "PricePlanTermsAccepted": false,
  "PricePlanTermsAcceptedOn": null,
  "CancellationDate": null,
  "CancellationLimitDays": null,
  "ProRateCancellation": false,
  "CancelTeamContracts": false,
  "CancellationReason": 0,
  "CancellationNotes": null,
  "DeliveryHandlingPreferenceChecks": 0,
  "DeliveryHandlingPreferenceMail": 0,
  "DeliveryHandlingPreferenceParcels": 0,
  "DeliveryHandlingPreferencePublicity": 0,
  "DeliveryInstructions": null,
  "IdentityChecksDueOn": null,
  "AddressChecksDueOn": null,
  "StartDateLocal": null,
  "RenewalDateLocal": null,
  "NextAutoInvoiceLocal": null,
  "PricePlanTermsAcceptedOnLocal": null,
  "CancellationDateLocal": null,
  "ContractTermLocal": null,
  "ProposalUniqueId": null,
  "ProposalContractUniqueId": null,
  "CourseMemberUniqueId": null,
  "InvoicedPeriodLocal": null,
  "FloorPlanDeskIds": null,
  "FloorPlanDeskNames": null,
  "FloorPlanDeskVariantIds": null,
  "FloorPlanDeskVariantNames": null,
  "PriceWithProductsAndDeposits": 0,
  "PriceWithProducts": 0,
  "PoBoxNumber": null,
  "InPausedPeriod": false,
  "InPausedPeriodFrom": null,
  "InPausedPeriodUntil": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerContract Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerContractsRetrieve multiple CoworkerContract records by their Ids in a single request.

Get one CoworkerContract

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkercontracts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkercontracts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkercontracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "IssuedById": 123,
  "IssuedByName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerActive": true,
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffCurrencyCode": "<string>",
  "NextTariffId": 123,
  "NextTariffName": "<string>",
  "Notes": "<string>",
  "StartDate": "<string>",
  "BillingDay": 123,
  "RenewalDate": "<string>",
  "InvoicedPeriod": "<string>",
  "ContractTerm": "<string>",
  "Price": 123,
  "Value": 123,
  "Desks": [
    123
  ],
  "Variants": [
    123
  ],
  "Quantity": 123,
  "Active": true,
  "MainContract": true,
  "Cancelled": true,
  "PurchaseOrder": "<string>",
  "IncludeSignupFee": true,
  "InvoiceAdvancedCycles": true,
  "ApplyProRating": true,
  "NextAutoInvoice": "<string>",
  "PricePlanTermsAccepted": true,
  "PricePlanTermsAcceptedOn": "<string>",
  "CancellationDate": "<string>",
  "CancellationLimitDays": 123,
  "ProRateCancellation": true,
  "CancelTeamContracts": true,
  "CancellationReason": 123,
  "CancellationNotes": "<string>",
  "DeliveryHandlingPreferenceChecks": 123,
  "DeliveryHandlingPreferenceMail": 123,
  "DeliveryHandlingPreferenceParcels": 123,
  "DeliveryHandlingPreferencePublicity": 123,
  "DeliveryInstructions": "<string>",
  "IdentityChecksDueOn": "<string>",
  "AddressChecksDueOn": "<string>",
  "StartDateLocal": "<string>",
  "RenewalDateLocal": "<string>",
  "NextAutoInvoiceLocal": "<string>",
  "PricePlanTermsAcceptedOnLocal": "<string>",
  "CancellationDateLocal": "<string>",
  "ContractTermLocal": "<string>",
  "ProposalUniqueId": "<string>",
  "ProposalContractUniqueId": "<string>",
  "CourseMemberUniqueId": "<string>",
  "InvoicedPeriodLocal": "<string>",
  "FloorPlanDeskIds": "<string>",
  "FloorPlanDeskNames": "<string>",
  "FloorPlanDeskVariantIds": "<string>",
  "FloorPlanDeskVariantNames": "<string>",
  "PriceWithProductsAndDeposits": 123,
  "PriceWithProducts": 123,
  "PoBoxNumber": "<string>",
  "InPausedPeriod": true,
  "InPausedPeriodFrom": "<string>",
  "InPausedPeriodUntil": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200