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>",
  "TariffIsVirtualOffice": true,
  "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 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-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 location that issued this contract; it is supplied from the agent’s current location context..

string

Display value for IssuedBy.Name..

integer

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..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.Email..

boolean

Display value for Coworker.Active..

integer

ID of the plan assigned to this contract; its billing interval, price override rules, policies, and plan-based access or eligibility govern the customer..

string

Display value for Tariff.Name..

integer

Display value for Tariff.InvoiceEvery..

integer

Display value for Tariff.InvoiceEveryWeeks..

number

Display value for Tariff.Price..

string

Display value for Tariff.Currency.Code..

boolean

Display value for Tariff.IsVirtualOffice..

integer

ID of the plan scheduled to replace the current plan at a future renewal; leave empty when no change is scheduled..

string

Display value for NextTariff.Name..

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..

integer

Day of each month to bill this contract, from 1 through 28; scheduled monthly price changes must use this day..

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..

integer

Number of plan units on the contract, at least 1; it multiplies price, included time, and contract value..

boolean

Whether the contract is currently active; this is system-managed status and cannot be changed directly..

boolean

Whether this is the customer’s main contract; use the dedicated set-main-contract action to change it..

boolean

Whether the contract has been cancelled; use the dedicated cancellation action rather than changing this status..

string

Customer purchase-order reference for this contract..

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

Timestamp recorded when the customer accepted the plan terms; it is an audit value and cannot be changed directly..

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..

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..

integer

Preferred handling for delivered mail: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..

integer

Preferred handling for delivered parcels: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..

integer

Preferred handling for delivered publicity: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown..

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

Integration-managed identifier of the source proposal; it is read-only and cannot be changed through contract administration..

string

Integration-managed identifier of the related proposal contract; it is read-only and cannot be changed through contract administration..

string

Integration-managed identifier of the related course member; it is read-only and cannot be changed through contract administration..

string

Location-timezone projection of the system-maintained InvoicedPeriod cutoff; do not set it directly..

string

Read-only denormalized IDs of assigned floor-plan units; update Desks rather than this projection..

string

Read-only denormalized names of assigned floor-plan units; update Desks rather than this projection..

string

Read-only denormalized IDs of assigned floor-plan unit variants; update Variants rather than this projection..

string

Read-only denormalized names of assigned floor-plan unit variants; update Variants rather than this projection..

number

System-calculated total including the contract price, products, deposits, and quantity; update the contributing records instead..

number

System-calculated total including the contract price, products, and quantity; update the contributing records instead..

string

Post-office box number associated with this contract..

boolean

Whether the contract is currently within a recorded pause period; it is calculated from pause-period records..

string

Calculated UTC start of the active or upcoming pause period; manage pause records instead..

string

Calculated UTC end of the active or upcoming pause period; manage pause records instead..

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": null,
  "TariffCurrencyCode": null,
  "TariffIsVirtualOffice": 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 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>",
  "TariffIsVirtualOffice": true,
  "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