Create CoworkerTimePass

Create a new CoworkerTimePass record.

POST /api/billing/coworkertimepasses

Create CoworkerTimePass

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkertimepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "TimePassId": 123,
  "CreateMultiple": 123
}
'

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CoworkerTimePass represents a time pass assigned to a customer. Time passes can be assigned directly, granted by a product purchase (CoworkerProductUniqueId), or included in a pricing plan (TariffTimePassUniqueId).

Each time pass tracks its usage status (Used, UsedDate), remaining and total uses, and whether the customer is currently checked in. Time passes may have an expiration date and can be free or priced.

Use CreateMultiple when creating to issue several time passes at once. The IsFromTariff and IsPayAsYouGo flags indicate the origin and billing model of the time pass.

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 CoworkerTimePass-Create role.

Request Body

Required Fields

CoworkerId · integer · required

The customer who owns this time pass.

BusinessId · integer · required

The business (location) this time pass belongs to.

TimePassId · integer · required

The time pass definition this is an instance of.

CreateMultiple · integer · required

Number of time passes to create at once.

Optional Fields

Notes · string

Optional notes for this time pass.

PurchaseOrder · string

Purchase order reference.

Used · boolean

Whether this time pass has been used.

Free · boolean

Whether this time pass is free of charge.

Price · number

Custom price for this time pass.

ExpireDate · string

Expiration date for this time pass.

TariffTimePassUniqueId · string

Unique identifier linking this time pass to a tariff time pass allocation.

CoworkerProductUniqueId · string

Unique identifier linking this time pass to a customer product purchase.

CoworkerContractUniqueId · string

Unique identifier linking this time pass to a customer contract.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkertimepasses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "TimePassId": 0,
    "CreateMultiple": 0
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the coworkertimepass was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerTimePass was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

A summary of the validation error(s), in the format PropertyName: error message.

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}