Create CoworkerTimePass

POST

api

billing

coworkertimepasses

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
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "TimePassId": 123,
    "CreateMultiple": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, BusinessId: 123, TimePassId: 123, CreateMultiple: 123})
};

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

{
  "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

integer

required

The customer who owns this time pass.

integer

required

The business (location) this time pass belongs to.

integer

required

The time pass definition this is an instance of.

integer

required

Number of time passes to create at once.

Optional Fields

string

Optional notes for this time pass.

string

Purchase order reference.

boolean

Whether this time pass has been used.

boolean

Whether this time pass is free of charge.

number

Custom price for this time pass.

string

Expiration date for this time pass.

string

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

string

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

string

Unique identifier linking this time pass to a customer contract.

Code Examples

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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkertimepasses',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      TimePassId: 0,
      CreateMultiple: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'TimePassId': 0,
        'CreateMultiple': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkertimepass was created successfully.

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": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

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

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update CoworkerTimePassUpdate an existing CoworkerTimePass record.

Create CoworkerTimePass

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
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses"

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "TimePassId": 123,
    "CreateMultiple": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerId: 123, BusinessId: 123, TimePassId: 123, CreateMultiple: 123})
};

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

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400