# AI Booking Suggestions
Source: https://learn.nexudus.com/api/endpoints/ai/ai-bookings

GET /api/public/ai/bookings

# AI Booking Suggestions

Parses a natural language prompt into a structured booking intent, including time window, duration, party size, desired amenities, resource type, and notes. Use the parsed fields to prefill the bookings search UI.

## Authentication

Requires an authenticated customer session.

## Query Parameters

<ParamField type="string">
  The user's natural language booking description. Example: "A meeting room for 10 with a projector next Tuesday 3–5pm".
</ParamField>

## Response

<ResponseField name="Response" type="object">
  Structured booking intent.
</ResponseField>

<ResponseField name="Response.resource_type" type="string">
  Resource type classification, e.g. "room|Meeting Room".
</ResponseField>

<ResponseField name="Response.partySize" type="number">
  Number of attendees.
</ResponseField>

<ResponseField name="Response.durationMinutes" type="number">
  Desired booking duration in minutes.
</ResponseField>

<ResponseField name="Response.timeConstraints" type="object">
  Preferred time window.
</ResponseField>

<ResponseField name="Response.timeConstraints.kind" type="string">
  Type of time constraint (e.g., fixed, range, recurring).
</ResponseField>

<ResponseField name="Response.timeConstraints.startISO" type="string">
  ISO 8601 start datetime.
</ResponseField>

<ResponseField name="Response.timeConstraints.endISO" type="string">
  ISO 8601 end datetime.
</ResponseField>

<ResponseField name="Response.timeConstraints.recurrence" type="string">
  Recurrence rule, if applicable.
</ResponseField>

<ResponseField name="Response.location" type="string">
  Named location reference, if extracted.
</ResponseField>

<ResponseField name="Response.amenities" type="array[string]">
  Desired amenities (keys correspond to booking filters).
</ResponseField>

<ResponseField name="Response.flexibilityMinutes" type="number">
  Acceptable shift in start time, in minutes.
</ResponseField>

<ResponseField name="Response.budget" type="number">
  Optional budget indication.
</ResponseField>

<ResponseField name="Response.notes" type="string">
  Free-form notes extracted from the prompt.
</ResponseField>

## Example Response

```json theme={null}
{
  "Response": {
    "resource_type": "room|Meeting Room",
    "partySize": 10,
    "durationMinutes": 120,
    "timeConstraints": {
      "kind": "fixed",
      "startISO": "2025-10-07T15:00:00.000Z",
      "endISO": "2025-10-07T17:00:00.000Z",
      "recurrence": ""
    },
    "location": "Downtown",
    "amenities": ["VideoConferencing", "Projector"],
    "flexibilityMinutes": 30,
    "budget": 0,
    "notes": "Board presentation"
  }
}
```

## Usage in Portal

* Public Bookings – Day and duration shortcuts
  * `src/views/public/bookings/components/DayAndDurationShortCuts.tsx` (applies AI intent to querystring)

## Related Endpoints

* `GET /api/public/ai/chats/{sessionId}` – General-purpose assistant chat
* `GET /api/public/ai/tariffs` – Plan suggestions by prompt
* `GET /api/public/ai/products` – Product suggestions by prompt

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The user is not authenticated.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing or invalid prompt.
</ResponseField>


# AI Chat Session
Source: https://learn.nexudus.com/api/endpoints/ai/ai-chat

GET /api/public/ai/chats/{sessionId}

# AI Chat Session

Starts or continues an AI assistant chat session scoped to the current location. Use it to ask free-form questions about plans, products, bookings, and general portal guidance. The session is identified by a client-generated `sessionId` and can optionally include the user's geolocation to tailor suggestions to nearby locations.

Notes

* This endpoint is read-only and returns generated text.
* Pass the natural-language prompt as a query parameter.
* If latitude/longitude are provided, responses may be adjusted to the nearest location.

## Authentication

This endpoint requires an authenticated customer session (a logged-in customer of a location).

## Path Parameters

<ParamField type="string">
  Client-generated unique session identifier (for example, a UUID) that keeps the context across requests in the same conversation.
</ParamField>

## Query Parameters

<ParamField type="string">
  The user's natural language question or instruction to the assistant.
</ParamField>

<ParamField type="number">
  Optional current latitude to personalize responses.
</ParamField>

<ParamField type="number">
  Optional current longitude to personalize responses.
</ParamField>

## Response

<ResponseField name="Response" type="string">
  AI-generated reply text. Can include markdown.
</ResponseField>

## Example Response

```json theme={null}
{
  "Response": "You can book a meeting room tomorrow afternoon. Would you like me to filter 8–10 people rooms with video conferencing?"
}
```

## Usage in Portal

This endpoint is used by the floating AI assistant available across the portal:

* Layouts
  * `src/layouts/DefaultLayout.tsx` (global assistant button)
  * `src/layouts/FullPageLayout.tsx` (global assistant button)
* Dock
  * `src/components/Dock/DockSection.tsx` (mobile dock integration)
* Chat manager
  * `src/components/ai/AiChatManager.tsx` (session handling and message flow)

## Related Endpoints

* `GET /api/public/ai/tariffs` – Plan suggestions by prompt
* `GET /api/public/ai/products` – Product suggestions by prompt
* `GET /api/public/ai/bookings` – Booking suggestion intent parsing

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The user is not authenticated as a customer of a location.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing or invalid parameters (e.g., no prompt provided).
</ResponseField>


# AI Product Suggestions
Source: https://learn.nexudus.com/api/endpoints/ai/ai-products

GET /api/public/ai/products

# AI Product Suggestions

Returns AI-generated suggestions for which store products (time passes, credits, etc.) best match a natural language prompt. The response includes both an explanation and a list of preferred product IDs.

## Authentication

Requires an authenticated customer session.

## Query Parameters

<ParamField type="string">
  The user's natural language question or preference description. Example: "What's the most affordable product with weekend access?"
</ParamField>

## Response

<ResponseField name="Response" type="object">
  AI result wrapper.
</ResponseField>

<ResponseField name="Response.Answer" type="string">
  Human-readable explanation answering the prompt.
</ResponseField>

<ResponseField name="Response.PreferredProductIds" type="array[number]">
  Product IDs recommended by the assistant.
</ResponseField>

## Example Response

```json theme={null}
{
  "Response": {
    "Answer": "The 10-day pass is the most cost-effective for occasional weekend use.",
    "PreferredProductIds": [201, 208, 245]
  }
}
```

## Usage in Portal

* Public Checkout – Products grid
  * `src/views/public/checkout/products/ProductsGrid.tsx` (filters product list by AI)
  * `src/views/checkout/steps/components/ProductAiPrompt.tsx`

## Related Endpoints

* `GET /api/public/ai/tariffs` – Plan suggestions by prompt
* `GET /api/public/ai/bookings` – Booking intent parsing and suggestions
* `GET /api/public/ai/chats/{sessionId}` – General-purpose assistant chat

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The user is not authenticated.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing or invalid prompt.
</ResponseField>


# AI Plan Suggestions
Source: https://learn.nexudus.com/api/endpoints/ai/ai-tariffs

GET /api/public/ai/tariffs

# AI Plan Suggestions

Returns AI-generated suggestions for which membership plans are most suitable based on a natural language prompt.

The response includes an explanation and a list of preferred plan IDs that you can use to filter or preselect plans in the UI.

Terminology

* We refer to locations (backend term: businesses) as locations in this documentation.
* We refer to customers (backend term: coworkers) as customers in this documentation.

## Authentication

Requires an authenticated customer session.

## Query Parameters

<ParamField type="string">
  The user's natural language question or preference description. Example: "Which plan is best if I work 3 days a week and need meeting room access?"
</ParamField>

## Response

<ResponseField name="Response" type="object">
  AI result wrapper.
</ResponseField>

<ResponseField name="Response.Answer" type="string">
  Human-readable explanation answering the prompt.
</ResponseField>

<ResponseField name="Response.PreferredPlanIds" type="array[number]">
  List of plan IDs recommended by the assistant.
</ResponseField>

## Example Response

```json theme={null}
{
  "Response": {
    "Answer": "Based on your requirements, our Part-Time plan with meeting room add-ons is a great fit.",
    "PreferredPlanIds": [123, 456]
  }
}
```

## Usage in Portal

* Checkout – Plan selection step
  * `src/views/checkout/steps/TariffSignupStep.tsx` (filters visible plans by AI)
  * `src/views/checkout/steps/components/TariffAiPrompt.tsx`

## Related Endpoints

* `GET /api/public/ai/products` – Product suggestions by prompt
* `GET /api/public/ai/bookings` – Booking intent parsing and suggestions
* `GET /api/public/ai/chats/{sessionId}` – General-purpose assistant chat

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The user is not authenticated.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing or invalid prompt.
</ResponseField>


# Active Announcements
Source: https://learn.nexudus.com/api/endpoints/announcements/active-announcements

GET /api/public/announcements/active
Returns all currently active announcements for the location.

# Active Announcements

Returns all announcements that are currently active and visible to members. Used to display notification banners or announcement widgets on the dashboard.

## Authentication

Requires a valid customer bearer token.

## Response

Returns an array of active announcement objects.

## Examples

### Fetch active announcements

```http theme={null}
GET /api/public/announcements/active
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.announcements.active)
```


# Announcement URL Visit
Source: https://learn.nexudus.com/api/endpoints/announcements/announcement-url

POST /api/public/announcements/visitUrl
Records a click-through on an announcement link.

# Announcement URL Visit

Records that a customer clicked through on an announcement's external URL. Used for tracking engagement with announcements.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number">
  Numeric identifier of the announcement.
</ParamField>

## Response

Returns the external URL to open in the browser.

<ResponseField name="Url" type="string">
  The external URL associated with the announcement. The portal opens this in a new tab via `window.open()`.
</ResponseField>

## Examples

### Track announcement click

```http theme={null}
POST /api/public/announcements/visitUrl?id=10
Authorization: Bearer {token}
```

```json theme={null}
{
  "Url": "https://example.com/promo"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.post<{ Url: string }>(endpoints.announcements.url(10))
window.open(response.data.Url, '_blank')
```


# Get Article Details
Source: https://learn.nexudus.com/api/endpoints/articles/article-details

GET /api/public/blogPosts/{postId}
Returns the full content of a single article.

# Get Article Details

Returns the full content and metadata for a specific article. Used to render the article detail page.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the article. Returned as `Id` from `GET /api/public/blogPosts`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Title,SummaryText,FullText,PublishDate,BlogCategories`.
</ParamField>

## Response

Returns an article object with full content.

<ResponseField name="Id" type="number">
  Unique identifier for the article.
</ResponseField>

<ResponseField name="Title" type="string">
  Post title.
</ResponseField>

<ResponseField name="FullText" type="string">
  Full post content. May contain HTML.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short summary shown in list views.
</ResponseField>

<ResponseField name="PublishDate" type="string">
  Publication date in ISO 8601 format.
</ResponseField>

<ResponseField name="HasLargeImage" type="boolean">
  Whether the post has a header image.
</ResponseField>

## Examples

### Fetch an article

```http theme={null}
GET /api/public/blogPosts/55
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.blog.details(55))
```


# Delete Article Comment
Source: https://learn.nexudus.com/api/endpoints/articles/delete-comment

DELETE /api/public/blogPosts/{postId}/comments/{commentId}
Deletes a comment from an article.

# Delete Article Comment

Removes a specific comment from an article. Only the comment author or an administrator can delete a comment.

## Authentication

Requires a valid customer bearer token. The customer must be the comment author.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the article.
</ParamField>

<ParamField type="number">
  Numeric identifier of the comment to delete.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Delete a comment

```http theme={null}
DELETE /api/public/blogPosts/55/comments/103
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.blog.deleteComment(55, 103))
```


# List Articles
Source: https://learn.nexudus.com/api/endpoints/articles/list-articles

GET /api/public/blogPosts
Returns a paginated list of published articles with optional filtering by category, keyword, and featured status.

# List Articles

Returns a paginated list of published articles for the current location. Supports filtering by category, keyword search, and featured flag.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="number">
  1-based page number.
</ParamField>

<ParamField type="number">
  Number of posts per page.
</ParamField>

<ParamField type="number">
  Filter to posts belonging to a specific category. Omit to return posts across all categories.
</ParamField>

<ParamField type="string">
  Keyword filter applied to post title and body. URL-encoded.
</ParamField>

<ParamField type="boolean">
  When `true`, returns only articles marked as featured by the operator.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=BlogPosts.Records.Title,BlogPosts.Records.SummaryText,BlogPosts.Records.PublishDate`.
</ParamField>

## Response

Returns a `BlogPostList` object containing paginated articles, available categories, and the currently selected category.

<ResponseField name="BlogPosts" type="ApiListResult<BlogPost>">
  Paginated wrapper containing article records.
</ResponseField>

<ResponseField name="BlogPosts.Records" type="BlogPost[]">
  Array of article summaries for the current page.
</ResponseField>

<ResponseField name="BlogPosts.CurrentPage" type="number">
  Current page number.
</ResponseField>

<ResponseField name="BlogPosts.TotalItems" type="number">
  Total number of matching posts.
</ResponseField>

<ResponseField name="BlogPosts.TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="BlogPosts.HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="Categories" type="BlogCategory[]">
  Array of all available article categories.
</ResponseField>

<ResponseField name="Category" type="BlogCategory">
  The currently selected category (when filtering by `categoryId`).
</ResponseField>

## Examples

### Fetch first page of posts

```http theme={null}
GET /api/public/blogPosts?page=1&top=10
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: posts } = useTypedData(
  httpClient,
  endpoints.blog.blogPosts({
    page: 1,
    top: 10,
    featured: true,
  }),
)
```


# Post Article Comment
Source: https://learn.nexudus.com/api/endpoints/articles/new-comment

POST /api/public/blogPosts/{postId}/comments
Posts a new comment on a published article on behalf of the authenticated customer.

# Post Article Comment

Submits a new comment on a published article. Only available when comments are enabled for the post.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the article. Returned as `Id` from `GET /api/public/blogPosts`.
</ParamField>

## Request Body

<ParamField type="string">
  The text body of the comment.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Post a comment

```http theme={null}
POST /api/public/blogPosts/55/comments
Authorization: Bearer {token}
Content-Type: application/json

{
  "comment": "Great article, very helpful tips!"
}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.blog.newComment(55), {
  comment: 'Great article, very helpful tips!',
})
```


# Exchange JWT
Source: https://learn.nexudus.com/api/endpoints/auth/exchange-jwt

POST /api/sys/users/exchange
Exchange a short-lived JWT issued by a Nexudus server-side flow for a bearer token that authenticates subsequent API requests.

# Exchange JWT

Converts a one-time JWT — issued during sign-up, email verification, password reset, or magic-link flows — into a standard bearer token and refresh token pair. The portal calls this immediately after any server-side operation that returns a raw JWT, so the customer is signed in without ever entering their password.

<Note>
  This endpoint is intended for server-issued JWTs passed back to the client (e.g. as part of a sign-up response). It is **not** for exchanging a
  customer's email and password — use `POST /api/token` for credential-based sign-in.
</Note>

## Authentication

No authentication required. The JWT in the `token` parameter acts as the credential.

## Query Parameters

<ParamField type="string">
  The short-lived JWT to exchange. URL-encode this value. Obtained from server-side flows such as the sign-up response (`Token` field) or a magic-link
  email.
</ParamField>

<ParamField type="number">
  Lifetime of the issued bearer token in minutes. The portal passes `1440` (24 hours) for standard sign-in sessions.
</ParamField>

## Response

<ResponseField name="token" type="string">
  Bearer token to include in the `Authorization` header of all subsequent authenticated requests.
</ResponseField>

<ResponseField name="token_type" type="string">
  Token scheme. Always `bearer`.
</ResponseField>

<ResponseField name="expires_in" type="number">
  Lifetime of the bearer token in seconds.
</ResponseField>

<ResponseField name="refresh_token" type="string">
  Token used to obtain a new bearer token after it expires without requiring the customer to re-authenticate.
</ResponseField>

## Examples

### Exchange a JWT after sign-up

```http theme={null}
POST /api/sys/users/exchange?token=eyJhbGciOiJSUzI1NiJ9...&validForInMinutes=1440
```

```json theme={null}
{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86400,
  "refresh_token": "7kMpQxRtZn2"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { ExchangedToken } from '@/states/useAuthContext'

// `rawJwt` is the `Token` field returned by e.g. the sign-up endpoint
const response = await httpClient.post<ExchangedToken>(endpoints.system.auth.login(rawJwt))

if (response.data.token) {
  await saveSession({
    tokenResponse: {
      access_token: response.data.token,
      token_type: response.data.token_type,
      expires_in: response.data.expires_in,
      refresh_token: response.data.refresh_token,
    },
  })
}
```

The endpoint key `endpoints.system.auth.login(token)` builds the URL as:

```
/api/sys/users/exchange?token=${encodeURIComponent(token)}&validForInMinutes=1440
```

## Usage in Portal

| Context                                        | Source file                                           |
| ---------------------------------------------- | ----------------------------------------------------- |
| Magic-link / email-verification sign-in        | `src/states/useAuthContext.tsx` (`exchangeToken`)     |
| Sign-up flow — embedded checkout (`/checkout`) | `src/views/checkout/SignupUserPage.tsx`               |
| Sign-up flow — public checkout (`/join`)       | `src/views/public/checkout/components/SignupForm.tsx` |

## Use Cases

### Authenticating API requests on behalf of a customer

After a server-side flow (sign-up, email verification, password reset, or magic link) issues a JWT, exchange it for a bearer token to make authenticated API requests on the customer's behalf:

```typescript theme={null}
// `rawJwt` is the token from the server-side flow (e.g., sign-up response)
const response = await httpClient.post(endpoints.system.auth.login(rawJwt))

// Use the bearer token for subsequent API calls
const { access_token, refresh_token } = response.data

httpClient.defaults.headers.common['Authorization'] = `Bearer ${access_token}`

// Now all requests are authenticated as the customer
await httpClient.get('/api/coworkers/me')
```

The returned `access_token` is valid for the duration specified in `expires_in` (default 24 hours). Use `POST /api/token` with `grant_type=refresh_token` to renew it before expiration.

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The `token` parameter is missing, malformed, or has already been used. The JWT issued by Nexudus flows is single-use and expires quickly.
</ResponseField>

<ResponseField name="401 Unauthorized" type="error">
  The JWT signature is invalid or it was issued for a different Nexudus space.
</ResponseField>

## Related Endpoints

| Method | Endpoint                               | Description                                                    |
| ------ | -------------------------------------- | -------------------------------------------------------------- |
| `POST` | `/api/token`                           | Exchange a customer's email and password for a bearer token    |
| `POST` | `/api/sys/users/token/refresh`         | Obtain a new bearer token using a refresh token                |
| `GET`  | `/api/sys/users/impersonate`           | Issue an impersonation token for a specific customer           |
| `POST` | `/api/sys/users/startPasswordReset`    | Trigger the password-reset email (returns a JWT for this flow) |
| `POST` | `/api/sys/users/completePasswordReset` | Complete password reset and exchange the resulting JWT         |


# Get a bearer token
Source: https://learn.nexudus.com/api/endpoints/auth/get-token

POST /api/token
Exchange a customer email and password for a bearer token used to authenticate all subsequent API requests.

# Get a bearer token

Exchanges a customer's email address and password for a short-lived bearer token and a refresh token. Every authenticated API call in the Members Portal uses the `access_token` returned here as a `Bearer` credential. Pass `totp` when the customer has two-factor authentication enabled — omitting it when 2FA is active will return a `two_factor_auth_check` error.

<Note>
  Unlike most Nexudus API endpoints, this request must be encoded as `application/x-www-form-urlencoded`, **not** `application/json`. Sending a JSON
  body will result in an `unsupported_grant_type` error.
</Note>

## Authentication

No authentication required. This is the endpoint that issues credentials.

## Request Body

<ParamField type="string">
  Grant flow to use. Must be `password` for email/password authentication.
</ParamField>

<ParamField type="string">
  The customer's email address.
</ParamField>

<ParamField type="string">
  The customer's password.
</ParamField>

<ParamField type="string">
  Time-based One-Time Password for two-factor authentication. Required when the customer has 2FA enabled; omit otherwise.
</ParamField>

## Headers

<ParamField type="string">
  A unique identifier for the client application or integration. If omitted, this defaults to the customer's email address, which you must then use as the `client_id` when refreshing the token.
</ParamField>

## Response

<ResponseField name="access_token" type="string">
  Bearer token to include in the `Authorization` header of all subsequent authenticated requests.
</ResponseField>

<ResponseField name="token_type" type="string">
  Token scheme. Always `bearer`.
</ResponseField>

<ResponseField name="expires_in" type="number">
  Lifetime of the access token in seconds.
</ResponseField>

<ResponseField name="refresh_token" type="string">
  Token used to obtain a new `access_token` after it expires, without requiring the customer to re-enter their password.
</ResponseField>

## Examples

### Successful sign-in

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=jane.doe%40example.com&password=S3cur3P%40ss
```

### Sign-in with client identifier

Providing a `client_id` is optional. If you provide one, you must use the same value when refreshing the token. If omitted, the customer's email address is used as the `client_id`, which you must then pass to the refresh endpoint.

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded
client_id: my-app-identifier

grant_type=password&username=jane.doe%40example.com&password=S3cur3P%40ss
```

```json theme={null}
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86400,
  "refresh_token": "8xLOxBtZp8"
}
```

### Sign-in with two-factor authentication

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=jane.doe%40example.com&password=S3cur3P%40ss&totp=482910
```

```json theme={null}
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86400,
  "refresh_token": "8xLOxBtZp8"
}
```

## TypeScript Integration

```typescript theme={null}
import { type AxiosResponse } from 'axios'
import qs from 'qs'
import { AuthToken } from '@/states/useAuthContext'

const data = {
  grant_type: 'password',
  username: values.email,
  password: values.password,
  totp: values.totp,
}

const res: AxiosResponse<AuthToken> = await httpClient.post('/api/token', qs.stringify(data), {
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'client_id': values.clientId, // or email if omitted during sign-in
  },
})

if (res.data.access_token) {
  saveSession({ tokenResponse: res.data, remember: values.rememberMe })
}
```

## Usage in Portal

| Context                  | Source file                          |
| ------------------------ | ------------------------------------ |
| Sign-in page (`/signin`) | `src/views/auth/SignIn/useSignIn.ts` |

## Error Responses

<ResponseField name="400 Bad Request — unsupported_grant_type" type="error">
  The `grant_type` field is missing or the body was not encoded as `application/x-www-form-urlencoded`.
</ResponseField>

<ResponseField name="400 Bad Request — invalid_grant" type="error">
  Credentials are incorrect, the customer is not registered with this location, or the account has been suspended. The `error_description` field
  contains a human-readable reason.
</ResponseField>

<ResponseField name="400 Bad Request — two_factor_auth_check" type="error">
  The customer has 2FA enabled but `totp` was not supplied or the supplied code is invalid. Prompt the customer for their one-time code and retry.
</ResponseField>

<ResponseField name="400 Bad Request — must_reset_password" type="error">
  The customer is required to reset their password before signing in. The `error_description` field contains a password-reset token to pass to the
  reset-password flow.
</ResponseField>

## Related Endpoints

| Method | Endpoint                       | Description                                               |
| ------ | ------------------------------ | --------------------------------------------------------- |
| `POST` | `/api/token`                   | *(this endpoint)* Exchange credentials for a bearer token |
| `GET`  | `/api/public/billing/customer` | Retrieve the authenticated customer's profile             |
| `GET`  | `/api/public/teams/my`         | List teams the authenticated customer belongs to          |


# Refresh a bearer token
Source: https://learn.nexudus.com/api/endpoints/auth/refresh-bearer-token

POST /api/token
Use an existing refresh token to obtain a new access token and refresh token without requiring the customer to re-enter their password.

# Refresh a bearer token

Uses a refresh token to obtain a new access token and refresh token without requiring the customer to re-enter their password. This is useful when the access token has expired but you want to maintain the customer's session.

<Note>
  Unlike most Nexudus API endpoints, this request must be encoded as `application/x-www-form-urlencoded`, **not** `application/json`. Sending a JSON
  body will result in an `unsupported_grant_type` error.
</Note>

## Authentication

No authentication required. This endpoint uses the refresh token itself as the credential.

## Request Body

<ParamField type="string">
  Must be `refresh_token` to use the refresh token grant flow.
</ParamField>

<ParamField type="string">
  The refresh token previously received from the sign-in endpoint.
</ParamField>

## Headers

<ParamField type="string">
  The client identifier that was used when obtaining the bearer token. If the `client_id` was provided during sign-in, use that value. If `client_id` was omitted during sign-in, use the customer's email address (which defaults to the `client_id` automatically).
</ParamField>

## Response

<ResponseField name="access_token" type="string">
  New bearer token to include in the `Authorization` header of all subsequent authenticated requests.
</ResponseField>

<ResponseField name="token_type" type="string">
  Token scheme. Always `bearer`.
</ResponseField>

<ResponseField name="expires_in" type="number">
  Lifetime of the new access token in seconds.
</ResponseField>

<ResponseField name="refresh_token" type="string">
  New refresh token to use for subsequent refresh operations. The previous refresh token is invalidated.
</ResponseField>

## Examples

### Successful token refresh

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded
client_id: jane.doe@example.com

grant_type=refresh_token&refresh_token=8xLOxBtZp8
```

```json theme={null}
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86400,
  "refresh_token": "9yMPyCuQr9"
}
```

## TypeScript Integration

```typescript theme={null}
import { type AxiosResponse } from 'axios'
import qs from 'qs'
import { type AuthToken } from '@/states/useAuthContext'

const data = {
  grant_type: 'refresh_token',
  refresh_token: session.refreshToken,
}

const res: AxiosResponse<AuthToken> = await httpClient.post('/api/token', qs.stringify(data), {
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'client_id': session.clientId, // or email if client_id was omitted during sign-in
  },
})

if (res.data.access_token) {
  saveSession({ tokenResponse: res.data, remember: values.rememberMe })
}
```

## Error Responses

<ResponseField name="400 Bad Request — unsupported_grant_type" type="error">
  The `grant_type` field is missing or the body was not encoded as `application/x-www-form-urlencoded`.
</ResponseField>

<ResponseField name="400 Bad Request — invalid_grant" type="error">
  The refresh token is invalid, expired, or has already been used. The `error_description` field contains a human-readable reason.
</ResponseField>

## Related Endpoints

| Method | Endpoint                       | Description                                               |
| ------ | ------------------------------ | --------------------------------------------------------- |
| `POST` | `/api/token`                   | *(this endpoint)* Exchange credentials for a bearer token |
| `POST` | `/api/sys/users/token/refresh` | Get a short-lived server-side JWT for authenticated links |


# Refresh JWT access token
Source: https://learn.nexudus.com/api/endpoints/auth/refresh-token

POST /api/sys/users/token/refresh
Refresh the current user JWT access token with an optional custom validity period.

# Refresh JWT access token

Refreshes the authenticated user's JWT access token, generating a new token and returning it in the response. This is useful when you need a fresh token with a different validity period than the original.

## Authentication

Requires a valid customer bearer token via the `Authorization` header.

## Request Body

<RequestBodyField name="ValidityInMinutes" type="number">
  Optional. The validity period of the new token in minutes. Defaults to `30` if omitted or `null`.
</RequestBodyField>

## Response

Returns an `ActionConfirmation` envelope.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the token was refreshed successfully.
</ResponseField>

<ResponseField name="Value" type="string | null">
  The new JWT access token string. Use this as the `Authorization: Bearer` value for subsequent API requests. `null` when `WasSuccessful` is `false`.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the response body. `200` on success, `500` on failure.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `"OK"` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation or server errors. `null` on success.
</ResponseField>

## Examples

### Refresh with default validity (30 minutes)

```http theme={null}
POST /api/sys/users/token/refresh
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{}
```

```json theme={null}
{
  "WasSuccessful": true,
  "Value": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.new_refreshed_token...",
  "Status": 200,
  "Message": "OK",
  "Errors": null
}
```

### Refresh with custom validity (60 minutes)

```http theme={null}
POST /api/sys/users/token/refresh
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{
  "ValidityInMinutes": 60
}
```

```json theme={null}
{
  "WasSuccessful": true,
  "Value": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.new_60min_token...",
  "Status": 200,
  "Message": "OK",
  "Errors": null
}
```

## Admin Endpoint: Refresh Another User's Token

An admin variant of this endpoint exists at `POST /api/sys/users/{id}/token/refresh` which allows refreshing the token for a specific user by ID.

### Authentication

Requires a bearer token with `ADMIN` role or `User-Edit` permission.

### URL Parameter

<UrlParameter name="id" type="integer">
  The ID of the user whose token should be refreshed.
</UrlParameter>

### Request Body

Same as the current-user endpoint — optional `ValidityInMinutes`.

### Example

```http theme={null}
POST /api/sys/users/42/token/refresh
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.admin_token...
Content-Type: application/json

{
  "ValidityInMinutes": 60
}
```

## Use Cases

### Extending token validity

When the default token validity is insufficient for a long-running operation, request a fresh token with an extended validity period:

```typescript theme={null}
const response = await fetch('/api/sys/users/token/refresh', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${currentToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ ValidityInMinutes: 120 })
})

const result = await response.json()
if (result.WasSuccessful) {
  const newToken = result.Value
  // Use newToken for subsequent requests
}
```

### Token rotation

Periodically refresh the access token to maintain a fresh validity window without requiring the user to re-authenticate.

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid. The user must sign in again via `POST /api/token`.
</ResponseField>

<ResponseField name="AccessDenied" type="error">
  Returned when the authenticated user cannot be resolved from the token, or (for the admin endpoint) when the admin lacks access to the target user.
</ResponseField>

## Related Endpoints

| Method | Endpoint                            | Description                                                             |
| ------ | ----------------------------------- | ----------------------------------------------------------------------- |
| `POST` | `/api/token`                        | Exchange email and password (or a refresh token) for a new bearer token |
| `POST` | `/api/sys/users/exchange`           | Exchange a server-issued JWT for a bearer token                         |
| `POST` | `/api/sys/users/{id}/token/refresh` | Admin: refresh another user's token                                     |
| `GET`  | `/api/auth/media/customer`          | Obtain a short-lived JWT for accessing protected media files            |


# Get Contract Details
Source: https://learn.nexudus.com/api/endpoints/billing/contract-details

GET /api/public/billing/coworkerContracts/{contractId}

# Get Contract Details

Retrieves a single plan contract for the currently authenticated customer. Contracts represent the customer's active plan subscription, including pricing, billing cycle, renewal dates, and pause/cancellation state.

## Authentication

This endpoint requires an authenticated customer session. The contract must belong to the current customer or to a team the customer manages.

## Path Parameters

<ParamField type="number">
  The unique identifier of the contract to retrieve.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Tariff.Name,Price,PriceFormatted,Active,StartDate,RenewalDate`.
</ParamField>

## Response

Returns a `CoworkerContract` object.

### Plan & Pricing

<ResponseField name="TariffId" type="number">
  ID of the plan associated with this contract.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Display name of the plan.
</ResponseField>

<ResponseField name="Price" type="number">
  Current monthly (or per-cycle) price.
</ResponseField>

<ResponseField name="PriceFormatted" type="string">
  Pre-formatted price string (e.g. `"$199.00"`).
</ResponseField>

<ResponseField name="NextPrice" type="number">
  Price that will be charged from the next renewal.
</ResponseField>

<ResponseField name="NextPriceFormatted" type="string">
  Pre-formatted next renewal price.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  ISO 4217 currency code.
</ResponseField>

<ResponseField name="Quantity" type="number">
  Number of units (e.g., desks) covered by this contract.
</ResponseField>

### Dates & Billing

<ResponseField name="StartDate" type="string">
  ISO 8601 date the contract started.
</ResponseField>

<ResponseField name="RenewalDate" type="string">
  ISO 8601 date of the next billing renewal.
</ResponseField>

<ResponseField name="RenewalDateUtc" type="string">
  UTC version of the renewal date.
</ResponseField>

<ResponseField name="BillingDay" type="number">
  Day of the month on which the contract is billed.
</ResponseField>

<ResponseField name="EarliestCancellationDate" type="string">
  The earliest date the contract can be cancelled without penalty.
</ResponseField>

<ResponseField name="CancellationDate" type="string">
  ISO 8601 date when the contract was cancelled (if applicable).
</ResponseField>

<ResponseField name="AbsoluteCancellationDate" type="string">
  The absolute final date the contract will end (if applicable).
</ResponseField>

### Status Flags

<ResponseField name="Active" type="boolean">
  Whether the contract is currently active.
</ResponseField>

<ResponseField name="Cancelled" type="boolean">
  Whether the contract has been cancelled.
</ResponseField>

<ResponseField name="MainContract" type="boolean">
  Whether this is the customer's primary contract.
</ResponseField>

<ResponseField name="IsPaused" type="boolean">
  Whether the contract is in a paused state.
</ResponseField>

<ResponseField name="IsPausedNow" type="boolean">
  Whether the contract is actively paused at the current moment.
</ResponseField>

<ResponseField name="CanBePausedNow" type="boolean">
  Whether the contract is eligible to be paused right now.
</ResponseField>

<ResponseField name="InPausedPeriod" type="boolean">
  Whether the current date falls within a scheduled pause period.
</ResponseField>

<ResponseField name="InPausedPeriodFromUtc" type="string">
  UTC datetime from which the pause period begins.
</ResponseField>

<ResponseField name="InPausedPeriodUntilUtc" type="string">
  UTC datetime at which the pause period ends.
</ResponseField>

### Terms & Deposits

<ResponseField name="PricePlanTermsAccepted" type="boolean">
  Whether the customer has accepted the plan's terms and conditions.
</ResponseField>

<ResponseField name="PricePlanTermsAcceptedOn" type="string">
  ISO 8601 datetime when terms were accepted.
</ResponseField>

<ResponseField name="DepositsAmount" type="number">
  Total deposit amount held against this contract.
</ResponseField>

<ResponseField name="DepositsAmountFormatted" type="string">
  Pre-formatted deposit amount string.
</ResponseField>

### System Fields

<ResponseField name="Id" type="number">
  Unique identifier of the contract.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier of the contract.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  ISO 8601 datetime when the contract was created (local time).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  ISO 8601 datetime when the contract was last updated (local time).
</ResponseField>

## Example Response

```json theme={null}
{
  "Id": 5001,
  "UniqueId": "c7d8e9f0-1234-5678-abcd-ef0987654321",
  "TariffId": 12,
  "TariffName": "Hot Desk Monthly",
  "Price": 199.0,
  "PriceFormatted": "$199.00",
  "NextPrice": 199.0,
  "NextPriceFormatted": "$199.00",
  "CurrencyCode": "USD",
  "Quantity": 1,
  "StartDate": "2025-01-01",
  "RenewalDate": "2025-11-01",
  "BillingDay": 1,
  "EarliestCancellationDate": "2025-12-01",
  "Active": true,
  "Cancelled": false,
  "MainContract": true,
  "IsPaused": false,
  "IsPausedNow": false,
  "CanBePausedNow": true,
  "PricePlanTermsAccepted": true,
  "DepositsAmount": 0,
  "CreatedOn": "2025-01-01T09:00:00",
  "UpdatedOn": "2025-09-15T14:30:00"
}
```

## Usage in Portal

This endpoint is used in the My Plans section to display full contract details.

* File: `src/views/user/plans/useContractData.ts`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.contracts.one = (contractId: number) => ({
//   url: `/api/public/billing/coworkerContracts/${contractId}`,
//   type: null as unknown as CoworkerContract,
// })

// Usage in React
const endpoint = useMemo(() => endpoints.billing.contracts.one(contractId), [contractId])
const { resource: contract } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/coworkerContracts/{contractId}/pause/meta` – Get pause eligibility metadata
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause` – Pause a contract
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/resume` – Resume a paused contract

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or the contract is not accessible to them.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Contract with the specified ID does not exist.
</ResponseField>


# Pause Contract
Source: https://learn.nexudus.com/api/endpoints/billing/contract-pause

PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause

# Pause Contract

Submits a request to pause (freeze) a plan contract for a specified number of billing cycles. While paused, the plan's recurring charges are suspended. Additional services such as bookings may still generate charges during the pause period.

<Note>
  Before calling this endpoint, retrieve pause eligibility and options via `GET /api/public/billing/coworkerContracts/{contractId}/pause/meta`. Always
  present and obtain acceptance of the pause terms and conditions before submitting.
</Note>

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the contract to pause.
</ParamField>

## Request Body

<ParamField type="number">
  The number of billing cycles to pause the contract for. Must be at least `1`. The available options are returned by the pause metadata endpoint as
  `PauseUntilOptions`.
</ParamField>

## Response

A successful response returns an empty body or a generic confirmation. No typed response object is defined for this endpoint.

## Example Request

```json theme={null}
{
  "PauseCycles": 2
}
```

## Usage in Portal

Called when the customer confirms the pause action in the pause modal.

* File: `src/views/user/plans/useMyPlansData.ts`
* Used by: `src/views/user/plans/components/PauseContractModal.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.contracts.pause = (contractId: number) => ({
//   url: `/api/public/billing/coworkerContracts/v2/${contractId}/pause`,
// })

// Usage
const pauseContract = async (contractId: number, pauseCycles: number) => {
  return httpClient.put(endpoints.billing.contracts.pause(contractId).url, { PauseCycles: pauseCycles })
}
```

## Related Endpoints

* `GET /api/public/billing/coworkerContracts/{contractId}/pause/meta` – Get pause eligibility and options
* `GET /api/public/billing/coworkerContracts/pause/bookings` – Preview bookings affected by the pause
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/resume` – Resume a paused contract

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The contract cannot be paused (e.g., already paused, limit reached, or the plan does not support pausing). The response body contains an error code.
</ResponseField>

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this contract.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Contract with the specified ID does not exist.
</ResponseField>


# Get Bookings During Pause Period
Source: https://learn.nexudus.com/api/endpoints/billing/contract-pause-bookings

GET /api/public/billing/coworkerContracts/pause/bookings

# Get Bookings During Pause Period

Returns a summary of the customer's bookings that fall within a proposed pause period. Use this endpoint in the pause flow to warn the customer about any existing bookings that will be affected — specifically those that have not yet been charged, invoiced, or paid.

## Authentication

This endpoint requires an authenticated customer session.

## Query Parameters

<ParamField type="string">
  ISO 8601 datetime string for the start of the proposed pause period. This is typically the earliest pause date returned by the pause metadata
  endpoint.
</ParamField>

<ParamField type="string">
  ISO 8601 datetime string for the end of the proposed pause period. This is computed from the selected number of pause cycles.
</ParamField>

## Response

Returns a `PauseBooking` object summarising booking counts within the date range.

<ResponseField name="Total" type="number">
  Total number of bookings within the proposed pause period.
</ResponseField>

<ResponseField name="NotCharged" type="number">
  Number of bookings that have not yet been charged.
</ResponseField>

<ResponseField name="NotInvoiced" type="number">
  Number of bookings that have not yet been invoiced.
</ResponseField>

<ResponseField name="NotPaid" type="number">
  Number of bookings whose invoices have not yet been paid.
</ResponseField>

## Example Response

```json theme={null}
{
  "Total": 3,
  "NotCharged": 1,
  "NotInvoiced": 2,
  "NotPaid": 3
}
```

## Usage in Portal

Called inside the pause modal each time the customer changes the number of pause cycles, so the warning counts stay in sync with the selected date range.

* File: `src/views/user/plans/components/PauseContractModal.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.contracts.pauseBookings = (start: string, end: string) => ({
//   url: `/api/public/billing/coworkerContracts/pause/bookings?start=${start}&end=${end}`,
//   type: null as unknown as PauseBooking,
// })

// Usage in React (recalculated on every cycle selection change)
const endDate = earliestPauseDate.plus({ months: selectedCycles })
const bookingsEndpoint = endpoints.billing.contracts.pauseBookings(earliestPauseDateISO, endDate.toUTC().toISO() ?? earliestPauseDateISO)
const { resource: bookings } = useData<typeof bookingsEndpoint.type>(httpClient, bookingsEndpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/coworkerContracts/{contractId}/pause/meta` – Get pause eligibility and available date options
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause` – Submit the pause request

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing or invalid `start`/`end` parameters.
</ResponseField>


# Get Contract Pause Metadata
Source: https://learn.nexudus.com/api/endpoints/billing/contract-pause-meta

GET /api/public/billing/coworkerContracts/{contractId}/pause/meta

# Get Contract Pause Metadata

Returns metadata about the pause eligibility and state of a given contract. Use this endpoint before presenting the pause flow to the customer to determine whether pausing is possible, what the earliest pause date is, available pause-until options, and any applicable terms and conditions.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the contract.
</ParamField>

## Response

Returns a `PauseContractMeta` object.

<ResponseField name="CanBePausedNow" type="boolean">
  Whether the contract is currently eligible to be paused.
</ResponseField>

<ResponseField name="IsPausedNow" type="boolean">
  Whether the contract is already actively paused.
</ResponseField>

<ResponseField name="InPausedPeriod" type="boolean">
  Whether the current date falls within an existing scheduled pause period.
</ResponseField>

<ResponseField name="InPausedPeriodFrom" type="string">
  Local datetime from which the current pause period starts (if in one).
</ResponseField>

<ResponseField name="InPausedPeriodFromUtc" type="string">
  UTC datetime from which the current pause period starts.
</ResponseField>

<ResponseField name="InPausedPeriodUntil" type="string">
  Local datetime at which the current pause period ends.
</ResponseField>

<ResponseField name="InPausedPeriodUntilUtc" type="string">
  UTC datetime at which the current pause period ends.
</ResponseField>

<ResponseField name="CurrentPeriodStart" type="string">
  ISO 8601 date for the start of the current billing period.
</ResponseField>

<ResponseField name="CurrentPeriodStartUtc" type="string">
  UTC version of the current billing period start.
</ResponseField>

<ResponseField name="InProratePeriod" type="boolean">
  Whether the contract is currently within a pro-rata period (affects pause timing).
</ResponseField>

<ResponseField name="RenewalDate" type="string">
  ISO 8601 date of the next scheduled renewal.
</ResponseField>

<ResponseField name="PauseCyclesLimit" type="number">
  Maximum number of billing cycles that can be paused (if restricted). `null` means unlimited.
</ResponseField>

<ResponseField name="PauseYearlyLimit" type="number">
  Maximum number of months that can be paused per year (if restricted). `null` means unlimited.
</ResponseField>

<ResponseField name="PausedPeriodsCount" type="number">
  Number of pause periods already used by this contract.
</ResponseField>

<ResponseField name="ProrateDaysBefore" type="number">
  Number of days before the renewal where pro-rata charges apply.
</ResponseField>

<ResponseField name="PauseUntilOptions" type="array">
  Array of ISO 8601 date strings representing the available pause end dates the customer can select from.
</ResponseField>

<ResponseField name="TermsAndConditions" type="string">
  HTML or plain text for the pause terms and conditions that should be shown to and accepted by the customer before pausing.
</ResponseField>

## Example Response

```json theme={null}
{
  "CanBePausedNow": true,
  "IsPausedNow": false,
  "InPausedPeriod": false,
  "InPausedPeriodFrom": null,
  "InPausedPeriodFromUtc": null,
  "InPausedPeriodUntil": null,
  "InPausedPeriodUntilUtc": null,
  "CurrentPeriodStart": "2025-10-01",
  "CurrentPeriodStartUtc": "2025-10-01T00:00:00Z",
  "InProratePeriod": false,
  "RenewalDate": "2025-11-01",
  "PauseCyclesLimit": null,
  "PauseYearlyLimit": 3,
  "PausedPeriodsCount": 0,
  "ProrateDaysBefore": 5,
  "PauseUntilOptions": ["2025-11-01", "2025-12-01", "2026-01-01"],
  "TermsAndConditions": "<p>By pausing your plan you agree to...</p>"
}
```

## Usage in Portal

Fetched at the start of the pause flow to determine UI state and options presented to the customer.

* File: `src/views/user/plans/useContractPauseMeta.ts`
* Used by: `src/views/user/plans/components/PauseContractModal.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.contracts.pauseMmeta = (contractId: number) => ({
//   url: `/api/public/billing/coworkerContracts/${contractId}/pause/meta`,
//   type: null as unknown as PauseContractMeta,
// })

// Usage in React
const endpoint = endpoints.billing.contracts.pauseMmeta(contractId)
const { resource: pauseMeta } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/coworkerContracts/{contractId}` – Get full contract details
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause` – Submit a pause request
* `GET /api/public/billing/coworkerContracts/pause/bookings` – Check bookings affected by the pause period

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this contract.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Contract with the specified ID does not exist.
</ResponseField>


# Resume Contract
Source: https://learn.nexudus.com/api/endpoints/billing/contract-resume

PUT /api/public/billing/coworkerContracts/v2/{contractId}/resume

# Resume Contract

Resumes a previously paused plan contract. Supports two modes: immediate resumption (effective today) or resumption at the natural end of the current pause period.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the contract to resume.
</ParamField>

## Query Parameters

<ParamField type="boolean">
  When `true`, the contract is resumed immediately. When `false`, the contract will resume at the end of its current scheduled pause period.
</ParamField>

## Request Body

No request body is required.

## Response

A successful response returns an empty body or a generic confirmation. No typed response object is defined for this endpoint.

## Usage in Portal

Called when the customer clicks the resume button in the My Plans section.

* File: `src/views/user/plans/useMyPlansData.ts`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.contracts.resume = (contractId: number, immediate: boolean) => ({
//   url: `/api/public/billing/coworkerContracts/v2/${contractId}/resume?immediate=${immediate}`,
// })

// Resume immediately
const resumeNow = async (contractId: number) => {
  return httpClient.put(endpoints.billing.contracts.resume(contractId, true).url, {})
}

// Resume at end of pause period
const resumeAtEnd = async (contractId: number) => {
  return httpClient.put(endpoints.billing.contracts.resume(contractId, false).url, {})
}
```

## Related Endpoints

* `GET /api/public/billing/coworkerContracts/{contractId}` – Get contract details including pause state
* `GET /api/public/billing/coworkerContracts/{contractId}/pause/meta` – Get pause eligibility metadata
* `PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause` – Pause a contract

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The contract is not currently paused or cannot be resumed. The response body contains an error code.
</ResponseField>

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this contract.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Contract with the specified ID does not exist.
</ResponseField>


# Get Invoice Details
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-details

GET /api/public/billing/invoices/{invoiceId}

# Get Invoice Details

Retrieves a single invoice for the current customer. Invoices are created during checkout flows for bookings, products, plans, and more. This endpoint returns the full invoice breakdown, including lines, taxes, totals, currency, and metadata for the location.

## Authentication

This endpoint requires an authenticated customer session. The invoice must belong to the current customer or to a team the customer manages.

## Path Parameters

<ParamField type="number">
  The unique identifier of the invoice you want to retrieve.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=InvoiceNumber,TotalAmount,DueAmount,Paid,Lines`.
</ParamField>

## Response

The response shape follows the `InvoicePreview` contract used across checkout and payments. Below is a summary of the most-used fields.

### Identification and Status

<ResponseField name="Id" type="number">
  Unique identifier for the invoice
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier for the invoice
</ResponseField>

<ResponseField name="InvoiceNumber" type="string">
  Human-friendly invoice number as visible to the customer
</ResponseField>

<ResponseField name="Draft" type="boolean">
  Whether the invoice is a draft
</ResponseField>

<ResponseField name="Paid" type="boolean">
  Whether the invoice is fully paid
</ResponseField>

<ResponseField name="PaidOn" type="string">
  ISO 8601 datetime when the invoice was paid (if paid)
</ResponseField>

<ResponseField name="DueDate" type="string">
  ISO 8601 date the invoice is due
</ResponseField>

<ResponseField name="CreditNote" type="boolean">
  Whether the document is a credit note
</ResponseField>

<ResponseField name="Refunded" type="boolean">
  Whether the invoice has been refunded
</ResponseField>

### Customer and Location

<ResponseField name="CoworkerId" type="number">
  Customer id the invoice belongs to
</ResponseField>

<ResponseField name="BusinessId" type="number">
  Location id where this invoice was issued
</ResponseField>

<ResponseField name="BusinessWebAddress" type="number">
  Web address id for the issuing location
</ResponseField>

### Billing To

<ResponseField name="BillToName" type="string">
  Billing contact or company name (can be null)
</ResponseField>

<ResponseField name="BillToAddress" type="string">
  Billing address line (can be null)
</ResponseField>

<ResponseField name="BillToCity" type="string">
  Billing city (can be null)
</ResponseField>

<ResponseField name="BillToState" type="string">
  Billing state/region (can be null)
</ResponseField>

<ResponseField name="BillToPostCode" type="string">
  Billing postal/ZIP code (can be null)
</ResponseField>

<ResponseField name="BillToCountry" type="object">
  Country object for the billing address
</ResponseField>

<ResponseField name="TaxIDNumber" type="string">
  Tax/VAT registration number (can be null)
</ResponseField>

### Amounts and Currency

<ResponseField name="TotalAmount" type="number">
  Grand total amount of the invoice (in invoice currency)
</ResponseField>

<ResponseField name="DueAmount" type="number">
  Amount still due
</ResponseField>

<ResponseField name="PaidAmount" type="number">
  Amount paid so far
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Total tax amount across all lines
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Total discount applied to the invoice
</ResponseField>

<ResponseField name="Currency" type="object">
  Invoice currency object with fields: `Name`, `Code`, `Format`, etc.
</ResponseField>

<ResponseField name="TransactionCurrency" type="object">
  Transaction currency used by the payment gateway (if different)
</ResponseField>

<ResponseField name="TotalFormated" type="string">
  Pre-formatted total, e.g. "\$123.45"
</ResponseField>

<ResponseField name="DueAmountFormated" type="string">
  Pre-formatted due amount
</ResponseField>

### Lines and Taxes

<ResponseField name="Lines" type="array">
  Array of line items. Each item includes fields such as `Description`, `Quantity`, `UnitPrice`, `SubTotal`, `TaxAmount`, `TaxPercentage`, and
  optional `DiscountCode`.
</ResponseField>

<ResponseField name="TaxCategories" type="array">
  Breakdown of totals by tax rate, including `Rate`, `TaxSubTotal`, `SubTotal`, and `Lines`.
</ResponseField>

### Usage of Credits (if applicable)

<ResponseField name="UsedExtraServices" type="array">
  Applied extra service credits with `Amount`, `ChargePeriod`, `ExpiresOn`.
</ResponseField>

<ResponseField name="UsedBookingCredits" type="array">
  Applied booking credits with `Amount`, `ChargePeriod`, `ExpiresOn`.
</ResponseField>

### System Fields

<ResponseField name="CreatedOn" type="string">
  ISO 8601 datetime when the invoice was created (local time)
</ResponseField>

<ResponseField name="CreatedOnUtc" type="string">
  ISO 8601 datetime when the invoice was created (UTC)
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  ISO 8601 datetime when the invoice was last updated (local time)
</ResponseField>

<ResponseField name="UpdatedOnUtc" type="string">
  ISO 8601 datetime when the invoice was last updated (UTC)
</ResponseField>

## Example Response

```json theme={null}
{
  "Id": 12345,
  "IdString": "12345",
  "UniqueId": "e9a3a3b8-8d3e-4b54-9f2d-0c82b2a8b9a1",
  "InvoiceNumber": "INV-2025-000123",
  "CoworkerId": 987,
  "BusinessId": 42,
  "DueDate": "2025-09-30",
  "Paid": false,
  "Draft": false,
  "Currency": { "Code": "USD", "Name": "US Dollar", "Format": "$0,0.00" },
  "TotalAmount": 199.0,
  "DueAmount": 199.0,
  "TaxAmount": 33.17,
  "DiscountAmount": 0,
  "Lines": [
    {
      "Id": 1,
      "Description": "Meeting room booking",
      "Quantity": 1,
      "UnitPrice": 165.83,
      "SubTotal": 165.83,
      "TaxAmount": 33.17,
      "TaxPercentage": 20,
      "SubTotalFormatted": "$165.83",
      "TaxAmountFormatted": "$33.17",
      "UnitPriceFormatted": "$165.83"
    }
  ],
  "TaxCategories": [{ "Rate": 20, "TaxSubTotal": 33.17, "SubTotal": 165.83, "Name": "VAT 20%", "Lines": [] }],
  "TotalFormated": "$199.00",
  "DueAmountFormated": "$199.00",
  "CreatedOn": "2025-09-28T10:15:00",
  "CreatedOnUtc": "2025-09-28T09:15:00Z"
}
```

## Usage in Portal

This endpoint is used during checkout and payment flows whenever an existing invoice id is present (e.g., resuming payment or redirecting back from a payment provider). Key usages include:

1. Checkout flow controller – decides steps when an `invoice_id` is present
   * File: `src/views/checkout/CheckoutLayoutPage.tsx`
2. Payment selection and processing (uses invoice data to start payment sessions)
   * Files:
     * `src/views/checkout/SignupPaymentPage.tsx`
     * `src/views/public/checkout/booking/components/StripeCheckoutForm.tsx`
     * `src/views/public/checkout/booking/components/SpreedlyCheckoutForm.tsx`
3. Completion step context
   * File: `src/views/checkout/SignupCompletePage.tsx`
4. Invoice fetching and basket state orchestration
   * File: `src/states/useBasketData.tsx` (calls `endpoints.billing.invoices.one` when `invoice_id` is in the URL)
5. Discount code summary UI (reads invoice lines and currency)
   * File: `src/views/public/checkout/booking/components/DiscountCodeForm.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// const endpoints.billing.invoices.one = (invoiceId: number) => ({
//   url: `/api/public/billing/invoices/${invoiceId}`,
//   type: null as unknown as InvoicePreview,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.one(Number(invoiceId))
const { resource: invoice } = useData<typeof endpoint.type>(httpClient, invoiceId ? endpoint.url : null)
```

## Related Endpoints

* `POST /en/basket/CreateInvoice` – Create an invoice from the current basket
* `POST /api/public/payments/stripe/createGuestSession` – Start a Stripe checkout session
* `POST /api/public/payments/spreedly/createGuestSession` – Start a Spreedly payment session

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or The invoice is not accessible to the current user
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Invoice with the specified id does not exist or is not accessible
</ResponseField>


# Preview Next Invoice PDF
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-draft-pdf

GET /api/public/billing/invoices/draft/pdf

# Preview Next Invoice PDF

Returns a PDF preview of the customer's upcoming invoice. This allows members to see what their next invoice will look like before it is officially generated, including estimated charges from active contracts and pending items.

## Authentication

This endpoint requires a valid media JWT token obtained from `GET /api/auth/media/customer`.

## Query Parameters

<ParamField type="string">
  A short-lived media JWT obtained from `GET /api/auth/media/customer`. This token authorises temporary access to the binary file. Pass the `jwt`
  field from the response object directly as this query parameter value.
</ParamField>

## Response

Returns the raw PDF binary (`application/pdf`). The portal constructs the full URL and opens it in a new browser tab.

## Code Examples

<CodeGroup>
  ```ts TypeScript theme={null}
  // 1. Fetch a media JWT (requires a valid Bearer token)
  const { jwt } = await fetch('/api/auth/media/customer', {
    headers: { Authorization: `Bearer ${customerBearerToken}` },
  }).then((r) => r.json())

  // 2. Build the draft invoice PDF URL
  const draftUrl = `https://${business.WebAddress}/en/api/public/billing/invoices/draft/pdf?t=${jwt}`

  // 3. Open directly — no additional fetch needed
  window.open(draftUrl, '_blank')
  ```

  ```bash cURL theme={null}
  # First obtain a media JWT
  MEDIA_JWT=$(curl -s -H "Authorization: Bearer $TOKEN" \
    "https://your-space.nexudus.com/en/api/auth/media/customer" | jq -r '.jwt')

  # Then download the draft invoice PDF
  curl -o draft-invoice.pdf \
    "https://your-space.nexudus.com/en/api/public/billing/invoices/draft/pdf?t=$MEDIA_JWT"
  ```
</CodeGroup>

## Usage in Portal

This endpoint is used in the **My Invoices** section to provide a "Preview next invoice" link at the bottom of the invoices table.

* File: `src/views/user/activity/invoices/MyInvoicesSection.tsx`

## Related Endpoints

* `GET /api/public/billing/invoices/my` – List invoices
* `GET /api/public/billing/invoices/{invoiceId}/pdf` – Download a single invoice PDF
* `GET /api/public/billing/invoices/statements/pdf` – Download billing statement
* `GET /api/auth/media/customer` – Obtain a short-lived media JWT

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  Missing or invalid media JWT token.
</ResponseField>


# Get Invoice Event Attendee Line
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-line-attendee

GET /api/public/billing/invoices/{invoiceId}/attendees/{attendeeUniqueId}

# Get Invoice Event Attendee Line

Returns the `EventAttendee` record linked to a specific invoice line. This endpoint is used to enrich invoice lines that originate from an event ticket purchase, providing event name, product pricing, and attendee details.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the parent invoice.
</ParamField>

<ParamField type="string">
  The `UniqueId` of the event attendee record associated with the invoice line. Available on the invoice line as `EventAttendeeUniqueId`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Attendee.FullName,Attendee.EventProductName,Attendee.CalendarEvent.Name`.
</ParamField>

## Response

Returns an `EventAttendee` object.

<ResponseField name="CalendarEventId" type="number">
  ID of the calendar event the attendee signed up for.
</ResponseField>

<ResponseField name="EventProductId" type="number">
  ID of the event product (ticket type) purchased.
</ResponseField>

<ResponseField name="FullName" type="string">
  Full name of the attendee.
</ResponseField>

<ResponseField name="Email" type="string">
  Email address of the attendee.
</ResponseField>

<ResponseField name="CalendarEventName" type="string">
  Display name of the event.
</ResponseField>

<ResponseField name="EventProductName" type="string">
  Name of the ticket type or event product purchased.
</ResponseField>

<ResponseField name="EventProductPrice" type="string">
  Price of the event product as a formatted string.
</ResponseField>

<ResponseField name="EventProductCurrencyCode" type="string">
  ISO 4217 currency code for the event product price.
</ResponseField>

<ResponseField name="CoworkerId" type="number">
  ID of the customer who purchased the ticket (if applicable).
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the customer (if applicable).
</ResponseField>

<ResponseField name="CoworkerInvoiceNumber" type="string">
  Invoice number associated with the purchase (if applicable).
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="string">
  Whether the associated invoice has been paid (if applicable).
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier for the attendee record.
</ResponseField>

## Example Response

```json theme={null}
{
  "CalendarEventId": 201,
  "EventProductId": 55,
  "FullName": "Jane Smith",
  "Email": "jane.smith@example.com",
  "CalendarEventName": "Monthly Networking Meetup",
  "EventProductName": "General Admission",
  "EventProductPrice": "$25.00",
  "EventProductCurrencyCode": "USD",
  "CoworkerId": 987,
  "CoworkerFullName": "Jane Smith",
  "CoworkerInvoiceNumber": "INV-2025-000124",
  "CoworkerInvoicePaid": "false",
  "UniqueId": "f1e2d3c4-b5a6-7890-cdef-1234567890ab"
}
```

## Usage in Portal

Used to render event/ticket details in invoice line rows within the basket and invoice summary.

* File: `src/components/Basket/invoiceLines/EventAttendeeInvoiceLineRow.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.attendee = (invoiceId: number, attendeeUniqueId: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/attendees/${attendeeUniqueId}`,
//   type: null as unknown as EventAttendee,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.attendee(invoice.Id, line.EventAttendeeUniqueId)
const { resource: attendee } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details
* `GET /api/public/events/{id}` – Get event details

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this invoice.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  The invoice or attendee record does not exist.
</ResponseField>


# Get Invoice Booking Line
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-line-booking

GET /api/public/billing/invoices/{invoiceId}/bookings/{bookingUniqueId}

# Get Invoice Booking Line

Returns the `Booking` record linked to a specific invoice line. This endpoint is used to enrich invoice line items that originate from a booking, giving the UI access to full booking details (resource name, times, floor plan, etc.) alongside the invoice.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the parent invoice.
</ParamField>

<ParamField type="string">
  The `UniqueId` of the booking associated with the invoice line. This value is available on the invoice line object as `BookingUniqueId`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Booking.ResourceName,Booking.FromTime,Booking.ToTime`.
</ParamField>

## Response

Returns a `Booking` object.

<ResponseField name="Id" type="number">
  Unique identifier of the booking.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier of the booking.
</ResponseField>

<ResponseField name="ResourceId" type="number">
  ID of the booked resource.
</ResponseField>

<ResponseField name="ResourceName" type="string">
  Display name of the booked resource.
</ResponseField>

<ResponseField name="FromTime" type="string">
  ISO 8601 datetime for the start of the booking.
</ResponseField>

<ResponseField name="ToTime" type="string">
  ISO 8601 datetime for the end of the booking.
</ResponseField>

<ResponseField name="CoworkerId" type="number">
  ID of the customer who made the booking.
</ResponseField>

<ResponseField name="InvoiceId" type="number">
  ID of the associated invoice.
</ResponseField>

<ResponseField name="Tentative" type="boolean">
  Whether the booking is still tentative/unconfirmed.
</ResponseField>

<ResponseField name="Cancelled" type="boolean">
  Whether the booking has been cancelled.
</ResponseField>

## Example Response

```json theme={null}
{
  "Id": 9876,
  "UniqueId": "b1a2c3d4-e5f6-7890-abcd-ef1234567890",
  "ResourceId": 55,
  "ResourceName": "Focus Room 2",
  "FromTime": "2025-10-15T09:00:00",
  "ToTime": "2025-10-15T11:00:00",
  "CoworkerId": 987,
  "InvoiceId": 12345,
  "Tentative": false,
  "Cancelled": false
}
```

## Usage in Portal

This endpoint is used to render booking-specific details within an invoice line row in the basket/invoice summary UI.

* File: `src/components/Basket/invoiceLines/BookingInvoiceLineRow.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.booking = (invoiceId: number, bookingUniqueId: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/bookings/${bookingUniqueId}`,
//   type: null as unknown as Booking,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.booking(invoice.Id, line.BookingUniqueId)
const { resource: booking } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details
* `GET /api/public/bookings/{id}` – Get booking details directly

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this invoice.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  The invoice or booking does not exist or cannot be associated.
</ResponseField>


# Get Invoice Contract Line
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-line-contract

GET /api/public/billing/invoices/{invoiceId}/coworkerContracts/{coworkerContractsUniqueId}

# Get Invoice Contract Line

Returns the `CoworkerContract` record linked to a specific invoice line. This endpoint is used to enrich invoice lines that originate from a plan/contract charge, providing full contract details (plan name, dates, pricing, status) alongside the invoice.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the parent invoice.
</ParamField>

<ParamField type="string">
  The `UniqueId` of the contract associated with the invoice line. Available on the invoice line object.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Contract.Tariff.Name,Contract.Price,Contract.Active`.
</ParamField>

## Response

Returns a `CoworkerContract` object.

<ResponseField name="Id" type="number">
  Unique identifier of the contract.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier of the contract.
</ResponseField>

<ResponseField name="TariffId" type="number">
  ID of the plan associated with this contract.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Display name of the plan.
</ResponseField>

<ResponseField name="StartDate" type="string">
  ISO 8601 date when the contract started.
</ResponseField>

<ResponseField name="RenewalDate" type="string">
  ISO 8601 date of the next renewal.
</ResponseField>

<ResponseField name="Price" type="number">
  Current price of the contract.
</ResponseField>

<ResponseField name="PriceFormatted" type="string">
  Pre-formatted price string (e.g. `"$99.00/mo"`).
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the contract is currently active.
</ResponseField>

<ResponseField name="Cancelled" type="boolean">
  Whether the contract has been cancelled.
</ResponseField>

<ResponseField name="IsPaused" type="boolean">
  Whether the contract is currently in a paused state.
</ResponseField>

<ResponseField name="BillingDay" type="number">
  Day of the month on which the contract is billed.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  ISO 4217 currency code for the contract.
</ResponseField>

## Example Response

```json theme={null}
{
  "Id": 5001,
  "UniqueId": "c7d8e9f0-1234-5678-abcd-ef0987654321",
  "TariffId": 12,
  "TariffName": "Hot Desk Monthly",
  "StartDate": "2025-01-01",
  "RenewalDate": "2025-11-01",
  "Price": 199.0,
  "PriceFormatted": "$199.00",
  "Active": true,
  "Cancelled": false,
  "IsPaused": false,
  "BillingDay": 1,
  "CurrencyCode": "USD"
}
```

## Usage in Portal

Used to render contract/plan details within invoice line rows in the basket summary and invoice views.

* File: `src/components/Basket/invoiceLines/PlanInvoiceLineRow.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.coworkerContract = (invoiceId: number, coworkerContractsUniqueId: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/coworkerContracts/${coworkerContractsUniqueId}`,
//   type: null as unknown as CoworkerContract,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.coworkerContract(invoice.Id, line.CoworkerContractUniqueId)
const { resource: contract } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details
* `GET /api/public/billing/coworkerContracts/{contractId}` – Get contract details directly

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this invoice.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  The invoice or contract does not exist or cannot be associated.
</ResponseField>


# Get Invoice Product Line
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-line-product

GET /api/public/billing/invoices/{invoiceId}/coworkerProducts/{coworkerProductsUniqueId}

# Get Invoice Product Line

Returns the `CoworkerProduct` record linked to a specific invoice line. This endpoint enriches invoice lines that originate from a product purchase, providing details such as product ID, quantity, and recurrence type.

## Authentication

This endpoint requires an authenticated customer session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the parent invoice.
</ParamField>

<ParamField type="string">
  The `UniqueId` of the customer product record associated with the invoice line. Available on the invoice line as `CoworkerProductUniqueId`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Product.Price,Product.Quantity,Product.Product.Name`.
</ParamField>

## Response

Returns a `CoworkerProduct` object.

<ResponseField name="Id" type="number">
  Unique identifier of the customer product record.
</ResponseField>

<ResponseField name="ProductId" type="number">
  ID of the underlying product in the catalogue.
</ResponseField>

<ResponseField name="Quantity" type="number">
  Quantity of the product purchased.
</ResponseField>

<ResponseField name="RegularCharge" type="boolean">
  Whether this product is set up as a recurring charge.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier for this customer product record.
</ResponseField>

## Example Response

```json theme={null}
{
  "Id": 3001,
  "ProductId": 88,
  "Quantity": 2,
  "RegularCharge": false,
  "UniqueId": "a1b2c3d4-5678-90ef-abcd-1234567890ab"
}
```

## Usage in Portal

Used to render product details in invoice line rows within the basket and invoice summary.

* File: `src/components/Basket/invoiceLines/ProductInvoiceLineRow.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.coworkerProduct = (invoiceId: number, coworkerProductsUniqueId: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/coworkerProducts/${coworkerProductsUniqueId}`,
//   type: null as unknown as CoworkerProduct,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.coworkerProduct(invoice.Id, line.CoworkerProductUniqueId)
const { resource: product } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details
* `GET /api/public/store/products/{productId}` – Get store product details

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated or does not have access to this invoice.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  The invoice or customer product record does not exist.
</ResponseField>


# List Invoices
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-list

GET /api/public/billing/invoices/my

# List Invoices

Returns a paginated list of invoices for the currently authenticated customer. Supports filtering by payment status and whether to include credit notes.

## Authentication

This endpoint requires an authenticated customer session.

## Query Parameters

<ParamField type="boolean">
  When `true`, returns only paid invoices. When `false`, returns only unpaid invoices. Omit to return all invoices.
</ParamField>

<ParamField type="boolean">
  When `true`, includes credit notes in the result set.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.InvoiceNumber,Records.TotalAmount,Records.Paid,TotalItems`.
</ParamField>

## Response

Returns an `ApiListResult<InvoicePreview>` object.

### Pagination

<ResponseField name="CurrentPage" type="number">
  The current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="number">
  Number of records in the current page.
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of invoices matching the query.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of available pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page.
</ResponseField>

### Records

Each item in `Records` follows the `InvoicePreview` shape. Key fields:

<ResponseField name="Id" type="number">
  Unique identifier of the invoice.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier of the invoice.
</ResponseField>

<ResponseField name="InvoiceNumber" type="string">
  Human-readable invoice number as shown to the customer.
</ResponseField>

<ResponseField name="Paid" type="boolean">
  Whether the invoice has been fully paid.
</ResponseField>

<ResponseField name="PaidOn" type="string">
  ISO 8601 datetime when the invoice was paid (if applicable).
</ResponseField>

<ResponseField name="DueDate" type="string">
  ISO 8601 date the invoice is due.
</ResponseField>

<ResponseField name="Draft" type="boolean">
  Whether the invoice is still a draft.
</ResponseField>

<ResponseField name="CreditNote" type="boolean">
  Whether this document is a credit note rather than a standard invoice.
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Grand total of the invoice in the invoice currency.
</ResponseField>

<ResponseField name="DueAmount" type="number">
  Amount still outstanding.
</ResponseField>

<ResponseField name="TotalFormated" type="string">
  Pre-formatted total string (e.g. `"$199.00"`).
</ResponseField>

<ResponseField name="Currency" type="object">
  Currency object with fields: `Code`, `Name`, `Format`.
</ResponseField>

<ResponseField name="BusinessWebAddress" type="string">
  Web address of the location that issued the invoice. Used to construct PDF download links.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  ISO 8601 datetime when the invoice was created (local time).
</ResponseField>

## Example Response

```json theme={null}
{
  "Records": [
    {
      "Id": 12345,
      "UniqueId": "e9a3a3b8-8d3e-4b54-9f2d-0c82b2a8b9a1",
      "InvoiceNumber": "INV-2025-000123",
      "Paid": false,
      "PaidOn": null,
      "DueDate": "2025-10-01",
      "Draft": false,
      "CreditNote": false,
      "TotalAmount": 199.0,
      "DueAmount": 199.0,
      "TotalFormated": "$199.00",
      "Currency": { "Code": "USD", "Name": "US Dollar", "Format": "$0,0.00" },
      "BusinessWebAddress": "myspace.spaces.nexudus.com",
      "CreatedOn": "2025-09-28T10:15:00"
    }
  ],
  "CurrentPage": 1,
  "CurrentPageSize": 1,
  "TotalItems": 1,
  "TotalPages": 1,
  "HasNextPage": false,
  "HasPreviousPage": false
}
```

## Usage in Portal

This endpoint is used in two places:

1. **My Invoices section** – lists all invoices grouped by paid/unpaid status.

   * File: `src/views/user/activity/invoices/useInvoicesData.tsx`

2. **Onboarding action panel** – surfaces unpaid invoices to prompt the member to complete payment.
   * File: `src/views/user/dashboards/personal/components/OnBoarding/components/UnpaidInvoicesActionPanel.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.list = (paid?: boolean, creditNotes?: boolean) => ({
//   url: `/api/public/billing/invoices/my?paid=${paid}&creditNotes=${creditNotes}`,
//   type: null as unknown as ApiListResult<InvoicePreview>,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.list(false, false)
const { resource: invoices } = useData<typeof endpoint.type>(httpClient, endpoint.url)
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Retrieve a single invoice by ID
* `GET /api/public/billing/invoices/{invoiceId}/pdf` – Download invoice as PDF

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated.
</ResponseField>


# Download Invoice PDF
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-pdf

GET /api/public/billing/invoices/{invoiceId}/pdf

# Download Invoice PDF

Returns the PDF file for a given invoice. Two variants are available depending on whether the request is made by an authenticated customer or a guest using a one-time token:

| Variant                | URL                                                                             | Auth                     |
| ---------------------- | ------------------------------------------------------------------------------- | ------------------------ |
| Authenticated customer | `/api/public/billing/invoices/{invoiceId}/pdf?t={mediaJwt}`                     | Bearer token + media JWT |
| Guest / token-based    | `/api/public/billing/invoices/{invoiceId}/pdfByToken?token={basketSessionGuid}` | Basket session GUID only |

## Authenticated Variant

### Path Parameters

<ParamField type="number">
  The unique identifier of the invoice.
</ParamField>

### Query Parameters

<ParamField type="string">
  A short-lived media JWT obtained from `GET /api/auth/media/customer`. This token authorises temporary access to the binary file. Pass the `jwt`
  field from the response object directly as this query parameter value.
</ParamField>

### Obtaining the Media JWT

Call `GET /api/auth/media/customer` with a valid Bearer token. The endpoint returns a single-field JSON object:

```json theme={null}
{
  "jwt": "<short-lived-token>"
}
```

Key properties of this token:

* **Short-lived** – expires after approximately **60 seconds**. In the portal, the token is cached and automatically refreshed every **50 seconds** to ensure it is always valid when a download link is constructed.
* **Scoped** – it only grants access to protected binary/media resources and cannot be used in place of a regular API Bearer token.
* **One-time style** – a fresh token should be fetched for each user session; do not persist it across sessions.

#### Example: fetching and using the media JWT

```ts theme={null}
// 1. Fetch a media JWT (requires a valid Bearer token in the Authorization header)
const { jwt } = await fetch('/api/auth/media/customer', {
  headers: { Authorization: `Bearer ${customerBearerToken}` },
}).then((r) => r.json())

// 2. Build the PDF URL using the jwt field
const pdfUrl = `https://${invoice.BusinessWebAddress}${config.publicBaseUrl}/api/public/billing/invoices/${invoice.Id}/pdf?t=${jwt}`

// 3. Open directly — no additional fetch needed
window.open(pdfUrl, '_blank')
```

In the portal this is handled by the `withMediaJwt` helper (`src/states/withMediaJwt.ts`), which wraps `endpoints.system.mediaToken` (`/api/auth/media/customer`) and keeps the token fresh:

```ts theme={null}
// src/states/withMediaJwt.ts
const { resource: mediaJwt } = useData<JwtMedia>(httpClient, endpoints.system.mediaToken, {
  queryConfig: { refetchInterval: 50 * 1000, staleTime: 50 * 1000 },
})
// mediaJwt.jwt is then passed to endpoints.billing.invoices.pdf(invoiceId, mediaJwt)
```

## Guest / Token Variant (`pdfByToken`)

### Path Parameters

<ParamField type="number">
  The unique identifier of the invoice.
</ParamField>

### Query Parameters

<ParamField type="string">
  The **basket session GUID** associated with the completed checkout. This is the payment-gateway session ID (e.g. the Stripe, Spreedly, or PayPal
  session ID) that was used to process the payment. It is available as `stripe_session_id`, `spreedly_session_id`, or `paypal_session_id` in the
  checkout completion URL and is passed directly to this endpoint — no authenticated session is required.
</ParamField>

### How the basket session GUID is obtained

When a guest checkout completes, the payment gateway redirects back to the portal's completion page with the session ID as a URL query parameter:

```
/en/invoices/complete?stripe_session_id=<guid>
/en/invoices/complete?spreedly_session_id=<guid>
/en/invoices/complete?paypal_session_id=<guid>
```

The portal reads one of those parameters and uses it as the `token` for both `pdfByToken` and `registerByToken`:

```ts theme={null}
// src/views/public/checkout/complete/index.tsx
const stripeSessionId = searchParams.get('stripe_session_id')   // GUID
const spreedlySessionId = searchParams.get('spreedly_session_id') // GUID
const paypalSessionId = searchParams.get('paypal_session_id')   // GUID

// whichever is present is passed straight through as the token
<CompleteContents token={stripeSessionId} invoice={status.invoice!} ... />

// and then used to build the PDF link:
const pdfUrl = `https://${invoice.BusinessWebAddress}${config.publicBaseUrl}${endpoints.billing.invoices.pdfByToken(invoice.Id, token)}`
```

## Response

Both variants return the raw PDF binary (`application/pdf`). The portal constructs a full URL and opens it in a new browser tab or as a direct link rather than fetching it through the API client.

## Usage in Portal

These endpoints are used to generate PDF download links in two contexts:

1. **My Invoices section** (authenticated customers) – constructs the `pdf` URL using the media JWT.

   * File: `src/views/user/activity/invoices/MyInvoicesSection.tsx`

2. **Invoice basket summary** – shows a download link during checkout.

   * File: `src/views/checkout/components/InvoiceBasketSummary.tsx`

3. **Guest checkout complete page** – uses `pdfByToken` with the payment-gateway basket session GUID to allow PDF download without a session.
   * File: `src/views/public/checkout/complete/index.tsx`

### Typical integration pattern

```ts theme={null}
// Authenticated PDF URL construction
const pdfUrl = `https://${invoice.BusinessWebAddress}${config.publicBaseUrl}${endpoints.billing.invoices.pdf(invoice.Id, mediaJwt)}`

// Guest PDF URL construction — token is the basket session GUID (e.g. stripe_session_id / spreedly_session_id / paypal_session_id)
const pdfUrl = `https://${invoice.BusinessWebAddress}${config.publicBaseUrl}${endpoints.billing.invoices.pdfByToken(invoice.Id, basketSessionGuid)}`

// Then open or link to pdfUrl directly — no fetch required
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details
* `GET /api/auth/media/customer` – Obtain a short-lived media JWT (`{ jwt: string }`) for authenticated downloads. See [Obtaining the Media JWT](#obtaining-the-media-jwt) above for full usage details.

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The current user is not authenticated, or the media JWT or invoice token is invalid or expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Invoice with the given ID does not exist or is not accessible to the caller.
</ResponseField>


# Register Customer by Invoice Token
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-register-by-token

POST /api/public/billing/invoices/{invoiceId}/registerByToken

# Register Customer by Invoice Token

Creates a customer record and grants portal access using a `basketSession` GUID token paired with an invoice ID. This endpoint is called at the end of a guest checkout flow — after payment has been completed — to convert the guest into a registered customer. The combination of the invoice ID and the basket session token is used to verify the purchase, create (or link) the customer account, and return a new token that can be used for subsequent token-gated operations on that invoice.

## Authentication

No bearer token is required. Authentication is performed via the `token` query parameter, which must be the `basketSession` GUID associated with the completed guest checkout session.

## Path Parameters

<ParamField type="number">
  The unique identifier of the invoice generated during guest checkout. This is used alongside the basket session token to locate and validate the
  purchase.
</ParamField>

## Query Parameters

<ParamField type="string">
  The `basketSession` GUID token associated with the guest checkout session. This token is typically passed through the checkout completion URL and
  ties the anonymous session to the invoice, enabling customer record creation and portal access to be granted.
</ParamField>

## Response

<ResponseField name="Token" type="string">
  A new invoice-scoped token returned after successful customer registration. This token can be used for subsequent token-gated requests on this
  invoice, such as downloading the invoice PDF via `pdfByToken`.
</ResponseField>

## Example Response

```json theme={null}
{
  "Token": "eyJhbGciOiJIUzI1NiIsInR..."
}
```

## Usage in Portal

This endpoint is called on the guest checkout completion page immediately after a successful payment. It uses the `basketSession` GUID (available from the checkout URL or session state) together with the invoice ID to:

1. Verify the completed guest purchase.
2. Create a new customer record (or link to an existing one).
3. Grant the customer portal access.
4. Return a fresh token for follow-up token-gated operations (e.g. PDF download).

* File: `src/views/public/checkout/complete/index.tsx`

### Typical integration pattern

```ts theme={null}
// From src/api/endpoints.ts
// endpoints.billing.invoices.registerByToken = (invoiceId: number, basketSessionToken: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/registerByToken?token=${basketSessionToken}`,
//   type: null as unknown as { Token: string },
// })

// Usage – called after guest checkout payment success
const endpoint = endpoints.billing.invoices.registerByToken(invoice.Id, basketSessionToken)
const result = await httpClient.post<{ Token: string }>(endpoint.url, {})
const invoiceToken = result.data.Token // use for pdfByToken or other token-gated requests
```

## Related Endpoints

* `GET /api/public/billing/invoices/{invoiceId}/pdfByToken` – Download invoice PDF using a guest token
* `GET /api/public/billing/invoices/{invoiceId}` – Get full invoice details (authenticated)

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The provided `basketSession` token is invalid, has already been used, or has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No invoice exists with the specified ID, or the token does not match the invoice.
</ResponseField>


# Download Statement PDF
Source: https://learn.nexudus.com/api/endpoints/billing/invoice-statement-pdf

GET /api/public/billing/invoices/statements/pdf

# Download Statement PDF

Returns a PDF statement summarising all invoices for the currently authenticated customer. The statement provides a consolidated overview of billing history in a single downloadable document.

## Authentication

This endpoint requires a valid media JWT token obtained from `GET /api/auth/media/customer`.

## Query Parameters

<ParamField type="string">
  A short-lived media JWT obtained from `GET /api/auth/media/customer`. This token authorises temporary access to the binary file. Pass the `jwt`
  field from the response object directly as this query parameter value.
</ParamField>

## Response

Returns the raw PDF binary (`application/pdf`). The portal constructs the full URL and opens it in a new browser tab.

## Code Examples

<CodeGroup>
  ```ts TypeScript theme={null}
  // 1. Fetch a media JWT (requires a valid Bearer token)
  const { jwt } = await fetch('/api/auth/media/customer', {
    headers: { Authorization: `Bearer ${customerBearerToken}` },
  }).then((r) => r.json())

  // 2. Build the statement PDF URL
  const statementUrl = `https://${business.WebAddress}/en/api/public/billing/invoices/statements/pdf?t=${jwt}`

  // 3. Open directly — no additional fetch needed
  window.open(statementUrl, '_blank')
  ```

  ```bash cURL theme={null}
  # First obtain a media JWT
  MEDIA_JWT=$(curl -s -H "Authorization: Bearer $TOKEN" \
    "https://your-space.nexudus.com/en/api/auth/media/customer" | jq -r '.jwt')

  # Then download the statement PDF
  curl -o statement.pdf \
    "https://your-space.nexudus.com/en/api/public/billing/invoices/statements/pdf?t=$MEDIA_JWT"
  ```
</CodeGroup>

## Usage in Portal

This endpoint is used in the **My Invoices** section to provide a "Download statement" link at the bottom of the invoices table.

* File: `src/views/user/activity/invoices/MyInvoicesSection.tsx`

## Related Endpoints

* `GET /api/public/billing/invoices/my` – List invoices
* `GET /api/public/billing/invoices/{invoiceId}/pdf` – Download a single invoice PDF
* `GET /api/public/billing/invoices/draft/pdf` – Preview upcoming invoice
* `GET /api/auth/media/customer` – Obtain a short-lived media JWT

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  Missing or invalid media JWT token.
</ResponseField>


# Check Booking Availability
Source: https://learn.nexudus.com/api/endpoints/bookings/booking-availability

POST /api/public/bookings/available
Checks whether a resource is available for a specific time slot.

# Check Booking Availability

Checks whether a resource is available for booking at the specified time. Returns availability status and any error codes if the slot is unavailable.

## Authentication

Requires a valid customer bearer token.

## Request Body

<ParamField type="number">
  The resource to check availability for.
</ParamField>

<ParamField type="string">
  Desired start time in ISO 8601 format.
</ParamField>

<ParamField type="string">
  Desired end time in ISO 8601 format.
</ParamField>

## Response

<ResponseField name="Available" type="boolean">
  `true` if the resource is available for the requested time slot.
</ResponseField>

<ResponseField name="ErrorCode" type="string">
  Error code explaining why the slot is unavailable (empty when available).
</ResponseField>

<ResponseField name="CoworkerId" type="number">
  Customer ID associated with the availability check.
</ResponseField>

<ResponseField name="BookingId" type="number">
  Booking ID if checking availability for an existing booking update.
</ResponseField>

## Examples

### Check availability

```http theme={null}
POST /api/public/bookings/available
Authorization: Bearer {token}
Content-Type: application/json

{
  "ResourceId": 88,
  "FromTime": "2026-04-01T09:00:00Z",
  "ToTime": "2026-04-01T10:00:00Z"
}
```

```json theme={null}
{
  "Available": true,
  "ErrorCode": "",
  "CoworkerId": 42,
  "BookingId": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: availability } = useTypedData(httpClient, endpoints.bookings.isAvailable())
```


# Get Booking Details
Source: https://learn.nexudus.com/api/endpoints/bookings/booking-details

GET /api/public/bookings/{id}
Returns the full details of a single booking by its numeric ID.

# Get Booking Details

Returns the complete details of a specific booking, including resource, time range, and pricing information.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the booking.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Booking.ResourceName,Booking.FromTime,Booking.ToTime,Resource.Name`.
</ParamField>

## Response

Returns a `Booking` object with the following fields:

#### Identity

| Field           | Type      | Description                       |
| --------------- | --------- | --------------------------------- |
| `Id`            | `number`  | Unique identifier for the booking |
| `UniqueId`      | `string`  | GUID identifier                   |
| `BookingNumber` | `number?` | Sequential booking number         |

#### Resource

| Field                        | Type       | Description                              |
| ---------------------------- | ---------- | ---------------------------------------- |
| `Resource`                   | `Resource` | Full resource object (nested)            |
| `ResourceId`                 | `number`   | Resource identifier                      |
| `ResourceName`               | `string`   | Display name of the booked resource      |
| `ResourceTypeId`             | `number`   | Resource type identifier                 |
| `ResourceTypeName`           | `string`   | Resource type name                       |
| `ResourceBusinessId`         | `number`   | Business identifier for the resource     |
| `ResourceBusinessName`       | `string`   | Business name for the resource           |
| `ResourceBusinessWebAddress` | `string`   | Business web address                     |
| `ResourceUpdatedOnUtc`       | `string?`  | When the resource was last updated (UTC) |

#### Floor Plan

| Field               | Type            | Description                     |
| ------------------- | --------------- | ------------------------------- |
| `FloorPlanDesk`     | `FloorPlanDesk` | Floor plan desk object (nested) |
| `FloorPlanDeskId`   | `number?`       | Floor plan desk identifier      |
| `FloorPlanDeskName` | `string`        | Floor plan desk name            |

#### Schedule

| Field            | Type      | Description                      |
| ---------------- | --------- | -------------------------------- |
| `FromTime`       | `string`  | Booking start time (local)       |
| `ToTime`         | `string`  | Booking end time (local)         |
| `FromTimeUtc`    | `string`  | Booking start time (UTC)         |
| `ToTimeUtc`      | `string`  | Booking end time (UTC)           |
| `UtcFromTime`    | `string`  | Alias for FromTimeUtc            |
| `UtcToTime`      | `string`  | Alias for ToTimeUtc              |
| `CheckedInAt`    | `string?` | When the user checked in (local) |
| `UtcCheckedInAt` | `string?` | When the user checked in (UTC)   |

#### Coworker

| Field        | Type       | Description                            |
| ------------ | ---------- | -------------------------------------- |
| `Coworker`   | `Coworker` | Coworker who made the booking (nested) |
| `CoworkerId` | `number`   | Coworker identifier                    |

#### Status & Billing

| Field                       | Type      | Description                            |
| --------------------------- | --------- | -------------------------------------- |
| `Tentative`                 | `boolean` | Whether the booking is tentative       |
| `IsCancelled`               | `boolean` | Whether the booking has been cancelled |
| `Recurring`                 | `boolean` | Whether this is a recurring booking    |
| `CancelIfNotPaid`           | `boolean` | Auto-cancel if invoice not paid        |
| `Invoiced`                  | `boolean` | Whether the booking has been invoiced  |
| `CoworkerInvoiceId`         | `number?` | Associated invoice identifier          |
| `CoworkerInvoicePaid`       | `boolean` | Whether the invoice has been paid      |
| `CoworkerInvoiceNumber`     | `string`  | Invoice number                         |
| `CoworkerExtraServicePrice` | `number?` | Price of extra services                |

#### Other

| Field               | Type            | Description                    |
| ------------------- | --------------- | ------------------------------ |
| `Notes`             | `string`        | Booking notes                  |
| `ZoomData`          | `string`        | Zoom meeting data              |
| `IncludeZoomInvite` | `boolean`       | Whether to include Zoom invite |
| `CustomFields`      | `CustomField[]` | Array of custom field values   |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

## Examples

### Fetch booking details

```http theme={null}
GET /api/public/bookings/1234
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: booking } = useTypedData(httpClient, endpoints.bookings.one(1234))
```


# Booking Price
Source: https://learn.nexudus.com/api/endpoints/bookings/booking-price

POST /api/public/bookings/price
Calculate the price for a booking, including dynamic pricing adjustments.

# Booking Price

Calculates the total price for a booking at a specific resource and time slot. When [dynamic pricing](/member-portal/checkout/dynamic-pricing) is enabled, the response includes demand-based and last-minute price adjustments alongside the base price.

This endpoint is used by the Members Portal to display price annotations in the booking calendar and time selectors, but it can also be called directly to preview pricing before creating a booking.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of response fields to include. Use this to limit the response to only the fields you need.

  Example: `Price,DynamicPriceAdjustment,LastMinutePriceAdjustment,PriceFactorDemand`
</ParamField>

## Request Body

<ParamField type="number">
  The resource to calculate pricing for.
</ParamField>

<ParamField type="string">
  Booking start time in ISO 8601 UTC format (e.g. `2026-04-06T10:00:00.000Z`).
</ParamField>

<ParamField type="string">
  Booking end time in ISO 8601 UTC format (e.g. `2026-04-06T11:00:00.000Z`).
</ParamField>

<ParamField type="boolean">
  Whether the booking should be charged immediately.
</ParamField>

<ParamField type="array">
  Array of visitor objects associated with the booking. Pass an empty array if none.
</ParamField>

<ParamField type="array">
  Array of add-on products included in the booking. Pass an empty array if none.
</ParamField>

<ParamField type="object">
  Custom field values for the booking. Use `{ "Data": [] }` if none.
</ParamField>

<ParamField type="number">
  Booking ID. Use `0` for new bookings. For existing bookings, pass the booking ID to preserve any previously locked-in pricing.
</ParamField>

<ParamField type="string">
  A unique identifier for the booking. Use a UUID for new bookings.
</ParamField>

<ParamField type="string">
  Display name of the customer making the booking.
</ParamField>

## Response

<ResponseField name="Price" type="number">
  Total calculated price for the booking, including all dynamic adjustments.
</ResponseField>

<ResponseField name="DynamicPriceAdjustment" type="number">
  Absolute price adjustment from demand-based dynamic pricing. Positive values indicate a surcharge, negative values a discount. `0` when no demand adjustment applies.
</ResponseField>

<ResponseField name="LastMinutePriceAdjustment" type="number">
  Absolute price adjustment for last-minute bookings. Applied when the booking is made within the configured last-minute period before the start time. `0` when not applicable.
</ResponseField>

<ResponseField name="PriceFactorDemand" type="number">
  Demand factor as a decimal multiplier. For example, `0.1` means a 10% surcharge, `-0.15` means a 15% discount. `0` when no demand adjustment applies.
</ResponseField>

## Examples

### Calculate price for a one-hour booking

```http theme={null}
POST /api/public/bookings/price?_shape=Price,DynamicPriceAdjustment,LastMinutePriceAdjustment,PriceFactorDemand
Authorization: Bearer {token}
Content-Type: application/json

{
  "ResourceId": 1491,
  "FromTime": "2026-04-06T10:00:00.000Z",
  "ToTime": "2026-04-06T11:00:00.000Z",
  "ChargeNow": true,
  "BookingVisitors": [],
  "BookingProducts": [],
  "CustomFields": { "Data": [] },
  "Id": 0,
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "CoworkerFullName": "Jane Smith"
}
```

### Response with dynamic pricing surcharge

```json theme={null}
{
  "Price": 33.0,
  "DynamicPriceAdjustment": 3.0,
  "LastMinutePriceAdjustment": 0.0,
  "PriceFactorDemand": 0.1
}
```

In this example, the base price is $30 and a 10 percent demand surcharge of $3 has been applied, resulting in a total of \$33.

### Response with no dynamic pricing

```json theme={null}
{
  "Price": 30.0,
  "DynamicPriceAdjustment": 0.0,
  "LastMinutePriceAdjustment": 0.0,
  "PriceFactorDemand": 0.0
}
```

### Response with last-minute discount

```json theme={null}
{
  "Price": 22.5,
  "DynamicPriceAdjustment": 0.0,
  "LastMinutePriceAdjustment": -7.5,
  "PriceFactorDemand": 0.0
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { BookingPrice } from '@/types/endpoints/BookingPrice'

const PRICE_SHAPE = 'Price,DynamicPriceAdjustment,LastMinutePriceAdjustment,PriceFactorDemand'
const url = `${endpoints.bookings.price().url}?_shape=${PRICE_SHAPE}`

const response = await httpClient.post<BookingPrice>(url, {
  ResourceId: 1491,
  FromTime: '2026-04-06T10:00:00.000Z',
  ToTime: '2026-04-06T11:00:00.000Z',
  ChargeNow: true,
  BookingVisitors: [],
  BookingProducts: [],
  CustomFields: { Data: [] },
  Id: 0,
  UniqueId: crypto.randomUUID(),
  CoworkerFullName: 'Jane Smith',
})
```

## Notes

* Dynamic pricing must be enabled via the `Nexudus.ML.DynamicPricing.Enabled` business setting. When disabled, `DynamicPriceAdjustment`, `LastMinutePriceAdjustment`, and `PriceFactorDemand` will all be `0`.
* Pricing is calculated per hour of the booking. Each hour may have a different demand level, so the total adjustment is the sum of all hourly adjustments.
* Previously charged bookings (non-zero `Id`) preserve their original pricing factors — the response reflects the locked-in adjustments rather than recalculating.
* See [Dynamic Pricing](/member-portal/checkout/dynamic-pricing) for a full explanation of how demand levels, availability thresholds, and last-minute adjustments are determined.


# Booking Products
Source: https://learn.nexudus.com/api/endpoints/bookings/booking-products

GET /api/public/resources/published/{resourceId}/products
Returns the add-on products available for a specific resource.

# Booking Products

Returns the add-on products (e.g. catering, equipment) that can be included with a booking for a specific resource.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the resource.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Products.Name,Products.Price`.
</ParamField>

## Response

Returns an object with a `Products` array. Each product has the following fields:

#### Product Item

| Field                | Type      | Description                                                                                     |
| -------------------- | --------- | ----------------------------------------------------------------------------------------------- |
| `Id`                 | `number`  | Unique identifier for the resource-product link                                                 |
| `ProductId`          | `number`  | Product identifier                                                                              |
| `ProductName`        | `string`  | Display name of the product                                                                     |
| `ProductDescription` | `string`  | Description of the product                                                                      |
| `Product`            | `Product` | Full product object (nested — see [List Store Products](/api/endpoints/products/list-products)) |
| `Tags`               | `string`  | Product tags                                                                                    |
| `RequestQuantity`    | `boolean` | Whether the user can specify a quantity                                                         |
| `Quantity`           | `number`  | Default quantity                                                                                |
| `InvoiceInMinutes`   | `number?` | Billing interval in minutes                                                                     |
| `Price`              | `number`  | Price amount                                                                                    |
| `FormattedPrice`     | `string`  | Locale-formatted price string                                                                   |
| `CurrencyCode`       | `string`  | ISO currency code                                                                               |
| `Selected`           | `boolean` | Whether the product is pre-selected                                                             |
| `TrackStock`         | `boolean` | Whether stock tracking is enabled                                                               |
| `AllowNegativeStock` | `boolean` | Whether negative stock is allowed                                                               |
| `CurrentStock`       | `number?` | Current available stock                                                                         |

## Examples

### Fetch booking products

```http theme={null}
GET /api/public/resources/published/88/products
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: products } = useTypedData(httpClient, endpoints.bookings.bookingProducts(88))
```


# Booking Suggestions
Source: https://learn.nexudus.com/api/endpoints/bookings/booking-suggestions

GET /api/public/bookings/suggestions
Returns AI-generated booking pattern suggestions for the authenticated customer.

# Booking Suggestions

Returns personalised booking suggestions based on the customer's historical usage patterns. Used to offer smart re-booking options on the dashboard.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `BookingSuggestions` object containing an array of suggested bookings based on the customer's usage patterns.

### Top-Level Fields

| Field         | Type       | Description                         |
| ------------- | ---------- | ----------------------------------- |
| `Suggestions` | `object[]` | Array of booking suggestion objects |

### Suggestion Fields (BookingDrop)

#### Identity

| Field      | Type     | Description                               |
| ---------- | -------- | ----------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the booking |
| `UniqueId` | `string` | Globally unique identifier                |

#### Resource

| Field                        | Type     | Description                         |
| ---------------------------- | -------- | ----------------------------------- |
| `ResourceName`               | `string` | Resource display name               |
| `ResourceId`                 | `number` | Resource identifier                 |
| `ResourceTypeName`           | `string` | Resource type (e.g. `Meeting Room`) |
| `ResourceTypeId`             | `number` | Resource type identifier            |
| `ResourceBusinessId`         | `number` | Location identifier                 |
| `ResourceBusinessName`       | `string` | Location display name               |
| `ResourceBusinessWebAddress` | `string` | Location subdomain                  |

#### Schedule

| Field         | Type     | Description                 |
| ------------- | -------- | --------------------------- |
| `FromTime`    | `string` | Start time (business-local) |
| `ToTime`      | `string` | End time (business-local)   |
| `FromTimeUtc` | `string` | Start time (UTC)            |
| `ToTimeUtc`   | `string` | End time (UTC)              |

#### Status

| Field           | Type             | Description                           |
| --------------- | ---------------- | ------------------------------------- |
| `Tentative`     | `boolean`        | Whether the booking is tentative      |
| `Invoiced`      | `boolean`        | Whether the booking has been invoiced |
| `IsCancelled`   | `boolean`        | Whether the booking is cancelled      |
| `BookingNumber` | `number \| null` | Booking reference number              |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch suggestions

```http theme={null}
GET /api/public/bookings/suggestions
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: suggestions } = useTypedData(httpClient, endpoints.bookings.suggestions())
```


# Cancellation Fee
Source: https://learn.nexudus.com/api/endpoints/bookings/cancellation-fee

GET /en/bookings/getCancellationFee
Returns the cancellation fee for a specific booking, if applicable.

# Cancellation Fee

Returns the cancellation fee that would apply if the customer cancels a specific booking. Used to show a confirmation dialog before proceeding with cancellation.

<Note>This endpoint uses the `/en/` legacy route prefix rather than `/api/public/`.</Note>

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number">
  Numeric identifier of the booking to check.
</ParamField>

## Response

Returns the cancellation fee details.

## Examples

### Check cancellation fee

```http theme={null}
GET /en/bookings/getCancellationFee?bookingId=1234
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.bookings.cancellationFee(1234))
```


# Cancelled Bookings
Source: https://learn.nexudus.com/api/endpoints/bookings/cancelled-bookings

GET /api/public/bookings/cancelled
Returns cancelled bookings for the authenticated customer.

# Cancelled Bookings

Returns the list of cancelled bookings for the authenticated customer. Used to show booking history including cancellations.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.ResourceName,Records.FromTime,Records.ToTime`.
</ParamField>

## Response

Returns a `MyBookings` object (`ApiListResult<Booking>`) — a paginated wrapper containing an array of cancelled booking records.

<ResponseField name="Records" type="Booking[]">
  Array of cancelled booking objects for the current page.
</ResponseField>

<ResponseField name="CurrentPage" type="number">
  Current page number (1-based).
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of cancelled bookings.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there are pages before the current one.
</ResponseField>

## Examples

### Fetch cancelled bookings

```http theme={null}
GET /api/public/bookings/cancelled
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { MyBookings } from '@/types/endpoints/MyBookings'
import { useData } from '@/api/fetchData'

const { resource: data } = useData<MyBookings>(httpClient, endpoints.bookings.cancelled)
```


# Delete Booking
Source: https://learn.nexudus.com/api/endpoints/bookings/delete-booking

DELETE /api/public/bookings/{id}
Cancels and deletes a specific booking.

# Delete Booking

Cancels and removes a specific booking. Depending on operator configuration, a cancellation fee may apply. Use the cancellation fee endpoint to check before deleting.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the booking to delete.
</ParamField>

## Response

Returns an `ActionConfirmation` object.

<ResponseField name="WasSuccessful" type="boolean">
  Whether the cancellation was successful.
</ResponseField>

## Examples

### Cancel a booking

```http theme={null}
DELETE /api/public/bookings/1234
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.delete(endpoints.bookings.delete(1234).url)
```


# List My Bookings
Source: https://learn.nexudus.com/api/endpoints/bookings/my-bookings

GET /api/public/bookings/my
Returns the authenticated customer's bookings.

# List My Bookings

Returns the list of active bookings for the authenticated customer across all resources.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.ResourceName,Records.FromTime,Records.ToTime,TotalItems`.
</ParamField>

## Response

Returns a `MyBookings` object (`ApiListResult<Booking>`) — a paginated wrapper containing an array of booking records.

<ResponseField name="Records" type="Booking[]">
  Array of booking objects for the current page.
</ResponseField>

<ResponseField name="CurrentPage" type="number">
  Current page number (1-based).
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of bookings.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there are pages before the current one.
</ResponseField>

## Examples

### Fetch my bookings

```http theme={null}
GET /api/public/bookings/my
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { MyBookings } from '@/types/endpoints/MyBookings'
import { useData } from '@/api/fetchData'

const { resource: data } = useData<MyBookings>(httpClient, endpoints.bookings.myBookings)
```


# Team Bookings
Source: https://learn.nexudus.com/api/endpoints/bookings/team-bookings

GET /api/public/bookings/team
Returns bookings for the authenticated customer's team.

# Team Bookings

Returns active bookings for all members of the authenticated customer's team. Team administrators use this to see and manage their team's resource usage.

## Authentication

Requires a valid customer bearer token. The customer must be a team member or administrator.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.ResourceName,Records.FromTime,Records.ToTime,TotalItems`.
</ParamField>

## Response

Returns a `MyBookings` object (`ApiListResult<Booking>`) — a paginated wrapper containing an array of team booking records.

<ResponseField name="Records" type="Booking[]">
  Array of booking objects for the current page.
</ResponseField>

<ResponseField name="CurrentPage" type="number">
  Current page number (1-based).
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of team bookings.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there are pages before the current one.
</ResponseField>

## Examples

### Fetch team bookings

```http theme={null}
GET /api/public/bookings/team
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { MyBookings } from '@/types/endpoints/MyBookings'
import { useData } from '@/api/fetchData'

const { resource: data } = useData<MyBookings>(httpClient, endpoints.bookings.team)
```


# Check-in Endpoint
Source: https://learn.nexudus.com/api/endpoints/checkins/checkin-endpoint

POST /api/public/checkin
Allows customers to check in to the coworking space using various authentication methods including access codes, email/password, access cards, or MAC address.

# Check-in Endpoint

Allows customers to check in to the coworking space using multiple authentication methods. This endpoint is used by the Members Portal, self-service kiosks, and access control devices (such as WiFi authenticators and door locks) to verify customer identity and grant access.

## Authentication

This endpoint does **not** require a bearer token. Instead, authentication is performed using one of the check-in methods described below. The endpoint automatically determines the customer's location based on the account subdomain.

## Request Body

The request body is a JSON object using the `CheckInRequest` type. Not all fields are required — the endpoint accepts various combinations of parameters depending on the check-in method you want to use.

### CheckInRequest Fields

| Field          | Type    | Required    | Description                                                                                                                     |
| -------------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `email`        | string  | Conditional | Customer's email address. Required for email/password and email/pincode check-in methods.                                       |
| `password`     | string  | Conditional | Customer's account password. Used with `email` for credential-based check-in.                                                   |
| `pincode`      | string  | Conditional | Customer's access pincode. Can be used with or without `email`.                                                                 |
| `mac`          | string  | Conditional | Device MAC address (minimum 8 characters). Used for device-based check-in and auto-check-in.                                    |
| `token`        | string  | Conditional | Access code token. Can be a shared access token or an approved visitor invitation code.                                         |
| `accessCardId` | string  | Conditional | Physical access card ID/number. Used for card-based check-in.                                                                   |
| `disconnect`   | boolean | Optional    | If `true`, disconnects the customer from the current session instead of checking in. Requires a valid `mac` address.            |
| `toggle`       | boolean | Optional    | If `true`, toggles check-in state (checks in if not checked in, checks out if already checked in).                              |
| `doNotCheckIn` | boolean | Optional    | If `true`, performs validation but does not create a check-in record. Useful for verifying access without actually checking in. |

## Check-in Methods

The endpoint supports **six** different check-in methods. Only **one** method needs to be used per request. The methods are evaluated in the following priority order:

### 1. Access Token Check-in

Uses a shared access code token assigned to the location.

**Required fields:**

* `token` — The access code token
* `mac` — Device MAC address (minimum 8 characters)

**Example:**

```json theme={null}
{
  "token": "ABC123XYZ",
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

**Behavior:**

* Validates the token against the location's access tokens
* If the token is a visitor invitation code, verifies the visitor has been approved by their host
* Records the device MAC address against the token
* Returns the session expiration time and remaining minutes
* Fails if the token has been depleted (no remaining minutes)
* Fails if the visitor has not yet been approved by their host

**Response:**

```json theme={null}
{
  "wasSuccessful": true,
  "message": "2026-06-16T18:30:00 UTC",
  "value": {
    "tunnelId": "",
    "sessionExpire": "2026-06-16T18:30:00 UTC",
    "sessionTimeOut": 3600
  }
}
```

***

### 2. MAC Address Auto-Check-in (Token-Based)

Automatically checks in a customer based on their device's MAC address if they have an associated access token.

**Required fields:**

* `mac` — Device MAC address (minimum 8 characters)

**Example:**

```json theme={null}
{
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

**Behavior:**

* Looks up the largest remaining access token associated with the MAC address
* If a valid token with remaining minutes is found, uses it for check-in
* This method is independent of email/password — it uses pre-configured access tokens

***

### 3. Email and Password Check-in

Uses the customer's email and account password.

**Required fields:**

* `email` — Customer's email address
* `password` — Customer's account password

**Example:**

```json theme={null}
{
  "email": "john@example.com",
  "password": "securePassword123"
}
```

**Behavior:**

* Validates the email and password against the system
* Finds the customer's member profile (coworker) associated with the location
* If the customer is not registered with this location but sign-up is enabled, automatically registers them
* Checks device limit (configurable per location, default 20 devices)
* Creates a check-in record

***

### 4. Email and Pincode Check-in

Uses the customer's email and a numeric access pincode.

**Required fields:**

* `email` — Customer's email address
* `pincode` — Customer's access pincode

**Example:**

```json theme={null}
{
  "email": "john@example.com",
  "pincode": "1234"
}
```

**Behavior:**

* Validates the email exists in the system
* Looks up the customer's profile(s) for the location (or network-wide) where `AllowNetworkCheckin` is enabled and the `AccessPincode` matches
* If the customer is not registered with this location but sign-up is enabled, automatically registers them
* Creates a check-in record

***

### 5. Pincode-Only Check-in

Uses only a numeric access pincode without an email address.

**Required fields:**

* `pincode` — Customer's access pincode

**Example:**

```json theme={null}
{
  "pincode": "1234"
}
```

**Behavior:**

* Searches for customers with the matching pincode across the location
* **Exactly one** customer must have the pincode — if multiple customers share the same pincode, the request is rejected for security
* Automatically enables unique pincode generation for all locations in the network to prevent future conflicts
* If the customer is not registered with this location but sign-up is enabled, automatically registers them
* Creates a check-in record

**Note:** This method is typically used on self-service kiosks where customers prefer to enter only a pincode.

***

### 6. Access Card Check-in

Uses a physical access card number.

**Required fields:**

* `accessCardId` — The card ID/number

**Example:**

```json theme={null}
{
  "accessCardId": "CARD-98765"
}
```

**Behavior:**

* Looks up the customer associated with the access card ID
* Validates that the card ID matches one of the customer's registered cards (supports multiple cards separated by commas)
* If the customer is not registered with this location but sign-up is enabled, automatically registers them
* Creates a check-in record

***

### 7. MAC Address Auto-Check-in (User-Based)

Automatically checks in a customer based on their device's MAC address without requiring credentials.

**Required fields:**

* `mac` — Device MAC address (minimum 8 characters)

**Optional fields:**

* `email` — Customer's email (helps disambiguate if multiple users have the same MAC)

**Example:**

```json theme={null}
{
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

**Behavior:**

* Only works if `DisableAutoChecking` is **not** enabled for the location
* Looks up the user by MAC address (optionally filtered by email)
* If both email and MAC are provided, looks up the user by both criteria
* If the customer is not registered with this location but sign-up is enabled, automatically registers them
* Creates a check-in record

**Note:** This method is typically used by WiFi access points and door controllers that automatically detect device MAC addresses.

***

### 8. Disconnect / Check-out

Disconnects a customer from the current session.

**Required fields:**

* `disconnect`: `true`
* `mac` — Device MAC address (minimum 8 characters)

**Example:**

```json theme={null}
{
  "disconnect": true,
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

**Behavior:**

* Finds the largest access token associated with the MAC address
* Calculates remaining minutes since last access
* If no token is found, performs a full check-out by MAC address
* Returns immediately without creating a check-in record

***

### 9. Toggle Check-in

Toggles the customer's check-in state — checks in if not checked in, checks out if already checked in.

**Required fields:**

* `toggle`: `true`

**Optional fields:**

* Any check-in method fields (email/password, pincode, mac, etc.)

**Example:**

```json theme={null}
{
  "toggle": true,
  "email": "john@example.com",
  "password": "securePassword123"
}
```

**Behavior:**

* First authenticates the customer using the provided credentials
* If the customer is already checked in, checks them out
* If the customer is not checked in, checks them in
* Uses the customer's MAC address if provided

***

## Response

Returns an `ActionConfirmation` object.

### Success Response

```json theme={null}
{
  "wasSuccessful": true,
  "message": "2026-06-16T18:30:00 UTC",
  "value": {
    "fullName": "John Doe",
    "coworkerId": 12345,
    "tunnelId": "abc-def-ghi",
    "checkedIn": true,
    "sessionExpire": "2026-06-16T18:30:00 UTC",
    "sessionTimeOut": 3600
  }
}
```

### Check-out Response

```json theme={null}
{
  "wasSuccessful": true,
  "message": "OK",
  "value": {
    "fullName": "John Doe",
    "coworkerId": 12345,
    "checkedIn": false,
    "sessionExpire": "2026-06-16T16:00:00 UTC",
    "sessionTimeOut": 0
  }
}
```

### Error Response

```json theme={null}
{
  "wasSuccessful": false,
  "message": "Invalid card number.",
  "errors": [
    {
      "propertyName": "EventCheckIn",
      "message": "INVALID_CARD_NUMBER"
    }
  ]
}
```

### Error Codes

| Error Code                  | Message                                          | Description                                         |
| --------------------------- | ------------------------------------------------ | --------------------------------------------------- |
| `INVALID_REQUEST_DATA`      | "Invalid request data"                           | Request body is null or malformed                   |
| `INVALID_ACCOUNT_SUBDOMAIN` | "You passed a invalid account subdomain"         | Account subdomain could not be resolved             |
| `INVALID_ACCESS_TOKEN`      | "Access token is not valid."                     | Token does not exist or has expired                 |
| `VISITOR_NOT_APPROVED`      | "Visitor has not yet been approved by host."     | Visitor invitation token is not yet approved        |
| `MAC_NOT_RECEIVED`          | "MAC address was not received."                  | MAC address is required but missing or too short    |
| `TOKEN_DEPLETED`            | "This token has been used completely."           | Token has no remaining minutes                      |
| `INVALID_CARD_NUMBER`       | "Invalid card number."                           | Card ID not found or does not match customer        |
| `INVALID_CREDENTIALS`       | "Invalid username or password"                   | Email/password or email/pincode validation failed   |
| `MISSING_CUSTOMER`          | "This user does not have a member linked to it." | User exists but has no member (coworker) profile    |
| `DEVICE_LIMIT_REACHED`      | "You can't register a new device..."             | Customer has exceeded the device registration limit |
| `NO_ACCESS_TO_SPACE`        | "Coworker does not have access to this space"    | Customer is not registered with this location       |

## Common Use Cases

### Self-Service Kiosk Check-in

Kiosks typically use pincode-only or email/password check-in for customer convenience:

```json theme={null}
{
  "pincode": "1234"
}
```

### WiFi Access Point Authentication

WiFi access points use MAC address auto-check-in:

```json theme={null}
{
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

### Shared Access Code for Guests

Locations can share access tokens with visitors or partners:

```json theme={null}
{
  "token": "GUEST-ACCESS-2026",
  "mac": "AA:BB:CC:DD:EE:FF"
}
```

### Door Controller with Card Reader

Physical access points use card-based check-in:

```json theme={null}
{
  "accessCardId": "CARD-98765"
}
```

## Configuration

The check-in behavior can be customized per location using business settings:

| Setting                          | Default | Description                                                                                             |
| -------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `Checkin.DeviceCountLimit`       | `20`    | Maximum number of devices a customer can register                                                       |
| `Checkin.DailyCutOffTime`        | `0`     | Daily cutoff time for pass calculations                                                                 |
| `Security.GenerateUniquePincode` | `false` | When enabled, pincode-only check-in generates unique codes                                              |
| `DisableAutoChecking`            | `false` | When true, disables MAC address auto-check-in                                                           |
| `MembersSignUp`                  | `false` | When true, automatically registers customers who check in but are not yet registered with this location |

## Related Documentation

* [Check-in Methods](/platform/access-control/check-in-methods) — Overview of all check-in methods available in the Nexudus platform
* [Check-in Metrics](/api/endpoints/checkins/checkin-metrics) — Retrieve aggregate check-in metrics
* [WiFi Configuration](/platform/access-control/wifi) — Configure WiFi access control


# Check-in Metrics
Source: https://learn.nexudus.com/api/endpoints/checkins/checkin-metrics

GET /api/public/checkins/metrics
Returns check-in metrics for the specified business locations.

# Check-in Metrics

Returns aggregate check-in metrics (current occupancy, daily totals, etc.) for one or more business locations. Used to display occupancy information on the dashboard.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number[]">
  Array of business IDs to retrieve metrics for. Passed as repeated query parameters: `businessesIds=1&businessesIds=2`.
</ParamField>

## Response

Returns check-in metrics for the requested locations.

## Examples

### Fetch metrics for two locations

```http theme={null}
GET /api/public/checkins/metrics?businessesIds=1&businessesIds=2
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.checkins.metrics([1, 2]))
```


# Get Checkout Fields
Source: https://learn.nexudus.com/api/endpoints/checkout/checkout-fields

GET /api/public/checkout/fields
Returns the configured form fields for the sign-up checkout flow.

# Get Checkout Fields

Returns the list of form fields configured by the operator for the sign-up/checkout process. Used to dynamically render the sign-up form with required, optional, and custom fields.

## Authentication

No authentication required.

## Response

Returns an object describing the available checkout form fields and their configuration.

## Examples

### Fetch checkout fields

```http theme={null}
GET /api/public/checkout/fields
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.checkout.fields)
```


# Get Checkout Types
Source: https://learn.nexudus.com/api/endpoints/checkout/checkout-types

GET /api/public/checkout/types
Returns the available resource types, tariff types, and product types for the checkout flow.

# Get Checkout Types

Returns the system enum values for resource types, tariff types, and product types available in the checkout flow. Used to configure the checkout UI based on what the operator has enabled for members vs. contacts.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="boolean">
  When `true`, returns only types the operator has made visible in the portal.
</ParamField>

<ParamField type="number">
  Optional business ID to scope types to a specific location.
</ParamField>

## Response

<ResponseField name="ResourceTypes" type="eSystemResourceType[]">
  All resource types available for checkout.
</ResponseField>

<ResponseField name="TariffTypes" type="eTariffType[]">
  All tariff/plan types available for checkout.
</ResponseField>

<ResponseField name="ProductTypes" type="eProductType[]">
  All product types available for checkout.
</ResponseField>

<ResponseField name="ResourceTypesMembers" type="eSystemResourceType[]">
  Resource types available specifically to members.
</ResponseField>

<ResponseField name="ResourceTypesContacts" type="eSystemResourceType[]">
  Resource types available specifically to contacts.
</ResponseField>

<ResponseField name="ProductTypesMembers" type="eProductType[]">
  Product types available specifically to members.
</ResponseField>

<ResponseField name="ProductTypesContacts" type="eProductType[]">
  Product types available specifically to contacts.
</ResponseField>

## Examples

### Fetch checkout types

```http theme={null}
GET /api/public/checkout/types?onlyVisible=true
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: types } = useTypedData(httpClient, endpoints.checkout.types(true))
```


# Contact Sign Up
Source: https://learn.nexudus.com/api/endpoints/checkout/contact

POST /api/public/signup/contact
Creates a contact-level account (non-member) through the public sign-up flow.

# Contact Sign Up

Creates a new contact-level account. Contacts are users who are not full members but have registered interest, attended events, or interacted with the space. This endpoint is used for lighter-weight registration flows.

## Authentication

No authentication required.

## Request Body

Same dynamic field structure as the main sign-up endpoint, based on operator checkout configuration.

<ParamField type="string">
  Full name of the contact.
</ParamField>

<ParamField type="string">
  Email address for the contact account.
</ParamField>

## Response

Returns a confirmation object on success.

## Examples

### Register a contact

```http theme={null}
POST /api/public/signup/contact
Content-Type: application/json

{
  "FullName": "John Visitor",
  "Email": "john@example.com"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.checkout.contact, formData)
```


# Sign Up
Source: https://learn.nexudus.com/api/endpoints/checkout/signup

POST /api/public/signup
Creates a new customer account through the public sign-up flow.

# Sign Up

Creates a new customer account. The request body should include all required fields from the checkout fields configuration. This is the primary public registration endpoint for new members.

## Authentication

No authentication required.

## Request Body

The request body wraps the coworker data inside a `Coworker` property, along with additional registration fields.

<ParamField type="object">
  Object containing the new member's profile fields. Fields are dynamic based on operator checkout configuration.
</ParamField>

<ParamField type="string">
  Full name of the new member.
</ParamField>

<ParamField type="string">
  Email address for the account.
</ParamField>

<ParamField type="string">
  Base64-encoded avatar image, if provided during signup.
</ParamField>

<ParamField type="string">
  reCAPTCHA token for bot protection.
</ParamField>

<ParamField type="string">
  Team GUID if the signup is via a team invite link.
</ParamField>

<ParamField type="string">
  Tariff/plan GUID if the signup is via a plan invite link.
</ParamField>

<ParamField type="string">
  Plan ID if pre-selecting a membership plan.
</ParamField>

## Response

Returns a confirmation object with a token for automatic sign-in.

<ResponseField name="WasSuccessful" type="string">
  Whether the signup was successful.
</ResponseField>

<ResponseField name="Token" type="string">
  JWT token for automatic sign-in after registration.
</ResponseField>

## Examples

### Register a new member

```http theme={null}
POST /api/public/signup
Content-Type: application/json

{
  "Coworker": {
    "FullName": "Jane Smith",
    "Email": "jane@example.com"
  },
  "recaptcha": "03AGdBq24...",
  "Base64Avatar": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.post<{ WasSuccessful: string; Token: string }>(endpoints.checkout.signup, {
  Coworker: coworkerData,
  Base64Avatar: avatarBase64,
  recaptcha: recaptchaToken,
  TeamGuid: teamGuid,
  TariffId: planId,
})
```


# Create Thread Message
Source: https://learn.nexudus.com/api/endpoints/community/create-message

POST /api/public/community/board/threads/{threadId}/messages
Posts a reply in a discussion board thread.

# Create Thread Message

Posts a new reply message in an existing discussion board thread.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread to reply to.
</ParamField>

## Request Body

<ParamField type="string">
  The text content of the reply.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.messages.create(101), {
  Content: 'Great suggestion, thanks!',
})
```


# Create Thread
Source: https://learn.nexudus.com/api/endpoints/community/create-thread

POST /api/public/community/board/threads
Creates a new discussion board thread.

# Create Thread

Creates a new thread in a discussion board group. The authenticated customer becomes the thread author.

## Authentication

Requires a valid customer bearer token.

## Request Body

<ParamField type="number">
  The discussion group to post in.
</ParamField>

<ParamField type="string">
  Thread title.
</ParamField>

<ParamField type="string">
  Thread body content.
</ParamField>

<ParamField type="string[]">
  Optional array of tags to apply.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Create a thread

```http theme={null}
POST /api/public/community/board/threads
Authorization: Bearer {token}
Content-Type: application/json

{
  "GroupId": 1,
  "Title": "Lunch recommendations nearby?",
  "Content": "Looking for good lunch spots within walking distance.",
  "Tags": ["food", "local"]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.threads.create, threadData)
```


# Delete Thread Message
Source: https://learn.nexudus.com/api/endpoints/community/delete-message

DELETE /api/public/community/board/threads/{threadId}/messages/{messageId}
Deletes a message from a discussion board thread.

# Delete Thread Message

Removes a specific message from a discussion board thread. Only the message author can delete their own messages.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

<ParamField type="number">
  Numeric identifier of the message to delete.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.community.board.messages.delete(101, 55))
```


# Delete Thread
Source: https://learn.nexudus.com/api/endpoints/community/delete-thread

DELETE /api/public/community/board/threads/{threadId}
Deletes a discussion board thread.

# Delete Thread

Removes a discussion board thread and all its messages. Only the thread author can delete their own threads.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.community.board.threads.delete(101))
```


# Follow Thread
Source: https://learn.nexudus.com/api/endpoints/community/follow-thread

POST /api/public/community/board/threads/{threadId}/follow
Toggles follow status on a discussion board thread.

# Follow Thread

Toggles the authenticated customer's follow status on a thread. Following a thread enables notifications for new replies.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.threads.follow(101))
```


# Get Thread
Source: https://learn.nexudus.com/api/endpoints/community/get-thread

GET /api/public/community/board/threads/{threadId}
Returns the full details of a discussion board thread.

# Get Thread

Returns the full details of a specific discussion board thread, including the original post content and metadata.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Subject,Message,Tags,MessageCount,LikeCount`.
</ParamField>

## Response

Returns a thread detail object with the following fields.

### Thread Fields

#### Identity

| Field      | Type     | Description                              |
| ---------- | -------- | ---------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the thread |
| `UniqueId` | `string` | Globally unique identifier               |

#### Content

| Field       | Type       | Description                          |
| ----------- | ---------- | ------------------------------------ |
| `Subject`   | `string`   | Thread subject / title               |
| `Message`   | `string`   | Original post content (HTML-encoded) |
| `Tags`      | `string`   | Comma-separated tag string           |
| `TagsArray` | `string[]` | Array of individual tag strings      |
| `Private`   | `boolean`  | Whether the thread is private        |

#### Group

| Field       | Type             | Description                   |
| ----------- | ---------------- | ----------------------------- |
| `GroupId`   | `number \| null` | Discussion group identifier   |
| `GroupName` | `string \| null` | Discussion group display name |

#### Activity

| Field             | Type             | Description                  |
| ----------------- | ---------------- | ---------------------------- |
| `PostedOn`        | `string`         | Date posted (business-local) |
| `UtcPostedOn`     | `string`         | Date posted (UTC)            |
| `LastMessageDate` | `string \| null` | Date of last reply           |

#### Video Conference

| Field           | Type             | Description                           |
| --------------- | ---------------- | ------------------------------------- |
| `HasZoom`       | `boolean`        | Whether the thread has a Zoom meeting |
| `ZoomUrl`       | `string \| null` | Zoom meeting join URL                 |
| `ZoomMeetingId` | `string \| null` | Zoom meeting identifier               |

#### Nested Objects

| Field      | Type     | Description                                     |
| ---------- | -------- | ----------------------------------------------- |
| `Business` | `object` | Location object (`Id`, `Name`, `WebAddress`)    |
| `User`     | `object` | Author object (`Id`, `FullName`, `Email`, etc.) |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch thread

```http theme={null}
GET /api/public/community/board/threads/101
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.threads.one(101))
```


# Like Thread Message
Source: https://learn.nexudus.com/api/endpoints/community/like-message

POST /api/public/community/board/{threadId}/messages/{messageId}/like
Toggles a like on a discussion board message.

# Like Thread Message

Toggles the authenticated customer's like on a specific message within a thread.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

<ParamField type="number">
  Numeric identifier of the message.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.messages.like(101, 55))
```


# Like Thread
Source: https://learn.nexudus.com/api/endpoints/community/like-thread

POST /api/public/community/board/threads/{threadId}/like
Toggles a like on a discussion board thread.

# Like Thread

Toggles the authenticated customer's like on a thread. Call once to like, call again to unlike.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.threads.like(101))
```


# List Discussion Groups
Source: https://learn.nexudus.com/api/endpoints/community/list-groups

GET /api/public/community/board/groups
Returns the available discussion board groups.

# List Discussion Groups

Returns the list of discussion board groups (categories/channels) available in the community. Used to populate group selectors and navigation.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Groups.Name,Groups.Description`.
</ParamField>

## Response

Returns an array of group objects with the following fields.

### Group Fields

#### Identity

| Field      | Type     | Description                             |
| ---------- | -------- | --------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the group |
| `UniqueId` | `string` | Globally unique identifier              |

#### Core

| Field             | Type      | Description                                              |
| ----------------- | --------- | -------------------------------------------------------- |
| `Name`            | `string`  | Group display name                                       |
| `Description`     | `string`  | Group description                                        |
| `GroupAccess`     | `string`  | Access level (e.g. `Public`, `Private`)                  |
| `CanPostMessages` | `boolean` | Whether the current user can post messages in this group |

#### Nested Objects

| Field      | Type     | Description                                  |
| ---------- | -------- | -------------------------------------------- |
| `Business` | `object` | Location object (`Id`, `Name`, `WebAddress`) |
| `User`     | `object` | Group owner object (`Id`, `FullName`, etc.)  |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch groups

```http theme={null}
GET /api/public/community/board/groups
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.groups)
```


# List Thread Messages
Source: https://learn.nexudus.com/api/endpoints/community/list-messages

GET /api/public/community/board/threads/{threadId}/messages
Returns all messages (replies) in a discussion board thread.

# List Thread Messages

Returns all messages (replies) in a specific discussion board thread, in chronological order.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Message,Records.User,Records.PostedOn`.
</ParamField>

## Response

Returns an array of message objects with the following fields.

### Message Fields

#### Identity

| Field      | Type     | Description                               |
| ---------- | -------- | ----------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the message |
| `UniqueId` | `string` | Globally unique identifier                |

#### Content

| Field         | Type     | Description                       |
| ------------- | -------- | --------------------------------- |
| `Message`     | `string` | Message body text (HTML-encoded)  |
| `PostedOn`    | `string` | Date posted (business-local time) |
| `UtcPostedOn` | `string` | Date posted (UTC)                 |

#### Nested Objects

| Field             | Type     | Description                                     |
| ----------------- | -------- | ----------------------------------------------- |
| `CommunityThread` | `object` | Parent thread object (`Id`, `Subject`, etc.)    |
| `User`            | `object` | Author object (`Id`, `FullName`, `Email`, etc.) |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.messages.list(101))
```


# List Discussion Tags
Source: https://learn.nexudus.com/api/endpoints/community/list-tags

GET /api/public/community/board/tags
Returns the available tags for discussion board threads.

# List Discussion Tags

Returns all tags that can be applied to discussion board threads. Used to populate tag selectors and filters.

## Authentication

Requires a valid customer bearer token.

## Response

Returns an array of tag strings.

## Examples

### Fetch tags

```http theme={null}
GET /api/public/community/board/tags
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.tags)
```


# List Discussion Threads
Source: https://learn.nexudus.com/api/endpoints/community/list-threads

GET /api/public/community/board/threads
Returns discussion board threads filtered by group, inbox, query, and tag.

# List Discussion Threads

Returns a list of discussion board threads for the community feature. Supports filtering by group, inbox type, keyword search, and tag.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number">
  Filter threads to a specific discussion group.
</ParamField>

<ParamField type="string">
  Inbox filter (e.g. `null` for all, or specific inbox type).
</ParamField>

<ParamField type="string">
  Keyword search filter.
</ParamField>

<ParamField type="string">
  Filter by tag name.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Subject,Records.LastMessageUtc,Records.MessageCount`.
</ParamField>

## Response

Returns a paginated list of thread summary objects.

### Thread Summary Fields

#### Identity

| Field            | Type     | Description                              |
| ---------------- | -------- | ---------------------------------------- |
| `Id`             | `number` | Unique numeric identifier for the thread |
| `UniqueId`       | `string` | Globally unique identifier               |
| `ThreadUniqueId` | `string` | Thread-specific unique identifier        |

#### Content

| Field     | Type       | Description                   |
| --------- | ---------- | ----------------------------- |
| `Subject` | `string`   | Thread subject / title        |
| `Message` | `string`   | Original post content         |
| `Tags`    | `string[]` | Array of tag strings          |
| `Private` | `boolean`  | Whether the thread is private |

#### Author

| Field           | Type     | Description                        |
| --------------- | -------- | ---------------------------------- |
| `UserId`        | `number` | Author user identifier             |
| `CoworkerId`    | `number` | Author coworker identifier         |
| `FullName`      | `string` | Author full name                   |
| `ShortFullName` | `string` | Abbreviated name (first + initial) |

#### Group & Location

| Field                | Type     | Description                   |
| -------------------- | -------- | ----------------------------- |
| `GroupId`            | `number` | Discussion group identifier   |
| `GroupName`          | `string` | Discussion group display name |
| `BusinessId`         | `number` | Location identifier           |
| `BusinessName`       | `string` | Location display name         |
| `BusinessWebAddress` | `string` | Location subdomain identifier |

#### Activity

| Field                     | Type             | Description                      |
| ------------------------- | ---------------- | -------------------------------- |
| `MessageCount`            | `number`         | Total number of replies          |
| `LikeCount`               | `number`         | Total number of likes            |
| `LastMessage`             | `string \| null` | Last reply date (business-local) |
| `LastMessageUtc`          | `string \| null` | Last reply date (UTC)            |
| `LastMessageText`         | `string`         | Last reply message text          |
| `LastMessageUserFullName` | `string`         | Name of last reply author        |
| `LastMessageCoworkerId`   | `number \| null` | Coworker id of last reply author |
| `LastMessageId`           | `number \| null` | Id of the last reply message     |

#### Participation

| Field          | Type       | Description                         |
| -------------- | ---------- | ----------------------------------- |
| `Participants` | `string[]` | Array of participant identifiers    |
| `FullNames`    | `string[]` | Array of participant full names     |
| `Likes`        | `string[]` | Array of users who liked the thread |
| `FileIDs`      | `string[]` | Array of attached file identifiers  |
| `FileNames`    | `string[]` | Array of attached file names        |

#### User State

| Field            | Type      | Description                          |
| ---------------- | --------- | ------------------------------------ |
| `MutedForUser`   | `boolean` | Whether muted by the current user    |
| `FollowedByUser` | `boolean` | Whether followed by the current user |
| `LikedByUser`    | `boolean` | Whether liked by the current user    |

#### Timestamps

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `PostedOn`     | `string`         | Date posted (business-local time)       |
| `PostedOnUtc`  | `string`         | Date posted (UTC)                       |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch threads in a group

```http theme={null}
GET /api/public/community/board/threads?groupId=1&inbox=&query=&tag=
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.community.board.list(1))
```


# Mute Thread
Source: https://learn.nexudus.com/api/endpoints/community/mute-thread

POST /api/public/community/board/threads/{threadId}/mute
Toggles mute status on a discussion board thread.

# Mute Thread

Toggles the authenticated customer's mute status on a thread. Muting suppresses notifications for replies on the thread.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the thread.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.community.board.threads.mute(101))
```


# Complete Lesson
Source: https://learn.nexudus.com/api/endpoints/courses/complete-lesson

POST /api/public/courses/{courseId}/lessons/{lessonUniqueId}/complete
Marks a lesson as completed for the authenticated customer.

# Complete Lesson

Marks a specific lesson as completed for the authenticated customer. Progress is tracked per customer per course. Once all lessons are completed, the course is considered finished.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the course.
</ParamField>

<ParamField type="string">
  The UUID (`UniqueId`) of the lesson to mark as complete. Obtained from `GET /api/public/courses/v2/{courseId}/lessons/{lessonId}`.
</ParamField>

## Request Body

No request body required.

## Response

Returns a `200 OK` on success.

## Examples

### Mark a lesson as complete

```http theme={null}
POST /api/public/courses/42/lessons/a1b2c3d4-e5f6-7890-abcd-ef1234567890/complete
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.courses.completeLesson(42, 'a1b2c3d4-e5f6-7890-abcd-ef1234567890').url)
```


# Get Course Details
Source: https://learn.nexudus.com/api/endpoints/courses/course-details

GET /api/public/courses/v2/{id}/summary
Returns the summary and metadata for a single course.

# Get Course Details

Returns the full summary for a specific course, including description, lesson count, and enrolment status. Used on the course detail page before the member chooses to enrol.

## Authentication

No authentication required for public course details. Enrolment status fields are populated only for authenticated customers.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the course. Returned as `Id` in the records from `GET /api/public/courses/v2`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `CourseSummary` object. The course metadata is nested inside a `Course` property.

<ResponseField name="Enrolled" type="boolean">
  Whether the authenticated customer is enrolled in this course.
</ResponseField>

<ResponseField name="Completed" type="boolean">
  Whether the authenticated customer has completed this course.
</ResponseField>

<ResponseField name="Completeness" type="number">
  Completion percentage (0–100).
</ResponseField>

<ResponseField name="LessonsCount" type="number">
  Total number of lessons in the course.
</ResponseField>

<ResponseField name="Course" type="Course">
  The course metadata object.
</ResponseField>

<ResponseField name="Course.Id" type="number">
  Unique identifier for the course.
</ResponseField>

<ResponseField name="Course.Title" type="string">
  Display title of the course.
</ResponseField>

<ResponseField name="Course.FullDescription" type="string">
  Full course description. May contain HTML.
</ResponseField>

<ResponseField name="Course.SummaryText" type="string">
  Short summary text for the course.
</ResponseField>

<ResponseField name="Lessons" type="Lesson[]">
  Array of lesson summaries for the course.
</ResponseField>

<ResponseField name="Host" type="Coworker">
  The host/instructor of the course.
</ResponseField>

<ResponseField name="Tariff" type="Tariff">
  Pricing information for the course, if applicable.
</ResponseField>

## Examples

### Fetch course summary

```http theme={null}
GET /api/public/courses/v2/42/summary
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: course } = useTypedData(httpClient, endpoints.courses.details(42))
```


# Get Course Lesson
Source: https://learn.nexudus.com/api/endpoints/courses/course-lesson

GET /api/public/courses/v2/{courseId}/lessons/{lessonId}
Returns the full content of a single lesson within a course.

# Get Course Lesson

Returns the full content and metadata for a specific lesson within a course. Used to display lesson content and allow the customer to mark it as complete.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the course.
</ParamField>

<ParamField type="number">
  Numeric identifier of the lesson within the course.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `CourseLesson` object. The lesson content is nested inside a `Lesson` property.

<ResponseField name="Lesson" type="FullLesson">
  The lesson content object.
</ResponseField>

<ResponseField name="Lesson.Id" type="number">
  Unique identifier for the lesson.
</ResponseField>

<ResponseField name="Lesson.UniqueId" type="string">
  UUID for the lesson — used as `{lessonUniqueId}` in the complete-lesson endpoint.
</ResponseField>

<ResponseField name="Lesson.Title" type="string">
  Display title of the lesson.
</ResponseField>

<ResponseField name="Lesson.LessonContents" type="string">
  Full lesson content. May contain HTML.
</ResponseField>

<ResponseField name="Lesson.SummaryText" type="string">
  Short summary text for the lesson.
</ResponseField>

<ResponseField name="Completed" type="boolean">
  Whether the authenticated customer has marked this lesson as complete.
</ResponseField>

<ResponseField name="HasNextLesson" type="boolean">
  Whether there is a next lesson in the course.
</ResponseField>

<ResponseField name="IsLastActiveLesson" type="boolean">
  Whether this is the last active (uncompleted) lesson.
</ResponseField>

<ResponseField name="Course" type="CourseSummary">
  The parent course summary.
</ResponseField>

<ResponseField name="Section" type="Section">
  The section this lesson belongs to.
</ResponseField>

## Examples

### Fetch a lesson

```http theme={null}
GET /api/public/courses/v2/42/lessons/7
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: lesson } = useTypedData(httpClient, endpoints.courses.lesson(42, 7))
```


# List Course Lessons
Source: https://learn.nexudus.com/api/endpoints/courses/course-lessons

GET /api/public/courses/v2/{courseId}/lessons
Returns all lessons belonging to a specific course.

# List Course Lessons

Returns the ordered list of lessons for a specific course. Used to render the course syllabus and track which lessons the customer has completed.

## Authentication

Requires a valid customer bearer token to include completion status.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the course. Returned as `Id` from `GET /api/public/courses/v2`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `CourseSummary` object containing the lessons array and course-level metadata.

### Top-Level Fields

| Field             | Type      | Description                                    |
| ----------------- | --------- | ---------------------------------------------- |
| `Enrolled`        | `boolean` | Whether the customer is enrolled in the course |
| `Completed`       | `boolean` | Whether the customer has completed the course  |
| `Completeness`    | `number`  | Completion percentage (0–1)                    |
| `CanAccessCourse` | `boolean` | Whether the customer can access course content |
| `AttendeeCount`   | `number`  | Number of enrolled attendees                   |
| `LessonsCount`    | `number`  | Total number of lessons                        |
| `CreatedOnUtc`    | `string`  | Course creation date (UTC)                     |

### Attendee (current customer)

| Field          | Type     | Description                      |
| -------------- | -------- | -------------------------------- |
| `Id`           | `number` | Attendee record identifier       |
| `FullName`     | `string` | Attendee full name               |
| `Email`        | `string` | Attendee email                   |
| `CreatedOn`    | `string` | Enrollment date (business-local) |
| `CreatedOnUtc` | `string` | Enrollment date (UTC)            |

### Course

| Field               | Type             | Description                               |
| ------------------- | ---------------- | ----------------------------------------- |
| `Id`                | `number`         | Course identifier                         |
| `Title`             | `string`         | Course title                              |
| `SummaryText`       | `string`         | Short course summary                      |
| `FullDescription`   | `string`         | Full course description (HTML)            |
| `OverviewText`      | `string`         | Course overview text                      |
| `GroupName`         | `string`         | Course group / category name              |
| `Visibility`        | `string`         | Visibility setting                        |
| `Active`            | `boolean`        | Whether the course is active              |
| `ShowInHomePage`    | `boolean`        | Whether shown on the home page            |
| `ShowOverview`      | `boolean`        | Whether the overview tab is visible       |
| `HasCommunityGroup` | `boolean`        | Whether the course has a discussion group |
| `CreatedOn`         | `string`         | Date created (business-local time)        |
| `CreatedOnUtc`      | `string`         | Date created (UTC)                        |
| `UpdatedOn`         | `string \| null` | Date last updated (business-local time)   |
| `UpdatedOnUtc`      | `string \| null` | Date last updated (UTC)                   |

### Lessons Array

| Field          | Type      | Description                           |
| -------------- | --------- | ------------------------------------- |
| `Id`           | `number`  | Lesson identifier                     |
| `Title`        | `string`  | Lesson title                          |
| `SummaryText`  | `string`  | Lesson summary text                   |
| `DisplayOrder` | `number`  | Sort order within the course          |
| `IsOpen`       | `boolean` | Whether the lesson is available       |
| `IsComplete`   | `boolean` | Whether the customer has completed it |

### Lessons Section (nested)

| Field                  | Type     | Description        |
| ---------------------- | -------- | ------------------ |
| `Section.Id`           | `number` | Section identifier |
| `Section.Title`        | `string` | Section title      |
| `Section.DisplayOrder` | `number` | Section sort order |

### Other

| Field            | Type             | Description                            |
| ---------------- | ---------------- | -------------------------------------- |
| `Tariff`         | `object \| null` | Associated plan/tariff (if any)        |
| `Host`           | `object \| null` | Course host profile                    |
| `CommunityGroup` | `object \| null` | Linked discussion group (`Id`, `Name`) |
| `CurrentLesson`  | `object \| null` | The first open, incomplete lesson      |

## Examples

### Fetch lessons for a course

```http theme={null}
GET /api/public/courses/v2/42/lessons
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: lessons } = useTypedData(httpClient, endpoints.courses.lessons(42))
```


# Enrol in Course
Source: https://learn.nexudus.com/api/endpoints/courses/enroll-course

POST /api/public/courses/{id}/signup
Enrols the authenticated customer in a published course.

# Enrol in Course

Registers the authenticated customer as an enrolled participant in the specified course. After enrolment, the customer can access lessons and track progress.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the course to enrol in. Returned as `Id` from `GET /api/public/courses/v2`.
</ParamField>

## Request Body

No request body required.

## Response

Returns a `200 OK` on successful enrolment.

## Examples

### Enrol in a course

```http theme={null}
POST /api/public/courses/42/signup
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.courses.enroll(42).url)
```


# List Courses
Source: https://learn.nexudus.com/api/endpoints/courses/list-courses

GET /api/public/courses/v2
Returns a paginated list of published courses, with optional filtering by category, keyword, and home page flag.

# List Courses

Returns a paginated list of published courses for the current location. Supports filtering by category name, keyword search, and a flag to only return courses marked for the home page.

<Note>
  A **course** is a structured learning programme created by the space operator, consisting of multiple lessons. Members can enrol, track progress,
  and complete lessons through the portal.
</Note>

## Authentication

No authentication required.

## Query Parameters

<ParamField type="number">
  1-based page number.
</ParamField>

<ParamField type="number">
  Number of courses per page.
</ParamField>

<ParamField type="string">
  Filter by category name. Omit to return courses across all categories.
</ParamField>

<ParamField type="string">
  Keyword filter applied to course name and description. URL-encoded.
</ParamField>

<ParamField type="boolean">
  When `true`, returns only courses flagged to appear on the portal home page.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Courses.Records.Name,Courses.Records.Description,Categories`.
</ParamField>

## Response

Returns a `CourseList` object containing available categories and a paginated list of course summaries.

<ResponseField name="Categories" type="string[]">
  Array of all available course category names for filtering.
</ResponseField>

<ResponseField name="Courses" type="ApiListResult<CourseStatus>">
  Paginated wrapper containing course records.
</ResponseField>

<ResponseField name="Courses.Records" type="CourseStatus[]">
  Array of course summaries for the current page.
</ResponseField>

<ResponseField name="Courses.CurrentPage" type="number">
  Current page number.
</ResponseField>

<ResponseField name="Courses.TotalItems" type="number">
  Total number of matching courses.
</ResponseField>

<ResponseField name="Courses.TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="Courses.HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

## Examples

### Fetch first page of courses

```http theme={null}
GET /api/public/courses/v2?page=1&top=10
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: courses } = useTypedData(
  httpClient,
  endpoints.courses.list({
    page: 1,
    top: 10,
    categoryName: 'Marketing',
  }),
)
```


# List My Courses
Source: https://learn.nexudus.com/api/endpoints/courses/my-courses

GET /api/public/courses/v2/my
Returns all courses the authenticated customer is enrolled in.

# List My Courses

Returns a paginated list of courses the authenticated customer has enrolled in. Includes progress information such as completed lesson count.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Name,Records.Description,Records.Progress`.
</ParamField>

## Response

Returns an `ApiListResult<CourseSummary>` with the customer's enrolled courses and progress.

The top-level response includes standard pagination fields (`CurrentPage`, `TotalItems`, `TotalPages`, etc.). Each item in the `Records` array has:

#### Status

| Field             | Type      | Description                                   |
| ----------------- | --------- | --------------------------------------------- |
| `Enrolled`        | `boolean` | Whether the customer is enrolled              |
| `Completed`       | `boolean` | Whether the customer has completed the course |
| `Completeness`    | `number`  | Completion percentage (0–1)                   |
| `CanAccessCourse` | `boolean` | Whether the customer can access the course    |

#### Counts

| Field           | Type     | Description               |
| --------------- | -------- | ------------------------- |
| `AttendeeCount` | `number` | Total number of attendees |
| `LessonsCount`  | `number` | Total number of lessons   |

#### Attendee

| Field                   | Type     | Description            |
| ----------------------- | -------- | ---------------------- |
| `Attendee.Id`           | `number` | Attendee identifier    |
| `Attendee.FullName`     | `string` | Attendee full name     |
| `Attendee.Email`        | `string` | Attendee email address |
| `Attendee.CreatedOn`    | `string` | Enrolment date (local) |
| `Attendee.CreatedOnUtc` | `string` | Enrolment date (UTC)   |

#### Course

| Field                      | Type       | Description                          |
| -------------------------- | ---------- | ------------------------------------ |
| `Course.Id`                | `number`   | Course identifier                    |
| `Course.Title`             | `string`   | Course title                         |
| `Course.SummaryText`       | `string`   | Short course summary                 |
| `Course.FullDescription`   | `string`   | Full course description              |
| `Course.OverviewText`      | `string`   | Course overview text                 |
| `Course.GroupName`         | `string`   | Course group/category name           |
| `Course.Visibility`        | `string`   | Course visibility setting            |
| `Course.Active`            | `boolean`  | Whether the course is active         |
| `Course.ShowInHomePage`    | `boolean`  | Whether shown on home page           |
| `Course.ShowOverview`      | `boolean`  | Whether overview is shown            |
| `Course.HasCommunityGroup` | `boolean`  | Whether course has a community group |
| `Course.Business`          | `Business` | Business hosting the course          |

#### Nested Objects

| Field            | Type         | Description                     |
| ---------------- | ------------ | ------------------------------- |
| `Tariff`         | `Tariff`     | Associated plan/tariff          |
| `Attendees`      | `Coworker[]` | List of course attendees        |
| `CommunityGroup` | `object`     | Community group (`Id`, `Name`)  |
| `Lessons`        | `object[]`   | Course lessons                  |
| `Host`           | `Coworker`   | Course host/instructor          |
| `CreatedOnUtc`   | `string`     | Record creation timestamp (UTC) |

## Examples

### Fetch enrolled courses

```http theme={null}
GET /api/public/courses/v2/my
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: myCourses } = useTypedData(httpClient, endpoints.courses.my())
```


# Get Customer Benefits
Source: https://learn.nexudus.com/api/endpoints/coworkers/customer-benefits

GET /api/public/coworkers/profiles/current/benefits
Retrieve the plan benefits available to the current customer profile, including booking credits, extra services, and time passes.

# Get Customer Benefits

Returns all plan benefits currently available to the active customer profile. Benefits are granted through active plan (tariff) subscriptions and include booking credits, extra services (such as printing), and time passes. The portal uses this to display the benefits panel on the My Plans page and to gate access to credit-based features.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

The response is split into `Personal` benefits (belonging to the individual profile) and `Team` benefits (shared across the customer's team).

<ResponseField name="Personal" type="object">
  Benefits belonging to the individual customer profile.
</ResponseField>

<ResponseField name="Personal.BookingCredits" type="array">
  Booking credit allowances granted by active plans.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].Id" type="number">
  Unique identifier for the booking credit record.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].Name" type="string">
  Display name of the booking credit allowance.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].TotalCredit" type="number">
  Total credit amount granted (in the location's currency).
</ResponseField>

<ResponseField name="Personal.BookingCredits[].RemainingCredit" type="number">
  Remaining credit balance available to spend.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].CaneBeUsedForBookings" type="boolean">
  `true` when this credit can be applied to room and desk bookings.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].CaneBeUsedForEvents" type="boolean">
  `true` when this credit can be applied to event ticket purchases.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].IsUniversalCredit" type="boolean">
  `true` when this credit applies to all resource types.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].IsFromTariff" type="boolean">
  `true` when this credit was granted by an active plan subscription rather than manually assigned.
</ResponseField>

<ResponseField name="Personal.BookingCredits[].ExpireDate" type="string | null">
  ISO 8601 datetime when this credit expires. `null` if it does not expire.
</ResponseField>

<ResponseField name="Personal.ExtraServices" type="array">
  Extra service allowances (e.g. printing credits) granted by active plans.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].Id" type="number">
  Unique identifier for the extra service record.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].ExtraService.Id" type="number">
  Identifier of the extra service type.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].ExtraService.Name" type="string">
  Display name of the extra service.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].ExtraService.IsPrintingCredit" type="boolean">
  `true` when this service is a printing credit (e.g. PaperCut integration).
</ResponseField>

<ResponseField name="Personal.ExtraServices[].TotalUses" type="number">
  Total number of uses granted.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].RemainingUses" type="number">
  Remaining uses available.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].ChargePeriod" type="string">
  How uses are measured: `"Minutes"`, `"Days"`, `"Weeks"`, `"Months"`, `"Uses"`, or `"FourWeekMonths"`.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].IsFromTariff" type="boolean">
  `true` when granted by an active plan subscription.
</ResponseField>

<ResponseField name="Personal.ExtraServices[].ExpireDate" type="string | null">
  ISO 8601 expiry datetime. `null` if it does not expire.
</ResponseField>

<ResponseField name="Personal.TimePasses" type="array">
  Time pass allowances granted by active plans.
</ResponseField>

<ResponseField name="Personal.TimePasses[].Id" type="number">
  Unique identifier for the time pass record.
</ResponseField>

<ResponseField name="Personal.TimePasses[].TimePass.Id" type="number">
  Identifier of the time pass type.
</ResponseField>

<ResponseField name="Personal.TimePasses[].TimePass.Name" type="string">
  Display name of the time pass.
</ResponseField>

<ResponseField name="Personal.TimePasses[].TotalUses" type="number | null">
  Total number of uses granted. `null` for unlimited passes.
</ResponseField>

<ResponseField name="Personal.TimePasses[].RemainingUses" type="number | null">
  Remaining uses. `null` for unlimited passes.
</ResponseField>

<ResponseField name="Personal.TimePasses[].Used" type="boolean">
  `true` when this specific time pass instance has been used.
</ResponseField>

<ResponseField name="Personal.TimePasses[].IsFromTariff" type="boolean">
  `true` when granted by an active plan subscription.
</ResponseField>

<ResponseField name="Personal.TimePasses[].ExpireDate" type="string | null">
  ISO 8601 expiry datetime. `null` if it does not expire.
</ResponseField>

<ResponseField name="Team" type="object">
  Benefits shared with the customer's team. Contains the same structure as `Personal` (`BookingCredits`, `ExtraServices`, `TimePasses`).
</ResponseField>

## Example Response

```json theme={null}
{
  "Personal": {
    "BookingCredits": [
      {
        "Id": 5,
        "Name": "Monthly Booking Allowance",
        "TotalCredit": 200.0,
        "RemainingCredit": 145.5,
        "CaneBeUsedForBookings": true,
        "CaneBeUsedForEvents": false,
        "IsUniversalCredit": false,
        "IsFromTariff": true,
        "ExpireDate": "2026-04-30T23:59:59Z"
      }
    ],
    "ExtraServices": [],
    "TimePasses": [
      {
        "Id": 12,
        "TimePass": { "Id": 3, "Name": "Day Pass" },
        "TotalUses": 5,
        "RemainingUses": 3,
        "Used": false,
        "IsFromTariff": true,
        "ExpireDate": null
      }
    ]
  },
  "Team": {
    "BookingCredits": [],
    "ExtraServices": [],
    "TimePasses": []
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { MyBenefits } from '@/types/public/billing/MyBenefits'
import { useData } from '@/api/fetchData'
import { createShape } from '@/helpers/shape-helper'

const shape = createShape<MyBenefits>()([
  'Personal.BookingCredits.Id',
  'Personal.BookingCredits.Name',
  'Personal.BookingCredits.RemainingCredit',
  'Personal.TimePasses.Id',
  'Personal.TimePasses.TimePass.Name',
  'Personal.TimePasses.RemainingUses',
])

const { resource: benefits } = useData<MyBenefits>(httpClient, endpoints.coworkers.benefits, {
  shape: shape.fields,
})
```

## Usage in Portal

| Context                        | Source file                                             |
| ------------------------------ | ------------------------------------------------------- |
| My Plans page — benefits panel | `src/views/user/plans/useMyBenefitsData.ts`             |
| Benefits display component     | `src/views/user/plans/components/MyBenefitsSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                 | Description                                |
| ------ | ---------------------------------------- | ------------------------------------------ |
| `GET`  | `/api/public/coworkers/profiles`         | List all profiles for the current session  |
| `GET`  | `/api/public/plans/my`                   | List active plans for the current customer |
| `PUT`  | `/api/public/coworkers/profiles/current` | Switch the active profile                  |


# List Published Customer Profiles
Source: https://learn.nexudus.com/api/endpoints/coworkers/directory-list

GET /api/public/coworkers/published
Retrieve a paginated, searchable list of published customer profiles shown in the member directory.

# List Published Customer Profiles

Returns customer profiles that have opted in to the member directory (`ProfileIsPublic: true`). Supports free-text search, tag filtering, and sort ordering. The portal uses this to render the member directory listing and to power the customer tag input autocomplete.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Free-text search string matched against the customer's name, company, position, bio, and tags. Pass an empty string to return all published
  profiles.
</ParamField>

<ParamField type="string">
  Filter results to customers whose `ProfileTagsList` contains this exact tag value. Pass an empty string to skip tag filtering.
</ParamField>

<ParamField type="number">
  Sort order for results. **Default**: `1` (alphabetical by name). Check the directory meta endpoint for available order options.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.FullName,Records.CompanyName,Records.AvatarUrl,TotalItems`.
</ParamField>

## Response

Returns an `ApiListResult<Coworker>` — a paginated wrapper containing an array of published customer profiles.

### Pagination

<ResponseField name="Records" type="Coworker[]">
  Array of published customer profiles for the current page.
</ResponseField>

<ResponseField name="CurrentPage" type="number">
  Current page number (1-based).
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of matching published profiles.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there are pages before the current one.
</ResponseField>

### Coworker Fields (within `Records[]`)

<ResponseField name="Records[].Id" type="number">
  Unique numeric identifier for the customer profile. Use as `coworkerId` in `GET /api/public/coworkers/published/{coworkerId}`.
</ResponseField>

<ResponseField name="Records[].UniqueId" type="string">
  Globally unique identifier for the profile.
</ResponseField>

<ResponseField name="Records[].FullName" type="string">
  Customer's display name.
</ResponseField>

<ResponseField name="Records[].GuessedFirstName" type="string">
  First name extracted from `FullName` for use in personalised UI text.
</ResponseField>

<ResponseField name="Records[].AvatarUrl" type="string">
  URL to the customer's avatar image.
</ResponseField>

<ResponseField name="Records[].Position" type="string | null">
  Job title.
</ResponseField>

<ResponseField name="Records[].CompanyName" type="string">
  Company name.
</ResponseField>

<ResponseField name="Records[].BusinessArea" type="string | null">
  Industry or area of work.
</ResponseField>

<ResponseField name="Records[].ProfileSummary" type="string | null">
  Professional bio. May contain Markdown.
</ResponseField>

<ResponseField name="Records[].ProfileWebsite" type="string | null">
  Personal or company website URL.
</ResponseField>

<ResponseField name="Records[].ProfileTagsList" type="array">
  Array of tag strings from the customer's profile.
</ResponseField>

<ResponseField name="Records[].InvoicingSpaceName" type="string">
  Display name of the location this customer is invoiced at.
</ResponseField>

### Social Media (within `Records[]`)

| Field       | Type             | Description                    |
| ----------- | ---------------- | ------------------------------ |
| `Twitter`   | `string \| null` | Twitter profile URL or handle  |
| `Linkedin`  | `string \| null` | LinkedIn profile URL           |
| `Github`    | `string \| null` | GitHub profile URL or username |
| `Instagram` | `string \| null` | Instagram handle or URL        |
| `Facebook`  | `string \| null` | Facebook profile URL           |
| `Skype`     | `string \| null` | Skype username                 |
| `Telegram`  | `string \| null` | Telegram username              |

## Example Response

```json theme={null}
{
  "Records": [
    {
      "Id": 101,
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "FullName": "Jane Doe",
      "GuessedFirstName": "Jane",
      "AvatarUrl": "https://nexudushq.spaces.nexudus.com/media/coworker/101/avatar",
      "Position": "Product Designer",
      "CompanyName": "Acme Design Co.",
      "BusinessArea": "Design",
      "ProfileSummary": "Jane specialises in design systems and user research.",
      "ProfileWebsite": "https://janedoe.design",
      "ProfileTagsList": ["UX", "Design Systems", "Research"],
      "InvoicingSpaceName": "Nexudus HQ",
      "Linkedin": "https://linkedin.com/in/janedoe",
      "Twitter": null
    }
  ],
  "CurrentPage": 1,
  "TotalItems": 42,
  "TotalPages": 5,
  "HasNextPage": true,
  "HasPreviousPage": false
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { Coworker } from '@/types/spaces/Coworker'
import { ApiListResult } from '@/types/ApiListResult'
import { useData } from '@/api/fetchData'

const url = endpoints.coworkers.directory.published_list(searchQuery, selectedTag, sortOrder)
// => '/api/public/coworkers/published?query=design&tag=UX&order=1'

const { resource: members } = useData<ApiListResult<Coworker>>(httpClient, url)
```

## Usage in Portal

| Context                         | Source file                                                    |
| ------------------------------- | -------------------------------------------------------------- |
| Member directory listing page   | `src/views/community/directory/components/useDirectoryData.ts` |
| Customer tag autocomplete input | `src/components/CoworkerTagInput.tsx`                          |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                               | Description                               |
| ------ | ------------------------------------------------------ | ----------------------------------------- |
| `GET`  | `/api/public/coworkers/published/{coworkerId}`         | Get a single published customer profile   |
| `GET`  | `/api/public/coworkers/published/{coworkerId}/related` | Get related profiles for a customer       |
| `GET`  | `/api/public/coworkers/directory/meta`                 | Get directory configuration and tag cloud |


# Get Directory Meta
Source: https://learn.nexudus.com/api/endpoints/coworkers/directory-meta

GET /api/public/coworkers/directory/meta
Retrieve directory configuration and the tag cloud for the customer member directory.

# Get Directory Meta

Returns configuration settings and tag cloud data for the customer member directory. The portal uses this to determine whether the directory is enabled, what content it shows, and which filter tags to display in the directory sidebar.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

<ResponseField name="Meta.DirectoryEnabled" type="boolean">
  `true` when the member directory feature is active for this location. When `false`, the directory page should not be rendered.
</ResponseField>

<ResponseField name="Meta.DirectoryContents" type="number">
  Controls whose profiles appear in the directory: - `1` — Published profiles only - `2` — Published profiles with an active plan - `3` — Everyone
  (all customers) - `4` — Everyone with an active plan
</ResponseField>

<ResponseField name="Meta.DirectoryRecords" type="number">
  Controls what record types appear: - `1` — Teams and individual members - `2` — Teams only - `3` — Individual members only
</ResponseField>

<ResponseField name="Meta.OnlyInvoicingSpace" type="boolean">
  When `true`, only customers invoiced at the current location are shown in the directory.
</ResponseField>

<ResponseField name="Meta.ShowCheckInMembers" type="boolean">
  When `true`, customers who are currently checked in are highlighted in the directory.
</ResponseField>

<ResponseField name="Meta.Tags" type="array">
  Tag cloud used to populate the directory filter sidebar. Each entry represents a tag and its relative frequency.
</ResponseField>

<ResponseField name="Meta.Tags[].Tag" type="string">
  The tag string value (matches entries in `Coworker.ProfileTagsList`).
</ResponseField>

<ResponseField name="Meta.Tags[].Count" type="number">
  Number of published profiles that have this tag.
</ResponseField>

<ResponseField name="Meta.Tags[].Percentage" type="number">
  This tag's share of total tagged profiles, as a percentage (0–100).
</ResponseField>

## Example Response

```json theme={null}
{
  "Meta": {
    "DirectoryEnabled": true,
    "DirectoryContents": 1,
    "DirectoryRecords": 1,
    "OnlyInvoicingSpace": false,
    "ShowCheckInMembers": true,
    "Tags": [
      { "Tag": "UX", "Count": 12, "Percentage": 24.0 },
      { "Tag": "Design Systems", "Count": 8, "Percentage": 16.0 },
      { "Tag": "Research", "Count": 6, "Percentage": 12.0 }
    ]
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { DirectoryMetaData } from '@/types/endpoints/DirectoryMeta'
import { useData } from '@/api/fetchData'

const { resource: meta } = useData<DirectoryMetaData>(httpClient, endpoints.coworkers.directory.meta)

if (!meta?.Meta.DirectoryEnabled) {
  // Hide the directory navigation item
}
```

## Usage in Portal

| Context                                               | Source file                                                    |
| ----------------------------------------------------- | -------------------------------------------------------------- |
| Member directory page — tag cloud filter and settings | `src/views/community/directory/components/useDirectoryData.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                           | Description                                    |
| ------ | ---------------------------------- | ---------------------------------------------- |
| `GET`  | `/api/public/coworkers/published`  | List published profiles in the directory       |
| `GET`  | `/api/public/teams/directory/meta` | Get the equivalent meta for the team directory |


# Get Published Customer Profile
Source: https://learn.nexudus.com/api/endpoints/coworkers/directory-profile

GET /api/public/coworkers/published/{coworkerId}
Retrieve the full published directory profile for a single customer by their ID.

# Get Published Customer Profile

Returns the full directory profile for a single customer who has opted in to the member directory. The portal loads this when a customer opens a profile card in the member directory, displaying their professional bio, social links, location, and related profiles.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  The numeric identifier of the customer profile to retrieve. Obtain this from `GET /api/public/coworkers/published` (`[].Id`).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Coworker.FullName,Coworker.CompanyName,Coworker.AvatarUrl`.
</ParamField>

## Response

Returns a wrapper object containing a single `Coworker` property. See [List Published Customer Profiles](/api/endpoints/coworkers/directory-list) for the full set of coworker fields.

<ResponseField name="Coworker" type="Coworker">
  The published customer profile object.
</ResponseField>

### Core Identity (within `Coworker`)

<ResponseField name="Coworker.Id" type="number">
  Unique numeric identifier for the customer profile.
</ResponseField>

<ResponseField name="Coworker.FullName" type="string">
  Customer's display name.
</ResponseField>

<ResponseField name="Coworker.GuessedFirstName" type="string">
  First name inferred from `FullName`. Used in personalised UI messages.
</ResponseField>

<ResponseField name="Coworker.AvatarUrl" type="string">
  URL to the customer's avatar image.
</ResponseField>

### Professional Profile (within `Coworker`)

<ResponseField name="Coworker.Position" type="string | null">
  Job title.
</ResponseField>

<ResponseField name="Coworker.CompanyName" type="string">
  Company name.
</ResponseField>

<ResponseField name="Coworker.ProfileSummary" type="string | null">
  Full professional bio. May contain Markdown.
</ResponseField>

<ResponseField name="Coworker.ProfileWebsite" type="string | null">
  Personal or company website URL.
</ResponseField>

<ResponseField name="Coworker.ProfileTagsList" type="array">
  Array of tag strings from the customer's profile.
</ResponseField>

### Social Media (within `Coworker`)

| Field       | Type             | Description                    |
| ----------- | ---------------- | ------------------------------ |
| `Twitter`   | `string \| null` | Twitter profile URL or handle  |
| `Linkedin`  | `string \| null` | LinkedIn profile URL           |
| `Github`    | `string \| null` | GitHub profile URL or username |
| `Instagram` | `string \| null` | Instagram handle or URL        |
| `Facebook`  | `string \| null` | Facebook profile URL           |
| `Skype`     | `string \| null` | Skype username                 |
| `Telegram`  | `string \| null` | Telegram username              |

## Example Response

```json theme={null}
{
  "Coworker": {
    "Id": 101,
    "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "FullName": "Jane Doe",
    "GuessedFirstName": "Jane",
    "AvatarUrl": "https://nexudushq.spaces.nexudus.com/media/coworker/101/avatar",
    "Position": "Product Designer",
    "CompanyName": "Acme Design Co.",
    "ProfileSummary": "Jane is a product designer with over 8 years of experience building intuitive digital products. She specialises in design systems and user research.",
    "ProfileWebsite": "https://janedoe.design",
    "ProfileTagsList": ["UX", "Design Systems", "Research"],
    "InvoicingSpaceName": "Nexudus HQ",
    "Linkedin": "https://linkedin.com/in/janedoe",
    "Twitter": null,
    "Github": "https://github.com/janedoe"
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { Coworker } from '@/types/spaces/Coworker'
import { useData } from '@/api/fetchData'

const url = endpoints.coworkers.directory.published_one(coworkerId)
// => '/api/public/coworkers/published/101'

const { resource: coworkerData } = useData<{ Coworker: Coworker }>(httpClient, url)
```

## Usage in Portal

| Context                        | Source file                                                                   |
| ------------------------------ | ----------------------------------------------------------------------------- |
| Member directory profile modal | `src/views/community/directory/components/CoworkersDirectoryProfileModal.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No published profile with the given `coworkerId` was found, or the customer has set `ProfileIsPublic` to `false`.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                               | Description                                  |
| ------ | ------------------------------------------------------ | -------------------------------------------- |
| `GET`  | `/api/public/coworkers/published`                      | List all published profiles in the directory |
| `GET`  | `/api/public/coworkers/published/{coworkerId}/related` | Get profiles related to this customer        |
| `GET`  | `/api/public/coworkers/directory/meta`                 | Get directory settings and tag cloud         |


# Get Related Customer Profiles
Source: https://learn.nexudus.com/api/endpoints/coworkers/directory-related

GET /api/public/coworkers/published/{coworkerId}/related
Retrieve customer profiles related to a given customer, based on shared tags, location, or other affinity signals.

# Get Related Customer Profiles

Returns a list of customer profiles that are related to the specified customer. Related profiles are surfaced at the bottom of a customer's directory profile card to encourage discovery and connections within the community.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  The numeric identifier of the customer whose related profiles you want to retrieve. Obtain this from `GET /api/public/coworkers/published`
  (`[].Id`).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns an object containing related customer profiles and community threads for the specified customer.

<ResponseField name="RelatedProfiles" type="Coworker[]">
  Array of customer profiles related to the specified customer. May be empty if no related profiles are found.
</ResponseField>

<ResponseField name="Threads" type="CommunityThread[]">
  Array of community threads associated with the specified customer.
</ResponseField>

### Coworker Fields (within `RelatedProfiles[]`)

<ResponseField name="RelatedProfiles[].Id" type="number">
  Unique identifier for the related customer profile.
</ResponseField>

<ResponseField name="RelatedProfiles[].FullName" type="string">
  Display name of the related customer.
</ResponseField>

<ResponseField name="RelatedProfiles[].AvatarUrl" type="string">
  URL to the related customer's avatar image.
</ResponseField>

<ResponseField name="RelatedProfiles[].Position" type="string | null">
  Job title of the related customer.
</ResponseField>

<ResponseField name="RelatedProfiles[].CompanyName" type="string">
  Company name of the related customer.
</ResponseField>

<ResponseField name="RelatedProfiles[].ProfileTagsList" type="array">
  Tags shared between the source customer and the related customer.
</ResponseField>

## Example Response

```json theme={null}
{
  "RelatedProfiles": [
    {
      "Id": 202,
      "FullName": "Carlos Ruiz",
      "AvatarUrl": "https://nexudushq.spaces.nexudus.com/media/coworker/202/avatar",
      "GuessedFirstName": "Carlos",
      "Position": "UX Researcher",
      "CompanyName": "Ruiz UX Studio",
      "ProfileTagsList": ["UX", "Research"]
    }
  ],
  "Threads": []
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { Coworker } from '@/types/spaces/Coworker'
import { CommunityThread } from '@/types/spaces/CommunityThread'
import { useData } from '@/api/fetchData'

const url = endpoints.coworkers.directory.related(coworkerId)
// => '/api/public/coworkers/published/101/related'

const { resource: related } = useData<{ RelatedProfiles: Coworker[]; Threads: CommunityThread[] }>(httpClient, url)
```

## Usage in Portal

| Context                                             | Source file                                                                   |
| --------------------------------------------------- | ----------------------------------------------------------------------------- |
| Related profiles section in directory profile modal | `src/views/community/directory/components/CoworkersDirectoryProfileModal.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No published profile with the given `coworkerId` was found.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                       | Description                                  |
| ------ | ---------------------------------------------- | -------------------------------------------- |
| `GET`  | `/api/public/coworkers/published/{coworkerId}` | Get the full profile for this customer       |
| `GET`  | `/api/public/coworkers/published`              | List all published profiles in the directory |


# Impersonate Customer
Source: https://learn.nexudus.com/api/endpoints/coworkers/impersonate

GET /api/public/coworkers/{coworkerId}/impersonate
Generate an impersonation token so a team administrator can sign in as another team member.

# Impersonate Customer

Returns a short-lived token that can be exchanged for a full auth session as the target customer. Used in the portal when a team administrator chooses to sign in on behalf of a team member — both from the sign-in profile selection flow and from the team permissions page.

## Authentication

Requires a valid customer bearer token. The authenticated customer must have the necessary permission (e.g. team admin rights) to impersonate the target customer.

## Path Parameters

<ParamField type="number">
  The numeric identifier of the customer profile to impersonate. Obtain this from `GET /api/public/coworkers/profiles` (`Profiles[].Id`).
</ParamField>

## Response

Returns a JSON object containing a single `token` field. Pass this token to the token-exchange endpoint (`POST /api/public/auth/login/{token}`) to obtain a full auth session as the target customer.

<ResponseField name="token" type="string">
  A short-lived token string. Exchange it via `exchangeToken()` (which calls the login endpoint) to start an impersonated session.
</ResponseField>

## Examples

### Impersonate a team member

```http theme={null}
GET /api/public/coworkers/42/impersonate
Authorization: Bearer {token}
```

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useSignIn } from '@/views/auth/SignIn/useSignIn'

// useSignIn exposes the impersonate helper
const { impersonate } = useSignIn()

// Internally this does:
// 1. GET /api/public/coworkers/{id}/impersonate  → { token }
// 2. POST /api/public/auth/login/{token}         → full session
const response = await httpClient.get<{ token: string }>(endpoints.coworkers.impersonate(coworkerId))
await exchangeToken(response.data.token, true)
await queryContext.invalidateQueries()
```

## Usage in Portal

| Context                                  | Source file                                                          |
| ---------------------------------------- | -------------------------------------------------------------------- |
| Sign-in profile selection flow           | `src/views/auth/SignIn/useSignIn.ts`                                 |
| Team permissions — "Impersonate account" | `src/views/user/team/permissions/components/TeamPermissionTable.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The authenticated customer does not have permission to impersonate the specified profile.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No customer with the given `coworkerId` was found.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                 | Description                                          |
| ------ | ---------------------------------------- | ---------------------------------------------------- |
| `GET`  | `/api/public/coworkers/profiles`         | List all profiles for the current session            |
| `PUT`  | `/api/public/coworkers/profiles/current` | Switch the active profile without impersonation      |
| `GET`  | `/api/sys/users/impersonate`             | Admin-level impersonation (requires operator access) |


# List Customer Profiles
Source: https://learn.nexudus.com/api/endpoints/coworkers/list-profiles

GET /api/public/coworkers/profiles
Retrieve all customer profiles accessible to the current session, including the active user account and all associated customer profiles.

# List Customer Profiles

Returns all customer profiles linked to the authenticated user account, together with the user record and default business. A single user account can have multiple profiles — for example, an individual member profile and a company profile — and can switch between them. The portal fetches this on every authenticated session bootstrap to populate the account switcher.

<Note>
  A **profile** in Nexudus represents a customer record tied to a specific location. One user can have profiles across multiple locations or multiple
  profile types (individual, company) within the same location.
</Note>

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.FullName,Records.CompanyName,Records.Avatar`.
</ParamField>

## Response

<ResponseField name="User" type="object">
  The authenticated user account record.
</ResponseField>

<ResponseField name="User.Id" type="number">
  Unique numeric identifier for the user account.
</ResponseField>

<ResponseField name="User.FullName" type="string">
  Display name for the user account.
</ResponseField>

<ResponseField name="User.Email" type="string">
  Email address used to sign in.
</ResponseField>

<ResponseField name="User.Active" type="boolean">
  `true` when the account is active and not suspended.
</ResponseField>

<ResponseField name="User.IsAdmin" type="boolean">
  `true` when the user has operator-level admin access.
</ResponseField>

<ResponseField name="User.AccessToken" type="string">
  Current bearer token for the session (mirrors the `Authorization` header value).
</ResponseField>

<ResponseField name="DefaultBusiness" type="object">
  The default location associated with this user.
</ResponseField>

<ResponseField name="DefaultBusiness.Id" type="number">
  Numeric identifier of the default location.
</ResponseField>

<ResponseField name="DefaultBusiness.Name" type="string">
  Display name of the default location.
</ResponseField>

<ResponseField name="DefaultBusiness.WebAddress" type="string">
  Subdomain identifier for the default location.
</ResponseField>

<ResponseField name="Profiles" type="array">
  All customer profiles accessible to this user.
</ResponseField>

<ResponseField name="Profiles[].Id" type="number">
  Numeric identifier of the customer profile. Use this as `coworkerId` in profile-scoped endpoints.
</ResponseField>

<ResponseField name="Profiles[].FullName" type="string">
  Display name for this profile.
</ResponseField>

<ResponseField name="Profiles[].CompanyName" type="string">
  Company name for this profile.
</ResponseField>

<ResponseField name="Profiles[].Active" type="boolean">
  `true` when this profile is active.
</ResponseField>

<ResponseField name="Profiles[].IsDefaultProfile" type="boolean">
  `true` when this is the currently active profile for the session.
</ResponseField>

<ResponseField name="Profiles[].CoworkerType" type="number">
  Profile type: `1` = Individual, `2` = Company.
</ResponseField>

<ResponseField name="Profiles[].HasVirtualOffice" type="boolean">
  `true` when a Virtual Office contract is active for this profile.
</ResponseField>

<ResponseField name="Profiles[].VirtualOfficePaused" type="boolean | null">
  `true` when the Virtual Office contract is currently paused.
</ResponseField>

<ResponseField name="Profiles[].VirtualOfficeContractId" type="number | null">
  ID of the Virtual Office contract, if one exists. Use with `GET /api/public/billing/coworkerContracts/{contractId}`.
</ResponseField>

## Example Response

```json theme={null}
{
  "User": {
    "Id": 42,
    "FullName": "Jane Doe",
    "Email": "jane.doe@example.com",
    "Active": true,
    "IsAdmin": false,
    "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
  },
  "DefaultBusiness": {
    "Id": 7,
    "Name": "Nexudus HQ",
    "WebAddress": "nexudushq"
  },
  "Profiles": [
    {
      "Id": 101,
      "FullName": "Jane Doe",
      "CompanyName": "",
      "Active": true,
      "IsDefaultProfile": true,
      "CoworkerType": 1,
      "HasVirtualOffice": false,
      "VirtualOfficePaused": null,
      "VirtualOfficeContractId": null
    },
    {
      "Id": 102,
      "FullName": "Acme Design Co.",
      "CompanyName": "Acme Design Co.",
      "Active": true,
      "IsDefaultProfile": false,
      "CoworkerType": 2,
      "HasVirtualOffice": true,
      "VirtualOfficePaused": false,
      "VirtualOfficeContractId": 55
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { CoworkerProfiles } from '@/types/sys/CoworkerProfiles'
import { useData } from '@/api/fetchData'

const { resource: profiles } = useData<CoworkerProfiles>(httpClient, endpoints.coworkers.profiles)

const activeProfile = profiles?.Profiles.find((p) => p.IsDefaultProfile)
```

## Usage in Portal

| Context                                           | Source file                                 |
| ------------------------------------------------- | ------------------------------------------- |
| Session bootstrap — loads all profiles on sign-in | `src/states/useAuthContext.tsx`             |
| Account switcher dropdown in navigation           | `src/components/NavBar/AccountDropdown.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                          | Description                               |
| ------ | ------------------------------------------------- | ----------------------------------------- |
| `PUT`  | `/api/public/coworkers/profiles/current`          | Switch the active profile for the session |
| `GET`  | `/api/public/coworkers/profiles/current/benefits` | Get plan benefits for the active profile  |
| `GET`  | `/en/profile?_resource=Coworker`                  | Retrieve full editable customer profile   |


# Switch Active Profile
Source: https://learn.nexudus.com/api/endpoints/coworkers/switch-profile

PUT /api/public/coworkers/profiles/current
Switch the active customer profile for the current session to a different profile owned by the same user account.

# Switch Active Profile

Changes the active customer profile for the current session. A single user account can have multiple customer profiles (individual, company, or profiles at different locations). This endpoint sets the specified profile as the default, so subsequent authenticated requests operate in that profile's context.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number">
  The numeric identifier of the profile to switch to. Obtain valid profile IDs from `GET /api/public/coworkers/profiles` — use a `Profiles[].Id` value
  where `Profiles[].Active` is `true`.
</ParamField>

## Response

The portal typically discards the response body and re-fetches `GET /api/public/coworkers/profiles` after a successful switch to update the session state.

Returns an `ActionConfirmation` envelope.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the profile was switched successfully.
</ResponseField>

<ResponseField name="Value" type="string | null">
  Usually `null` on success.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `null` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation errors. `null` on success.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.coworkers.setCurrentProfile(coworkerId))

// Re-fetch profiles to update UI
await refetchProfiles()
```

## Usage in Portal

| Context                                     | Source file                                                                  |
| ------------------------------------------- | ---------------------------------------------------------------------------- |
| Account switcher in the navigation dropdown | `src/components/NavBar/AccountDropdown.tsx`                                  |
| Virtual Office profile mismatch alert       | `src/views/virtual-offices/components/VirtualOfficeProfileMismatchAlert.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No profile with the given `coworkerId` exists or it does not belong to this user account.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                          | Description                                        |
| ------ | ------------------------------------------------- | -------------------------------------------------- |
| `GET`  | `/api/public/coworkers/profiles`                  | List all profiles available to the current session |
| `GET`  | `/api/public/coworkers/profiles/current/benefits` | Get benefits for the currently active profile      |


# Get Delivery Details
Source: https://learn.nexudus.com/api/endpoints/deliveries/delivery-details

GET /api/public/deliveries/{id}
Returns the full details of a specific delivery.

# Get Delivery Details

Returns the complete details for a specific delivery, including sender, tracking info, and collection status.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the delivery.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Delivery.Name,Delivery.Collected`.
</ParamField>

## Response

Returns an object containing a `Delivery` property with all delivery fields.

### Delivery Fields

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the delivery |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Core

| Field               | Type             | Description                                              |
| ------------------- | ---------------- | -------------------------------------------------------- |
| `Name`              | `string`         | Delivery reference number / name                         |
| `Notes`             | `string \| null` | Notes added to the delivery                              |
| `Location`          | `string`         | Physical location where the delivery is stored           |
| `DeliveryType`      | `string`         | Type of delivery (`Parcel`, `Letter`, etc.)              |
| `CoworkerFullName`  | `string`         | Full name of the customer the delivery is addressed to   |
| `RecipientId`       | `number \| null` | Id of the specific recipient contact, if applicable      |
| `RecipientFullName` | `string`         | Full name of the recipient (falls back to customer name) |
| `RequiresSignature` | `boolean`        | Whether collection requires a signature                  |

#### Media

| Field              | Type      | Description                                 |
| ------------------ | --------- | ------------------------------------------- |
| `HasImage`         | `boolean` | Whether the delivery has a label image      |
| `ImageUrl`         | `string`  | URL to the delivery label image             |
| `HasSignature`     | `boolean` | Whether a collection signature was captured |
| `HasScan`          | `boolean` | Whether a scanned copy exists               |
| `HasForwardedFile` | `boolean` | Whether a forwarding receipt file exists    |

#### Status

| Field                 | Type      | Description                             |
| --------------------- | --------- | --------------------------------------- |
| `Collected`           | `boolean` | Whether the delivery has been collected |
| `StoredForCollection` | `boolean` | Whether stored at the location          |
| `ReturnedToSender`    | `boolean` | Whether returned to sender              |
| `CheckDeposited`      | `boolean` | Whether a check was deposited           |
| `Forwarded`           | `boolean` | Whether forwarded to another address    |
| `Scanned`             | `boolean` | Whether scanned and sent digitally      |
| `Recycled`            | `boolean` | Whether recycled                        |
| `Shredded`            | `boolean` | Whether shredded                        |

#### Status Dates

| Field                   | Type             | Description                         |
| ----------------------- | ---------------- | ----------------------------------- |
| `CollectedOn`           | `string \| null` | ISO date when collected             |
| `StoredForCollectionOn` | `string \| null` | ISO date when stored for collection |
| `ReturnedToSenderOn`    | `string \| null` | ISO date when returned to sender    |
| `CheckDepositedOn`      | `string \| null` | ISO date when check was deposited   |
| `ForwardedOn`           | `string \| null` | ISO date when forwarded             |
| `ScannedOn`             | `string \| null` | ISO date when scanned               |
| `RecycledOn`            | `string \| null` | ISO date when recycled              |
| `ShreddedOn`            | `string \| null` | ISO date when shredded              |

#### Handling

| Field                         | Type             | Description                                      |
| ----------------------------- | ---------------- | ------------------------------------------------ |
| `HandlingPreference`          | `string \| null` | Current handling preference set by the customer  |
| `HandlingPreferenceCanChange` | `boolean`        | Whether the handling preference can still change |
| `ForwardingAddressUniqueId`   | `string \| null` | UniqueId of the forwarding address               |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch delivery details

```http theme={null}
GET /api/public/deliveries/77
Authorization: Bearer {token}
```

### Fetch with response shaping

```http theme={null}
GET /api/public/deliveries/77?_shape=Delivery.Name,Delivery.DeliveryType,Delivery.Collected
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.deliveries.details(77))
```

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No delivery exists with the given id.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                      | Description                |
| ------ | --------------------------------------------- | -------------------------- |
| `GET`  | `/api/public/deliveries/my`                   | List all deliveries        |
| `PUT`  | `/api/public/deliveries/{id}/markAsCollected` | Mark delivery as collected |


# List Deliveries
Source: https://learn.nexudus.com/api/endpoints/deliveries/list-deliveries

GET /api/public/deliveries/my
Returns the authenticated customer's deliveries.

# List Deliveries

Returns deliveries addressed to the authenticated customer. Filter by pending status to show only uncollected parcels.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="number">
  Page number for pagination. **Default**: `1`.
</ParamField>

<ParamField type="number">
  Number of results per page. **Default**: `15`.
</ParamField>

<ParamField type="boolean">
  `true` — return only uncollected deliveries. `false` — return collected/handled deliveries.
</ParamField>

<ParamField type="string">
  Free-text search string matched against the delivery name.
</ParamField>

<ParamField type="string">
  Filter by delivery type enum value (e.g. `Parcel`, `Letter`, `LargeParcel`).
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Name,Records.Collected,TotalItems`.
</ParamField>

## Response

Returns a `DeliveryList` object — a paginated wrapper containing an array of delivery records.

### Pagination

<ResponseField name="Records" type="Delivery[]">
  Array of delivery objects for the current page.
</ResponseField>

<ResponseField name="CurrentPage" type="number">
  Current page number (1-based).
</ResponseField>

<ResponseField name="TotalItems" type="number">
  Total number of matching deliveries.
</ResponseField>

<ResponseField name="TotalPages" type="number">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there are more pages after the current one.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there are pages before the current one.
</ResponseField>

### Delivery Fields (within `Records[]`)

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the delivery |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Core

| Field               | Type             | Description                                              |
| ------------------- | ---------------- | -------------------------------------------------------- |
| `Name`              | `string`         | Delivery reference number / name                         |
| `Notes`             | `string \| null` | Notes added to the delivery                              |
| `Location`          | `string`         | Physical location where the delivery is stored           |
| `DeliveryType`      | `string`         | Type of delivery (`Parcel`, `Letter`, etc.)              |
| `CoworkerFullName`  | `string`         | Full name of the customer the delivery is addressed to   |
| `RecipientId`       | `number \| null` | Id of the specific recipient contact, if applicable      |
| `RecipientFullName` | `string`         | Full name of the recipient (falls back to customer name) |
| `RequiresSignature` | `boolean`        | Whether collection requires a signature                  |

#### Media

| Field              | Type      | Description                                 |
| ------------------ | --------- | ------------------------------------------- |
| `HasImage`         | `boolean` | Whether the delivery has a label image      |
| `ImageUrl`         | `string`  | URL to the delivery label image             |
| `HasSignature`     | `boolean` | Whether a collection signature was captured |
| `HasScan`          | `boolean` | Whether a scanned copy exists               |
| `HasForwardedFile` | `boolean` | Whether a forwarding receipt file exists    |

#### Status

| Field                 | Type      | Description                             |
| --------------------- | --------- | --------------------------------------- |
| `Collected`           | `boolean` | Whether the delivery has been collected |
| `StoredForCollection` | `boolean` | Whether stored at the location          |
| `ReturnedToSender`    | `boolean` | Whether returned to sender              |
| `CheckDeposited`      | `boolean` | Whether a check was deposited           |
| `Forwarded`           | `boolean` | Whether forwarded to another address    |
| `Scanned`             | `boolean` | Whether scanned and sent digitally      |
| `Recycled`            | `boolean` | Whether recycled                        |
| `Shredded`            | `boolean` | Whether shredded                        |

#### Status Dates

| Field                   | Type             | Description                         |
| ----------------------- | ---------------- | ----------------------------------- |
| `CollectedOn`           | `string \| null` | ISO date when collected             |
| `StoredForCollectionOn` | `string \| null` | ISO date when stored for collection |
| `ReturnedToSenderOn`    | `string \| null` | ISO date when returned to sender    |
| `CheckDepositedOn`      | `string \| null` | ISO date when check was deposited   |
| `ForwardedOn`           | `string \| null` | ISO date when forwarded             |
| `ScannedOn`             | `string \| null` | ISO date when scanned               |
| `RecycledOn`            | `string \| null` | ISO date when recycled              |
| `ShreddedOn`            | `string \| null` | ISO date when shredded              |

#### Handling

| Field                         | Type             | Description                                      |
| ----------------------------- | ---------------- | ------------------------------------------------ |
| `HandlingPreference`          | `string \| null` | Current handling preference set by the customer  |
| `HandlingPreferenceCanChange` | `boolean`        | Whether the handling preference can still change |
| `ForwardingAddressUniqueId`   | `string \| null` | UniqueId of the forwarding address               |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch pending deliveries

```http theme={null}
GET /api/public/deliveries/my?showPending=true
Authorization: Bearer {token}
```

### Fetch with response shaping

```http theme={null}
GET /api/public/deliveries/my?showPending=true&_shape=Records.Name,Records.DeliveryType,Records.Collected,Records.CollectedOn,TotalItems
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: deliveries } = useTypedData(httpClient, endpoints.deliveries.list(true))
```

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                      | Description                          |
| ------ | --------------------------------------------- | ------------------------------------ |
| `GET`  | `/api/public/deliveries/{id}`                 | Get a single delivery's full details |
| `PUT`  | `/api/public/deliveries/{id}/markAsCollected` | Mark a delivery as collected         |


# Mark Delivery as Collected
Source: https://learn.nexudus.com/api/endpoints/deliveries/mark-collected

PUT /api/public/deliveries/{id}/markAsCollected
Marks a delivery as collected by the customer.

# Mark Delivery as Collected

Records that the customer has collected a specific delivery. Removes it from the pending deliveries list.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the delivery.
</ParamField>

## Request Body

No request body required.

## Response

Returns a `200 OK` on success.

## Examples

### Mark as collected

```http theme={null}
PUT /api/public/deliveries/77/markAsCollected
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.deliveries.markAsCollected(77))
```


# Save Delivery
Source: https://learn.nexudus.com/api/endpoints/deliveries/save-delivery

PUT /api/public/deliveries
Creates or updates a delivery record.

# Save Delivery

Creates a new delivery record or updates an existing one. Used when the space operator logs incoming parcels.

## Authentication

Requires a valid customer bearer token.

## Request Body

Delivery details including sender and tracking information.

## Response

Returns a `200 OK` on success.

## Examples

### Save a delivery

```http theme={null}
PUT /api/public/deliveries
Authorization: Bearer {token}
Content-Type: application/json

{
  "SenderName": "Amazon",
  "TrackingNumber": "TRK123456"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.deliveries.save, deliveryData)
```


# Cancel Event Ticket
Source: https://learn.nexudus.com/api/endpoints/events/cancel-ticket

DELETE /api/public/events/my/{id}
Cancels (deletes) an event ticket belonging to the authenticated customer.

# Cancel Event Ticket

Cancels and removes the specified ticket from the authenticated customer's event attendances. Used on the My Events page to allow customers to cancel their registration before an event.

## Authentication

Requires a valid customer bearer token. The attendance record must belong to the authenticated customer.

## Path Parameters

<ParamField type="number">
  The integer ID of the attendance record to cancel. Obtained as `Records[].Id` from `GET /api/public/events/my`.
</ParamField>

## Response

Returns an empty `200 OK` on success.

## Examples

### Cancel a ticket

```http theme={null}
DELETE /api/public/events/my/9021
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.events.cancelTicket(9021))
```

## Usage in Portal

| Context                             | Source file                                          |
| ----------------------------------- | ---------------------------------------------------- |
| My Events page (`/activity/events`) | `src/views/user/activity/events/MyEventsSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No attendance record with the specified ID exists for the authenticated customer.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description                                     |
| ------ | --------------------------------------- | ----------------------------------------------- |
| `GET`  | `/api/public/events/my`                 | List all tickets for the authenticated customer |
| `POST` | `/api/public/events/my/{id}/sendTicket` | Re-send a ticket confirmation email             |
| `GET`  | `/api/public/events/{id}`               | Full detail for a specific event                |


# Delete Event Comment
Source: https://learn.nexudus.com/api/endpoints/events/delete-comment

POST /en/events/deleteComment
Deletes a comment previously posted by the authenticated customer on an event.

# Delete Event Comment

Removes a comment that the authenticated customer posted on an event. After a successful deletion the event detail data should be refetched to update the `Event.Comments` array.

<Note>This endpoint uses the `/en/` legacy route prefix and the `POST` method rather than `DELETE`, despite being a deletion operation.</Note>

## Authentication

Requires a valid customer bearer token. Customers can only delete their own comments.

## Request Body

<ParamField type="number">
  The integer ID of the comment to delete. Obtained as `Event.Comments[].Id` from `GET /api/public/events/{id}`.
</ParamField>

## Response

Returns an empty `200 OK` on success.

## Examples

### Delete a comment

```http theme={null}
POST /en/events/deleteComment
Authorization: Bearer {token}
Content-Type: application/json

{ "id": 77 }
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.events.deleteComment, { id: 77 })
```

## Usage in Portal

| Context                                         | Source file                        |
| ----------------------------------------------- | ---------------------------------- |
| Event detail page comment list (`/events/{id}`) | `src/views/events/details/data.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No comment with the specified `id` exists or it does not belong to the authenticated customer.
</ResponseField>

## Related Endpoints

| Method | Endpoint                  | Description                                    |
| ------ | ------------------------- | ---------------------------------------------- |
| `GET`  | `/api/public/events/{id}` | Event detail — includes `Event.Comments` array |
| `POST` | `/en/events/newComment`   | Post a new comment on an event                 |


# Get Event Details
Source: https://learn.nexudus.com/api/endpoints/events/event-details

GET /api/public/events/{id}
Returns full detail for a single published event, including ticket products, attendees, related events, and comments.

# Get Event Details

Returns complete information for a single published event, including all ticket products, a list of recent attendees, related events, and customer comments. Used on the event detail page and in the basket preview.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="number">
  The integer ID of the event. Obtained as `Id` from `GET /api/public/events` or `GET /api/public/events/my`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Event.Name,Event.StartDateUtc,Event.EventProducts,RelatedEvents`.
</ParamField>

## Response

Returns an `EventDetails` object.

### Core Fields

<ResponseField name="Event" type="CalendarEvent">
  Full event object. See the field descriptions in [List Events](/api/endpoints/events/list-events) for the complete `CalendarEvent` schema.
</ResponseField>

<ResponseField name="AttendeeCount" type="number">
  Total number of tickets sold across all ticket products.
</ResponseField>

<ResponseField name="Attendees" type="Coworker[]">
  Full `Coworker` objects for event attendees — used for social proof displays ("X people are going").
</ResponseField>

<ResponseField name="Categories" type="EventCategory[]">
  All event categories available at this location — useful for populating a "Browse by category" navigation without an additional request.
</ResponseField>

<ResponseField name="RelatedEvents" type="CalendarEvent[]">
  A list of other events from the same location or category, used for the "You might also like" section.
</ResponseField>

<ResponseField name="Comment" type="EventComment | null">
  Template object for a new comment submission. Use the `newComment` endpoint to post a comment.
</ResponseField>

### EventComment Fields

<ResponseField name="Event.Comments[].Id" type="number">
  Unique identifier for the comment.
</ResponseField>

<ResponseField name="Event.Comments[].Text" type="string | null">
  Comment body text.
</ResponseField>

<ResponseField name="Event.Comments[].Rating" type="number | null">
  Optional numeric rating (e.g. 1–5) submitted alongside the comment.
</ResponseField>

<ResponseField name="Event.Comments[].Published" type="boolean">
  When `true`, the comment is visible to all customers.
</ResponseField>

<ResponseField name="Event.Comments[].PostedBy" type="User">
  The customer who posted the comment, including `Id` and `FullName`.
</ResponseField>

<ResponseField name="Event.Comments[].CreatedOn" type="string">
  Local datetime the comment was posted (ISO 8601).
</ResponseField>

<ResponseField name="Event.Comments[].CreatedOnUtc" type="string">
  UTC datetime the comment was posted (ISO 8601).
</ResponseField>

## Examples

### Fetch event details (full payload)

```http theme={null}
GET /api/public/events/412
```

```json theme={null}
{
  "AttendeeCount": 7,
  "Attendees": [{ "Id": 201, "FullName": "Maria Garcia", "Email": "maria@example.com" }],
  "Categories": [
    {
      "Id": 3,
      "Title": "Workshops",
      "UniqueId": "a1b2c3d4-...",
      "IdString": "3",
      "IsNull": false,
      "CreatedOn": "2024-01-10T10:00:00",
      "UpdatedOn": "2024-01-10T10:00:00",
      "CreatedOnUtc": "2024-01-10T10:00:00Z",
      "UpdatedOnUtc": "2024-01-10T10:00:00Z"
    }
  ],
  "RelatedEvents": [
    {
      "Id": 415,
      "Name": "Afternoon Pilates",
      "ShortDescription": "A refreshing end-of-day stretch session.",
      "StartDateUtc": "2026-03-24T17:00:00Z",
      "EndDateUtc": "2026-03-24T18:00:00Z",
      "Business": { "Id": 5, "Name": "Downtown Coworking Hub" },
      "EventCategories": [{ "Id": 3, "Title": "Workshops" }]
    }
  ],
  "Comment": null,
  "Event": {
    "Id": 412,
    "Name": "Morning Yoga & Mindfulness",
    "ShortDescription": "Start your week with a guided yoga session open to all levels.",
    "LongDescription": "<p>Join us every Monday for a 45-minute yoga session led by certified instructor Sarah Chen...</p>",
    "HostFullName": "Sarah Chen",
    "Location": "Studio Room B",
    "VenueAddress": null,
    "StartDate": "2026-03-23T07:30:00",
    "EndDate": "2026-03-23T08:15:00",
    "StartDateUtc": "2026-03-23T07:30:00Z",
    "EndDateUtc": "2026-03-23T08:15:00Z",
    "MultipleDays": false,
    "HasTickets": true,
    "SoldOut": false,
    "ChepeastPrice": 0,
    "MostExpensivePrice": 12.0,
    "Allocation": 20,
    "Sales": 7,
    "EnableWaitList": false,
    "AllowComments": true,
    "HasLargeImage": true,
    "HasSmallImage": true,
    "HasAddress": true,
    "HasResource": false,
    "Resource": null,
    "EventProducts": [
      {
        "Id": 88,
        "Name": "Free Entry",
        "Description": "Community member free pass",
        "Price": 0,
        "PriceCurrencyCode": "GBP",
        "PriceFormatted": "£0.00",
        "TicketsLeft": 13,
        "SoldOut": false,
        "IsAvailableNow": true,
        "MaxTicketsPerAttendee": null,
        "LastFew": false,
        "Future": false,
        "Expired": false,
        "DisplayOrder": 1,
        "StartDate": "2026-01-01T00:00:00",
        "EndDate": "2026-03-23T08:15:00",
        "Quantity": 1
      }
    ],
    "EventCategories": [{ "Id": 3, "Title": "Workshops" }],
    "Business": { "Id": 5, "Name": "Downtown Coworking Hub", "WebAddress": "https://downtown.example.com" },
    "Comments": [
      {
        "Id": 77,
        "Text": "Fantastic session, highly recommend!",
        "Rating": 5,
        "Published": true,
        "PostedBy": { "Id": 201, "FullName": "Maria Garcia" },
        "CreatedOn": "2026-02-10T09:15:00",
        "CreatedOnUtc": "2026-02-10T09:15:00Z"
      }
    ],
    "UniqueId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "IdString": "412",
    "CreatedOn": "2025-11-01T09:00:00",
    "UpdatedOn": "2026-03-01T12:00:00",
    "CreatedOnUtc": "2025-11-01T09:00:00Z",
    "UpdatedOnUtc": "2026-03-01T12:00:00Z",
    "IsNull": false
  }
}
```

### Fetch event with a minimal field set

```http theme={null}
GET /api/public/events/412?_shape=Event.Id,Event.Name,Event.StartDateUtc,Event.EventProducts.Id,Event.EventProducts.Price,Event.EventProducts.TicketsLeft,RelatedEvents.Id,RelatedEvents.Name
```

```json theme={null}
{
  "Event": {
    "Id": 412,
    "Name": "Morning Yoga & Mindfulness",
    "StartDateUtc": "2026-03-23T07:30:00Z",
    "EventProducts": [{ "Id": 88, "Price": 0, "TicketsLeft": 13 }]
  },
  "RelatedEvents": [{ "Id": 415, "Name": "Afternoon Pilates" }]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { EventDetails } from '@/types/endpoints/EventDetails'
import { createShape } from '@/helpers/shape-helper'
import { useData } from '@/api/fetchData'

const endpoint = endpoints.events.details(412)
const shape = createShape<typeof endpoint.type>()([
  'Event.Id',
  'Event.Name',
  'Event.StartDateUtc',
  'Event.EndDateUtc',
  'Event.ShortDescription',
  'Event.LongDescription',
  'Event.HasLargeImage',
  'Event.EnableWaitList',
  'Event.HasTickets',
  'Event.AllowComments',
  'Event.EventProducts.Id',
  'Event.EventProducts.Name',
  'Event.EventProducts.Price',
  'Event.EventProducts.TicketsLeft',
  'Event.EventProducts.IsAvailableNow',
  'RelatedEvents.Id',
  'RelatedEvents.Name',
  'RelatedEvents.StartDateUtc',
  'Event.Comments.Id',
  'Event.Comments.Text',
  'Event.Comments.PostedBy.FullName',
  'Event.Comments.CreatedOnUtc',
  'Event.Comments.Rating',
])

const { resource: event } = useData<typeof shape.type>(httpClient, endpoint.url, {
  shape: shape.fields,
})
```

## Usage in Portal

| Context                                      | Source file                                               |
| -------------------------------------------- | --------------------------------------------------------- |
| Event detail page (`/events/{id}`)           | `src/views/events/details/data.ts`                        |
| Basket item preview (event ticket in basket) | `src/components/Basket/items/EventBasketItemRow.tsx`      |
| Event checkout page (`/checkout/event`)      | `src/views/public/checkout/event/useEventCheckoutData.ts` |

## Error Responses

<ResponseField name="404 Not Found" type="error">
  No published event exists with the specified ID.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                           | Description                                       |
| ------ | -------------------------------------------------- | ------------------------------------------------- |
| `GET`  | `/api/public/events`                               | Paginated list of published events                |
| `GET`  | `/api/public/events/{eventId}/product/{productId}` | Detail for a specific ticket product              |
| `POST` | `/api/public/events/{id}/joinWaitingList`          | Join the waiting list for a sold-out event        |
| `GET`  | `/api/public/events/my`                            | Events the authenticated customer has tickets for |
| `POST` | `/en/events/newComment`                            | Post a comment on an event                        |


# Get Event Product
Source: https://learn.nexudus.com/api/endpoints/events/event-product

GET /api/public/events/{eventId}/product/{productId}
Returns detail for a specific ticket product belonging to a published event.

# Get Event Product

Returns the full detail for a single ticket product associated with a published event. Used during the event checkout flow to confirm product availability and price before purchase.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="number">
  The integer ID of the event. Obtained as `Id` from `GET /api/public/events` or `GET /api/public/events/{id}`.
</ParamField>

<ParamField type="number">
  The integer ID of the ticket product. Obtained as `EventProducts[].Id` from `GET /api/public/events/{id}`.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns an `EventProduct` object.

### Core Fields

<ResponseField name="Id" type="number">
  Unique identifier for the ticket product.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the ticket type (e.g. "General Admission", "VIP Pass").
</ResponseField>

<ResponseField name="Description" type="string">
  Optional description shown to customers during checkout.
</ResponseField>

<ResponseField name="Price" type="number">
  Ticket price. `0` for free tickets.
</ResponseField>

<ResponseField name="PriceCurrencyCode" type="string">
  ISO 4217 currency code (e.g. `"GBP"`, `"USD"`, `"EUR"`).
</ResponseField>

<ResponseField name="PriceFormatted" type="string">
  Localised price string including currency symbol (e.g. `"£12.00"`). Use this for display rather than formatting `Price` manually.
</ResponseField>

<ResponseField name="Currency" type="Currency">
  Full currency object from the business configuration.
</ResponseField>

### Availability

<ResponseField name="IsAvailableNow" type="boolean">
  When `true`, the ticket is within its sale window and has stock remaining.
</ResponseField>

<ResponseField name="SoldOut" type="boolean">
  When `true`, all available spots for this ticket type have been claimed.
</ResponseField>

<ResponseField name="TicketsLeft" type="number">
  Remaining ticket count. `0` when sold out.
</ResponseField>

<ResponseField name="LastFew" type="boolean">
  When `true`, fewer than a threshold number of tickets remain — used to display urgency messaging.
</ResponseField>

<ResponseField name="MaxTicketsPerAttendee" type="number | null">
  Maximum number of tickets a single customer can purchase. `null` means no limit.
</ResponseField>

<ResponseField name="Quantity" type="number">
  Total initial allocation for this ticket type.
</ResponseField>

### Sale Window

<ResponseField name="StartDate" type="string">
  Local datetime from which this ticket type goes on sale (ISO 8601).
</ResponseField>

<ResponseField name="EndDate" type="string">
  Local datetime after which this ticket type is no longer available (ISO 8601).
</ResponseField>

<ResponseField name="StartDateFormatted" type="string">
  Human-readable formatted start date.
</ResponseField>

<ResponseField name="EndDateFormatted" type="string">
  Human-readable formatted end date.
</ResponseField>

<ResponseField name="Expired" type="boolean">
  When `true`, the sale window has passed and tickets can no longer be purchased.
</ResponseField>

<ResponseField name="Future" type="boolean">
  When `true`, the sale window has not yet opened.
</ResponseField>

<ResponseField name="DisplayOrder" type="number">
  Operator-defined ordering position for display in ticket lists.
</ResponseField>

### Timestamps

All datetime fields are ISO 8601 strings. `*On` fields are in the location's local timezone; `*OnUtc` fields are UTC.

<ResponseField name="CreatedOn" type="string">
  Local datetime the ticket product was created.
</ResponseField>

<ResponseField name="CreatedOnUtc" type="string">
  UTC datetime the ticket product was created.
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Local datetime of the last update.
</ResponseField>

<ResponseField name="UpdatedOnUtc" type="string">
  UTC datetime of the last update.
</ResponseField>

## Examples

### Fetch a ticket product

```http theme={null}
GET /api/public/events/412/product/88
```

```json theme={null}
{
  "Id": 88,
  "Name": "General Admission",
  "Description": "Standard entry ticket. Includes refreshments.",
  "Price": 15.0,
  "PriceCurrencyCode": "GBP",
  "PriceFormatted": "£15.00",
  "Currency": { "Code": "GBP", "Symbol": "£" },
  "IsAvailableNow": true,
  "SoldOut": false,
  "TicketsLeft": 13,
  "LastFew": false,
  "MaxTicketsPerAttendee": 2,
  "Quantity": 20,
  "StartDate": "2026-01-01T00:00:00",
  "EndDate": "2026-03-23T08:15:00",
  "StartDateFormatted": "1 Jan 2026",
  "EndDateFormatted": "23 Mar 2026",
  "Expired": false,
  "Future": false,
  "DisplayOrder": 1,
  "UniqueId": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "IdString": "88",
  "CreatedOn": "2025-11-01T09:00:00",
  "UpdatedOn": "2026-03-01T12:00:00",
  "CreatedOnUtc": "2025-11-01T09:00:00Z",
  "UpdatedOnUtc": "2026-03-01T12:00:00Z",
  "IsNull": false
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { EventProduct } from '@/types/endpoints/EventList'
import { useData } from '@/api/fetchData'

const endpoint = endpoints.events.product(412, 88)

const { resource: product } = useData<EventProduct>(httpClient, endpoint.url)
```

## Error Responses

<ResponseField name="404 Not Found" type="error">
  No event with `eventId` or no ticket product with `productId` exists, or the product does not belong to the specified event.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                  | Description                                     |
| ------ | ----------------------------------------- | ----------------------------------------------- |
| `GET`  | `/api/public/events/{id}`                 | Full event detail including all ticket products |
| `GET`  | `/api/public/events`                      | Paginated list of published events              |
| `POST` | `/api/public/events/{id}/joinWaitingList` | Join the waiting list for a sold-out event      |


# Get Events Calendar
Source: https://learn.nexudus.com/api/endpoints/events/events-calendar

GET /en/bookings/fullCalendarEvents
Returns events within a date range in FullCalendar-compatible format for display in booking and events calendars.

# Get Events Calendar

Returns published events within a given date range formatted for the [FullCalendar](https://fullcalendar.io/) library. Used alongside booking slots in the portal's calendar view to give customers a unified view of space bookings and events.

<Note>This endpoint uses the `/en/` legacy route prefix rather than `/api/public/`. It does not support `_shape` field shaping.</Note>

## Authentication

No authentication required.

## Query Parameters

<ParamField type="string">
  ISO 8601 UTC datetime for the start of the range. **Example**: `2026-03-01T00:00:00.000Z`
</ParamField>

<ParamField type="string">
  ISO 8601 UTC datetime for the end of the range. **Example**: `2026-03-31T23:59:59.999Z`
</ParamField>

## Response

Returns an `EventsCalendar` array — a flat list of `EventsCalendarEvent` objects, one per event that falls within the requested range.

### EventsCalendarEvent Fields

<ResponseField name="id" type="string">
  Unique event identifier (stringified integer) compatible with FullCalendar's `id` field.
</ResponseField>

<ResponseField name="title" type="string">
  Event display name shown on the calendar.
</ResponseField>

<ResponseField name="start" type="string">
  Event start datetime (ISO 8601).
</ResponseField>

<ResponseField name="end" type="string">
  Event end datetime (ISO 8601).
</ResponseField>

<ResponseField name="allDay" type="boolean">
  When `true`, the event is displayed as an all-day block in the calendar.
</ResponseField>

<ResponseField name="shortDescription" type="string">
  Brief summary displayed in the calendar event tooltip or popover.
</ResponseField>

<ResponseField name="businessName" type="string">
  Name of the coworking location that published the event.
</ResponseField>

<ResponseField name="location" type="string | null">
  Venue name or room identifier.
</ResponseField>

<ResponseField name="venueAddress" type="string | null">
  Full postal address of the event venue.
</ResponseField>

<ResponseField name="ticketsPage" type="string | null">
  External ticket purchase URL if the operator has set a custom tickets page.
</ResponseField>

<ResponseField name="webAddress" type="string | null">
  External event URL (e.g. a Zoom or Eventbrite link).
</ResponseField>

<ResponseField name="url" type="string">
  Portal-relative URL to the event detail page. Use this to navigate on calendar item click.
</ResponseField>

<ResponseField name="event" type="boolean">
  Always `true` — distinguishes event entries from booking entries when both are rendered in the same FullCalendar instance.
</ResponseField>

<ResponseField name="editable" type="boolean">
  Always `false` for event entries — events cannot be dragged or resized in the calendar.
</ResponseField>

<ResponseField name="ignoreTimezone" type="boolean">
  When `true`, FullCalendar should treat the `start`/`end` values as local times rather than converting from UTC.
</ResponseField>

<ResponseField name="resourceId" type="string">
  ID of the linked bookable resource, if the event is associated with a specific room or desk.
</ResponseField>

<ResponseField name="resourceName" type="string">
  Display name of the linked resource.
</ResponseField>

## Examples

### Fetch calendar events for March 2026

```http theme={null}
GET /en/bookings/fullCalendarEvents?start=2026-03-01T00:00:00.000Z&end=2026-03-31T23:59:59.999Z
```

```json theme={null}
[
  {
    "id": "412",
    "resourceId": "",
    "resourceName": "",
    "title": "Morning Yoga & Mindfulness",
    "shortDescription": "Start your week with a guided yoga session open to all levels.",
    "businessName": "Downtown Coworking Hub",
    "location": "Studio Room B",
    "venueAddress": null,
    "ticketsPage": null,
    "webAddress": null,
    "start": "2026-03-23T07:30:00",
    "end": "2026-03-23T08:15:00",
    "allDay": false,
    "editable": false,
    "ignoreTimezone": false,
    "event": true,
    "url": "/events/412"
  },
  {
    "id": "420",
    "resourceId": "15",
    "resourceName": "Main Conference Room",
    "title": "Startup Pitch Night",
    "shortDescription": "Watch 8 local startups pitch to a panel of investors.",
    "businessName": "Downtown Coworking Hub",
    "location": "Main Conference Room",
    "venueAddress": null,
    "ticketsPage": null,
    "webAddress": null,
    "start": "2026-03-28T18:00:00",
    "end": "2026-03-28T21:00:00",
    "allDay": false,
    "editable": false,
    "ignoreTimezone": false,
    "event": true,
    "url": "/events/420"
  }
]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { EventsCalendar } from '@/types/endpoints/EventsCalendar'
import { useData } from '@/api/fetchData'
import { DateTime } from 'luxon'

const start = DateTime.now().startOf('month')
const end = DateTime.now().endOf('month')

const endpoint = endpoints.events.calendar(start, end)

const { resource: calendarEvents } = useData<EventsCalendar>(httpClient, endpoint.url)
```

## Usage in Portal

| Context                                           | Source file                                           |
| ------------------------------------------------- | ----------------------------------------------------- |
| Bookings search / resource calendar (`/bookings`) | `src/views/public/bookings/useBookingsSearchData.tsx` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  `start` or `end` is missing or not a valid ISO 8601 datetime string.
</ResponseField>

## Related Endpoints

| Method | Endpoint                            | Description                                     |
| ------ | ----------------------------------- | ----------------------------------------------- |
| `GET`  | `/api/public/events`                | Paginated events list with full event metadata  |
| `GET`  | `/api/public/events/{id}`           | Full detail for a specific event                |
| `GET`  | `/en/bookings/fullCalendarBookings` | Bookings in FullCalendar format (same calendar) |


# Join Event Waiting List
Source: https://learn.nexudus.com/api/endpoints/events/join-waiting-list

POST /api/public/events/{id}/joinWaitingList
Adds the authenticated customer to the waiting list for a sold-out event.

# Join Event Waiting List

Registers the authenticated customer on the waiting list for an event that has no available tickets. When a spot becomes available, the operator can notify waiting-list members. Only callable when `CalendarEvent.EnableWaitList` is `true` and the event is sold out.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  The integer ID of the event. Obtained as `Id` from `GET /api/public/events` or `GET /api/public/events/{id}`.
</ParamField>

## Request Body

The request body accepts the customer's waiting-list registration data. The exact fields depend on the event configuration; pass an empty object `{}` if no additional fields are required.

<ParamField type="string">
  Full name of the customer registering for the waiting list.
</ParamField>

<ParamField type="string">
  Email address to notify when a spot becomes available.
</ParamField>

## Response

Returns an empty `200 OK` on success.

## Examples

### Join the waiting list

```http theme={null}
POST /api/public/events/412/joinWaitingList
Authorization: Bearer {token}
Content-Type: application/json

{
  "FullName": "Alex Johnson",
  "Email": "alex@example.com"
}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.events.joinWaitingList(412), {
  FullName: 'Alex Johnson',
  Email: 'alex@example.com',
})
```

## Usage in Portal

| Context                                                | Source file                                                    |
| ------------------------------------------------------ | -------------------------------------------------------------- |
| Event detail page — waiting list form (`/events/{id}`) | `src/views/events/details/data.ts`                             |
| Waiting list form component                            | `src/views/events/details/components/EventWaitingListForm.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No event with the specified ID exists.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  The event does not have waiting list enabled (`EnableWaitList` is `false`), or the customer is already on the waiting list.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                           | Description                                       |
| ------ | -------------------------------------------------- | ------------------------------------------------- |
| `GET`  | `/api/public/events/{id}`                          | Full event detail including `EnableWaitList` flag |
| `GET`  | `/api/public/events`                               | Paginated list of published events                |
| `GET`  | `/api/public/events/my`                            | Tickets held by the authenticated customer        |
| `GET`  | `/api/public/events/{eventId}/product/{productId}` | Ticket product availability detail                |


# List Events
Source: https://learn.nexudus.com/api/endpoints/events/list-events

GET /api/public/events
Returns a paginated list of published events, with optional filtering by category, keyword, date range, and featured status.

# List Events

Returns a paginated list of published calendar events for the current location. Supports filtering by past/upcoming, category, keyword search, and featured flag. Used to power the public-facing events catalogue and homepage event grids.

<Note>
  An **event** is a scheduled activity (workshop, networking session, etc.) published by the space operator. Events may have one or more **ticket
  products** with their own prices and availability windows.
</Note>

## Authentication

No authentication required. The response is scoped to the current business location.

## Query Parameters

<ParamField type="boolean">
  `true` — return events whose end date is in the past. `false` — return upcoming and active events.
</ParamField>

<ParamField type="number">
  1-based page number. **Default**: `1`
</ParamField>

<ParamField type="number">
  Number of events per page. **Default**: `25`
</ParamField>

<ParamField type="number">
  Filter to events belonging to a specific category. Omit to return events across all categories.
</ParamField>

<ParamField type="string">
  Keyword filter applied to event name and description. URL-encoded.
</ParamField>

<ParamField type="boolean">
  When `true`, returns only events marked as featured by the operator.
</ParamField>

<ParamField type="boolean">
  When `true`, returns only events that the operator has flagged to appear on the home page. Used by the `upcomingEvents` shortcut endpoint.
</ParamField>

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. **Example**:
  `_shape=CalendarEvents.Records.Id,CalendarEvents.Records.Name`
</ParamField>

## Response

Returns an `EventList` object containing pagination metadata and the paginated event records.

### Core Fields

<ResponseField name="PastEvents" type="boolean">
  Mirrors the `pastEvents` query parameter, confirming which slice of events was returned.
</ResponseField>

<ResponseField name="Categories" type="EventCategory[]">
  All available event categories for the current location — useful for building a category filter UI without a separate request.
</ResponseField>

<ResponseField name="Category" type="EventCategory | null">
  The currently active category filter, if `categoryId` was supplied.
</ResponseField>

<ResponseField name="CalendarEvents" type="ApiListResult<CalendarEvent>">
  Paginated wrapper containing the matching events. See [API Overview](/api/overview) for pagination fields (`CurrentPage`, `TotalItems`, etc.).
</ResponseField>

### CalendarEvent Fields

<ResponseField name="CalendarEvents.Records[].Id" type="number">
  Unique integer identifier for the event. Use this as `{id}` in detail, product, and waiting-list endpoints.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].UniqueId" type="string">
  UUID for the event — stable across edits and suitable as a cache key.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Name" type="string">
  Display name of the event.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].ShortDescription" type="string">
  Brief summary shown in list cards.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].LongDescription" type="string">
  Full event description. May contain HTML.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].HostFullName" type="string | null">
  Full name of the event host.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Location" type="string | null">
  Venue name or room identifier.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].VenueAddress" type="string | null">
  Full postal address of the event venue.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].WebAddress" type="string | null">
  External event URL (e.g., a Zoom or Eventbrite link).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].FacebookPage" type="string | null">
  Facebook event page URL.
</ResponseField>

### Dates

<ResponseField name="CalendarEvents.Records[].StartDate" type="string">
  Event start datetime in the location's local timezone (ISO 8601).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].EndDate" type="string">
  Event end datetime in the location's local timezone (ISO 8601).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].StartDateUtc" type="string">
  Event start datetime in UTC (ISO 8601).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].EndDateUtc" type="string">
  Event end datetime in UTC (ISO 8601).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].MultipleDays" type="boolean">
  When `true`, the event spans more than one calendar day.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].PublishDate" type="string">
  Local datetime from which the event becomes visible to customers.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].PublishDateUtc" type="string">
  UTC equivalent of `PublishDate`.
</ResponseField>

### Tickets & Pricing

<ResponseField name="CalendarEvents.Records[].HasTickets" type="boolean">
  When `true`, the event has at least one purchasable ticket product.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].SoldOut" type="boolean">
  When `true`, all ticket products are sold out or past their sale window.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].ChepeastPrice" type="number">
  Lowest ticket price across all ticket products. Note the typo in the field name (`Chepeast`) — it is preserved as-is in the API.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].MostExpensivePrice" type="number">
  Highest ticket price across all ticket products.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].ChepeastProduct" type="EventProduct | null">
  Full `EventProduct` object for the cheapest ticket option.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].MostExpensiveProduct" type="EventProduct | null">
  Full `EventProduct` object for the most expensive ticket option.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].EventProducts" type="EventProduct[]">
  All ticket products for this event.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].TicketsPage" type="string | null">
  External URL for purchasing tickets when `HasCustomTicketsPage` is `true`.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].HasCustomTicketsPage" type="boolean">
  When `true`, ticket purchase is handled on an external page (`TicketsPage`) rather than the portal checkout.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Allocation" type="number | null">
  Total number of available spots. `null` means unlimited.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Sales" type="number | null">
  Number of tickets sold so far.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].EnableWaitList" type="boolean">
  When `true`, customers can join a waiting list when the event is sold out.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].TicketNotes" type="string | null">
  Additional notes displayed to customers during ticket purchase.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].AskBuyerAddress" type="boolean">
  When `true`, the checkout form collects the buyer's postal address.
</ResponseField>

### Categorisation & Display

<ResponseField name="CalendarEvents.Records[].EventCategories" type="EventCategory[]">
  Categories this event belongs to.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].ShowInHomePage" type="boolean">
  When `true`, the event appears on the portal home page.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].ShowInHomeBanner" type="boolean">
  When `true`, the event is promoted in the home page banner carousel.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].AllowComments" type="boolean">
  When `true`, authenticated customers can post and view comments on the event detail page.
</ResponseField>

### Media & Resource

<ResponseField name="CalendarEvents.Records[].HasSmallImage" type="boolean">
  When `true`, a small thumbnail image is available.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].HasLargeImage" type="boolean">
  When `true`, a full-size banner image is available.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].HasAddress" type="boolean">
  Convenience flag — `true` when either `Location` or `VenueAddress` is set.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Resource" type="Resource | null">
  The bookable resource associated with this event, if the event is tied to a room or desk.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].HasResource" type="boolean">
  When `true`, a resource is linked to this event (`Resource` is non-null).
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Business" type="Business">
  The coworking location that published the event.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Recent10Attendees" type="{ Id: number; UpdatedOn: string }[] | null">
  Lightweight list of up to 10 recent attendees, used for social proof display.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].Comments" type="EventComment[]">
  Published comments on the event.
</ResponseField>

### Timestamps

All datetime fields are ISO 8601 strings. `*On` fields are in the location's local timezone; `*OnUtc` fields are UTC.

<ResponseField name="CalendarEvents.Records[].CreatedOn" type="string">
  Local datetime the event record was created.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].CreatedOnUtc" type="string">
  UTC datetime the event record was created.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].UpdatedOn" type="string">
  Local datetime of the last update.
</ResponseField>

<ResponseField name="CalendarEvents.Records[].UpdatedOnUtc" type="string">
  UTC datetime of the last update.
</ResponseField>

## Examples

### Fetch upcoming events (full payload)

```http theme={null}
GET /api/public/events?pastEvents=false&page=1&top=9
```

```json theme={null}
{
  "PastEvents": false,
  "Categories": [
    {
      "Id": 3,
      "Title": "Workshops",
      "UniqueId": "a1b2c3d4-...",
      "CreatedOn": "2024-01-10T10:00:00",
      "UpdatedOn": "2024-01-10T10:00:00",
      "CreatedOnUtc": "2024-01-10T10:00:00Z",
      "UpdatedOnUtc": "2024-01-10T10:00:00Z",
      "IdString": "3",
      "IsNull": false
    }
  ],
  "Category": null,
  "CalendarEvents": {
    "Records": [
      {
        "Id": 412,
        "Name": "Morning Yoga & Mindfulness",
        "ShortDescription": "Start your week with a guided yoga session open to all levels.",
        "LongDescription": "<p>Join us every Monday for a 45-minute yoga session...</p>",
        "HostFullName": "Sarah Chen",
        "Location": "Studio Room B",
        "VenueAddress": null,
        "StartDate": "2026-03-23T07:30:00",
        "EndDate": "2026-03-23T08:15:00",
        "StartDateUtc": "2026-03-23T07:30:00Z",
        "EndDateUtc": "2026-03-23T08:15:00Z",
        "MultipleDays": false,
        "HasTickets": true,
        "SoldOut": false,
        "ChepeastPrice": 0,
        "MostExpensivePrice": 12.0,
        "HasCustomTicketsPage": false,
        "TicketsPage": null,
        "Allocation": 20,
        "Sales": 7,
        "EnableWaitList": false,
        "AllowComments": true,
        "ShowInHomePage": true,
        "ShowInHomeBanner": false,
        "HasSmallImage": true,
        "HasLargeImage": true,
        "HasAddress": true,
        "HasResource": false,
        "Resource": null,
        "EventCategories": [{ "Id": 3, "Title": "Workshops" }],
        "EventProducts": [{ "Id": 88, "Name": "Free Entry", "Price": 0, "TicketsLeft": 13, "SoldOut": false, "IsAvailableNow": true }],
        "Business": { "Id": 5, "Name": "Downtown Coworking Hub" },
        "Comments": [],
        "UniqueId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "IdString": "412",
        "CreatedOn": "2025-11-01T09:00:00",
        "UpdatedOn": "2026-03-01T12:00:00",
        "CreatedOnUtc": "2025-11-01T09:00:00Z",
        "UpdatedOnUtc": "2026-03-01T12:00:00Z",
        "IsNull": false
      }
    ],
    "CurrentPage": 1,
    "CurrentPageSize": 9,
    "TotalItems": 1,
    "TotalPages": 1,
    "HasNextPage": false,
    "HasPreviousPage": false
  }
}
```

### Fetch events with a minimal field set

Use `_shape` to return only the data your UI needs, reducing payload size.

```http theme={null}
GET /api/public/events?pastEvents=false&page=1&top=9&_shape=CalendarEvents.Records.Id,CalendarEvents.Records.Name,CalendarEvents.Records.StartDateUtc,CalendarEvents.Records.HasLargeImage
```

```json theme={null}
{
  "CalendarEvents": {
    "Records": [{ "Id": 412, "Name": "Morning Yoga & Mindfulness", "StartDateUtc": "2026-03-23T07:30:00Z", "HasLargeImage": true }],
    "CurrentPage": 1,
    "CurrentPageSize": 9,
    "TotalItems": 1,
    "TotalPages": 1,
    "HasNextPage": false,
    "HasPreviousPage": false
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { EventList } from '@/types/endpoints/EventList'
import { useData } from '@/api/fetchData'

const endpoint = endpoints.events.events({
  pastEvents: false,
  page: 1,
  top: 9,
  categoryId: undefined,
  search: undefined,
  featured: false,
})

const { resource: eventList } = useData<EventList>(httpClient, endpoint.url, {
  shape: {
    fields: [
      'CalendarEvents.Records.Id',
      'CalendarEvents.Records.Name',
      'CalendarEvents.Records.StartDateUtc',
      'CalendarEvents.Records.HasLargeImage',
      'CalendarEvents.Records.ChepeastPrice',
      'CalendarEvents.Records.SoldOut',
    ],
  },
})
```

## Usage in Portal

| Context                                 | Source file                                                      |
| --------------------------------------- | ---------------------------------------------------------------- |
| Events catalogue (`/events`)            | `src/views/events/list/useEventsData.ts`                         |
| Homepage events grid (public home page) | `src/views/public/home-business/components/SimpleEventsGrid.tsx` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  A query parameter value is invalid — for example, a non-boolean `pastEvents` or a negative `page`.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                           | Description                                       |
| ------ | -------------------------------------------------- | ------------------------------------------------- |
| `GET`  | `/api/public/events/{id}`                          | Full detail for a single event                    |
| `GET`  | `/api/public/events?onlyHomePage=true`             | Upcoming home-page events (no auth required)      |
| `GET`  | `/api/public/events/my`                            | Events the authenticated customer has tickets for |
| `GET`  | `/api/public/events/{eventId}/product/{productId}` | Ticket product detail                             |
| `POST` | `/api/public/events/{id}/joinWaitingList`          | Join the waiting list for a sold-out event        |


# List My Events
Source: https://learn.nexudus.com/api/endpoints/events/my-events

GET /api/public/events/my
Returns a paginated list of event tickets belonging to the authenticated customer, optionally filtered to upcoming events.

# List My Events

Returns a paginated list of event attendances (tickets) for the authenticated customer. Pass `showUpcoming=true` to restrict the list to events that have not yet started — used to power the "Upcoming Events" widget on the personal dashboard and the tickets counter.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  `true` — return only tickets for events whose end date is in the future. `false` — return all tickets regardless of event date.
</ParamField>

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. **Example**:
  `_shape=Records.Id,Records.CalendarEvent.Name`
</ParamField>

<ParamField type="number">
  1-based page number. **Default**: `1`
</ParamField>

<ParamField type="number">
  Records per page. **Default**: `25` · **Maximum**: `100`
</ParamField>

<ParamField type="string">
  Field to sort by. **Default**: `CreatedOn`
</ParamField>

<ParamField type="string">
  `asc` or `desc`. **Default**: `desc`
</ParamField>

## Response

Returns a `MyEvents` object which extends `ApiListResult<EventAttendee>`. See [API Overview](/api/overview) for pagination fields. The `Records` array contains attendee (ticket) objects.

### Core Fields

<ResponseField name="Records[].Id" type="number">
  Unique identifier for the ticket/attendance record. Use this as `{id}` in the `sendTicket` and `cancelTicket` endpoints.
</ResponseField>

<ResponseField name="Records[].AttendeeCode" type="string">
  Unique code printed on the ticket — used for check-in at the event.
</ResponseField>

<ResponseField name="Records[].FullName" type="string">
  Full name of the ticket holder.
</ResponseField>

<ResponseField name="Records[].Email" type="string">
  Email address of the ticket holder.
</ResponseField>

### Event & Product

<ResponseField name="Records[].CalendarEvent" type="CalendarEvent">
  The event this ticket belongs to. See [List Events](/api/endpoints/events/list-events) for the full `CalendarEvent` schema.
</ResponseField>

<ResponseField name="Records[].EventProduct" type="EventProduct">
  The ticket product that was purchased. Contains price, name, and availability details.
</ResponseField>

<ResponseField name="Records[].EventProductName" type="string">
  Denormalised name of the ticket product — available without expanding `EventProduct`.
</ResponseField>

<ResponseField name="Records[].EventProductPrice" type="number">
  Denormalised price of the ticket product in the location's currency.
</ResponseField>

### Attendee

<ResponseField name="Records[].Coworker" type="Coworker">
  The `Coworker` object for the ticket holder, including profile and contact information.
</ResponseField>

<ResponseField name="Records[].Business" type="Business">
  The coworking location where the event takes place.
</ResponseField>

### Timestamps

All datetime fields are ISO 8601 strings. `*On` fields are in the location's local timezone; `*OnUtc` fields are UTC.

<ResponseField name="Records[].CreatedOn" type="string">
  Local datetime the ticket was issued.
</ResponseField>

<ResponseField name="Records[].CreatedOnUtc" type="string">
  UTC datetime the ticket was issued.
</ResponseField>

<ResponseField name="Records[].UpdatedOn" type="string">
  Local datetime of the last update.
</ResponseField>

<ResponseField name="Records[].UpdatedOnUtc" type="string">
  UTC datetime of the last update.
</ResponseField>

## Examples

### Fetch upcoming tickets (full payload)

```http theme={null}
GET /api/public/events/my?showUpcoming=true
Authorization: Bearer {token}
```

```json theme={null}
{
  "Records": [
    {
      "Id": 9021,
      "AttendeeCode": "EVT-9021-ABCD",
      "FullName": "Alex Johnson",
      "Email": "alex@example.com",
      "EventProductName": "General Admission",
      "EventProductPrice": 15.0,
      "CalendarEvent": {
        "Id": 412,
        "Name": "Morning Yoga & Mindfulness",
        "StartDateUtc": "2026-03-23T07:30:00Z",
        "EndDateUtc": "2026-03-23T08:15:00Z",
        "Location": "Studio Room B",
        "HasLargeImage": true,
        "Business": { "Id": 5, "Name": "Downtown Coworking Hub" }
      },
      "EventProduct": {
        "Id": 88,
        "Name": "General Admission",
        "Price": 15.0,
        "PriceCurrencyCode": "GBP",
        "SoldOut": false,
        "IsAvailableNow": true
      },
      "Business": { "Id": 5, "Name": "Downtown Coworking Hub" },
      "UniqueId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "IdString": "9021",
      "CreatedOn": "2026-03-01T11:00:00",
      "UpdatedOn": "2026-03-01T11:00:00",
      "CreatedOnUtc": "2026-03-01T11:00:00Z",
      "UpdatedOnUtc": "2026-03-01T11:00:00Z",
      "IsNull": false
    }
  ],
  "CurrentPage": 1,
  "CurrentPageSize": 25,
  "TotalItems": 1,
  "TotalPages": 1,
  "HasNextPage": false,
  "HasPreviousPage": false
}
```

### Fetch my events with a minimal field set

```http theme={null}
GET /api/public/events/my?showUpcoming=true&_shape=Records.Id,Records.EventProductName,Records.CalendarEvent.Name,Records.CalendarEvent.StartDateUtc
Authorization: Bearer {token}
```

```json theme={null}
{
  "Records": [
    {
      "Id": 9021,
      "EventProductName": "General Admission",
      "CalendarEvent": { "Name": "Morning Yoga & Mindfulness", "StartDateUtc": "2026-03-23T07:30:00Z" }
    }
  ],
  "CurrentPage": 1,
  "CurrentPageSize": 25,
  "TotalItems": 1,
  "TotalPages": 1,
  "HasNextPage": false,
  "HasPreviousPage": false
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { MyEvents } from '@/types/endpoints/MyEvents'
import { useData } from '@/api/fetchData'

const endpoint = endpoints.events.myEvents(true) // showUpcoming=true

const { resource: myEvents } = useData<MyEvents>(httpClient, endpoint.url)
```

## Usage in Portal

| Context                                            | Source file                                                                                   |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| My Events page (`/activity/events`)                | `src/views/user/activity/events/MyEventsSection.tsx`                                          |
| Weekly Agenda calendar widget (personal dashboard) | `src/views/user/dashboards/personal/components/WeeklyAgendaCalendar/WeeklyAgendaCalendar.tsx` |
| Tickets statistic widget (personal dashboard)      | `src/views/user/dashboards/personal/components/Statistics/widgets/TicketsStatisticWidget.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

## Related Endpoints

| Method   | Endpoint                                  | Description                                |
| -------- | ----------------------------------------- | ------------------------------------------ |
| `GET`    | `/api/public/events`                      | Browse all published events                |
| `GET`    | `/api/public/events/{id}`                 | Full detail for a specific event           |
| `POST`   | `/api/public/events/my/{id}/sendTicket`   | Re-send a ticket confirmation email        |
| `DELETE` | `/api/public/events/my/{id}`              | Cancel (delete) a ticket                   |
| `POST`   | `/api/public/events/{id}/joinWaitingList` | Join the waiting list for a sold-out event |


# Post Event Comment
Source: https://learn.nexudus.com/api/endpoints/events/new-comment

POST /en/events/newComment
Posts a new comment (and optional rating) on a published event on behalf of the authenticated customer.

# Post Event Comment

Submits a new comment and optional star rating on a published event. Only available when the event's `AllowComments` flag is `true`. After a successful post the event detail data should be refetched to display the new comment.

<Note>This endpoint uses the `/en/` legacy route prefix rather than `/api/public/`.</Note>

## Authentication

Requires a valid customer bearer token.

## Request Body

<ParamField type="number">
  The integer ID of the event to comment on. Obtained as `Event.Id` from `GET /api/public/events/{id}`.
</ParamField>

<ParamField type="string">
  The text body of the comment.
</ParamField>

<ParamField type="string">
  Optional title or headline for the comment.
</ParamField>

<ParamField type="number | null">
  Optional numeric rating (e.g. `1`–`5`). Pass `null` to submit without a rating.
</ParamField>

## Response

Returns an empty `200 OK` on success. Refetch `GET /api/public/events/{id}` to see the new comment in the `Event.Comments` array.

## Examples

### Post a comment with a rating

```http theme={null}
POST /en/events/newComment
Authorization: Bearer {token}
Content-Type: application/json

{
  "Id": 412,
  "comment": "Fantastic session, highly recommend to anyone looking to start their week right!",
  "Title": "Great yoga class",
  "Rating": 5
}
```

```
HTTP/1.1 200 OK
```

### Post a comment without a rating

```http theme={null}
POST /en/events/newComment
Authorization: Bearer {token}
Content-Type: application/json

{
  "Id": 412,
  "comment": "Really enjoyed this. Will be back next week.",
  "Title": null,
  "Rating": null
}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.events.newComment, {
  Id: 412,
  comment: 'Fantastic session, highly recommend!',
  Title: 'Great yoga class',
  Rating: 5,
})
```

## Usage in Portal

| Context                                         | Source file                        |
| ----------------------------------------------- | ---------------------------------- |
| Event detail page comment form (`/events/{id}`) | `src/views/events/details/data.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Missing required field `Id` or `comment`, or the event does not allow comments (`AllowComments` is `false`).
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No event with the specified `Id` exists.
</ResponseField>

## Related Endpoints

| Method | Endpoint                   | Description                                                       |
| ------ | -------------------------- | ----------------------------------------------------------------- |
| `GET`  | `/api/public/events/{id}`  | Event detail — includes `Comments` array and `AllowComments` flag |
| `POST` | `/en/events/deleteComment` | Delete a comment previously posted by the customer                |


# Send Event Ticket
Source: https://learn.nexudus.com/api/endpoints/events/send-ticket

POST /api/public/events/my/{id}/sendTicket
Sends a ticket confirmation email to the authenticated customer for a specific event attendance.

# Send Event Ticket

Triggers a ticket confirmation email to the authenticated customer for the specified attendance record. Used on the My Events page to allow customers to resend their ticket if it was lost or never received.

## Authentication

Requires a valid customer bearer token. The attendance record must belong to the authenticated customer.

## Path Parameters

<ParamField type="number">
  The integer ID of the attendance record. Obtained as `Records[].Id` from `GET /api/public/events/my`.
</ParamField>

## Request Body

No request body required.

## Response

Returns an empty `200 OK` on success.

## Examples

### Send a ticket email

```http theme={null}
POST /api/public/events/my/9021/sendTicket
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.events.sendTicket(9021))
```

## Usage in Portal

| Context                             | Source file                                          |
| ----------------------------------- | ---------------------------------------------------- |
| My Events page (`/activity/events`) | `src/views/user/activity/events/MyEventsSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No attendance record with the specified ID exists for the authenticated customer.
</ResponseField>

## Related Endpoints

| Method   | Endpoint                     | Description                                     |
| -------- | ---------------------------- | ----------------------------------------------- |
| `GET`    | `/api/public/events/my`      | List all tickets for the authenticated customer |
| `DELETE` | `/api/public/events/my/{id}` | Cancel a ticket                                 |
| `GET`    | `/api/public/events/{id}`    | Full detail for a specific event                |


# List Upcoming Home Page Events
Source: https://learn.nexudus.com/api/endpoints/events/upcoming-events

GET /api/public/events
Returns published events flagged for the home page, used to populate upcoming event widgets on the portal home.

# List Upcoming Home Page Events

Returns a list of published events that the operator has flagged to appear on the portal home page (`onlyHomePage=true`). This is the shortcut endpoint behind `endpoints.events.upcomingEvents` — equivalent to calling the events list with `onlyHomePage=true`.

<Note>
  This endpoint is a convenience alias for `GET /api/public/events?onlyHomePage=true`. See [List Events](/api/endpoints/events/list-events) for the
  full parameter and response documentation.
</Note>

## Authentication

No authentication required.

## Query Parameters

<ParamField type="boolean">
  Must be `true`. Returns only events that the operator has configured to appear on the portal home page.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=CalendarEvents.Records.Name,CalendarEvents.Records.StartDateUtc,CalendarEvents.TotalItems`.
</ParamField>

## Response

Returns the same `EventList` structure as [List Events](/api/endpoints/events/list-events). See that endpoint for the full field breakdown.

### Key Event Fields

| Field                | Type      | Description                             |
| -------------------- | --------- | --------------------------------------- |
| `Id`                 | `number`  | Unique numeric identifier for the event |
| `Name`               | `string`  | Event title (localised)                 |
| `ShortDescription`   | `string`  | Brief event description                 |
| `StartDateUtc`       | `string`  | Event start date/time (UTC)             |
| `EndDateUtc`         | `string`  | Event end date/time (UTC)               |
| `HasLargeImage`      | `boolean` | Whether the event has a large image     |
| `ShowInHomePage`     | `boolean` | Whether flagged for the home page       |
| `HasTickets`         | `boolean` | Whether the event has ticket products   |
| `SoldOut`            | `boolean` | Whether all tickets are sold out        |
| `ChepeastPrice`      | `number`  | Lowest ticket price                     |
| `MostExpensivePrice` | `number`  | Highest ticket price                    |
| `Business`           | `object`  | Location object (`Id`, `Name`)          |

## Examples

### Fetch home page events

```http theme={null}
GET /api/public/events?onlyHomePage=true
```

```json theme={null}
{
  "PastEvents": false,
  "Categories": [],
  "Category": null,
  "CalendarEvents": {
    "Records": [
      {
        "Id": 420,
        "Name": "Startup Pitch Night",
        "ShortDescription": "Watch 8 local startups pitch to a panel of investors.",
        "StartDateUtc": "2026-03-28T18:00:00Z",
        "EndDateUtc": "2026-03-28T21:00:00Z",
        "HasLargeImage": true,
        "ShowInHomePage": true,
        "HasTickets": true,
        "SoldOut": false,
        "ChepeastPrice": 0,
        "MostExpensivePrice": 25.0,
        "Business": { "Id": 5, "Name": "Downtown Coworking Hub" }
      }
    ],
    "CurrentPage": 1,
    "CurrentPageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1,
    "HasNextPage": false,
    "HasPreviousPage": false
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

// endpoints.events.upcomingEvents is a pre-built URL string:
// 'api/public/events?onlyHomePage=true'
const { resource: upcomingEvents } = useData(httpClient, endpoints.events.upcomingEvents)
```

## Usage in Portal

| Context                                                | Source file                                                                                       |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| Upcoming Events dashboard section (personal dashboard) | `src/views/user/dashboards/personal/components/UpcomingEvents/UpcomingEventsDashboardSection.tsx` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  Invalid query parameter value.
</ResponseField>

## Related Endpoints

| Method | Endpoint                  | Description                                 |
| ------ | ------------------------- | ------------------------------------------- |
| `GET`  | `/api/public/events`      | Full paginated events list with all filters |
| `GET`  | `/api/public/events/{id}` | Full detail for a specific event            |
| `GET`  | `/api/public/events/my`   | Tickets held by the authenticated customer  |


# AI FAQ Search
Source: https://learn.nexudus.com/api/endpoints/faqs/ai-search

POST /api/public/faqs/aiSearch
Performs an AI-powered search across FAQs and returns a generated response.

# AI FAQ Search

Submits a natural language question and returns an AI-generated response based on the location's FAQ knowledge base. If a matching document was used, its ID and name are included in the response.

## Authentication

No authentication required.

## Request Body

<ParamField type="string">
  The natural language question to search for.
</ParamField>

## Response

<ResponseField name="AiResponse" type="object">
  The AI-generated response.
</ResponseField>

<ResponseField name="AiResponse.r" type="string">
  The generated answer text.
</ResponseField>

<ResponseField name="AiResponse.UsedDocumentId" type="number">
  ID of the FAQ document used to generate the answer, if applicable.
</ResponseField>

<ResponseField name="AiResponse.UsedDocumentName" type="string">
  Name of the FAQ document used, if applicable.
</ResponseField>

## Examples

### Search FAQs

```http theme={null}
POST /api/public/faqs/aiSearch
Content-Type: application/json

{
  "query": "What are the opening hours?"
}
```

```json theme={null}
{
  "AiResponse": {
    "r": "Our space is open Monday to Friday from 8am to 8pm, and Saturday from 9am to 5pm.",
    "UsedDocumentId": 15,
    "UsedDocumentName": "Opening Hours"
  }
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.faqs.aiSearch().url, {
  query: 'What are the opening hours?',
})
```


# List FAQs
Source: https://learn.nexudus.com/api/endpoints/faqs/list-faqs

GET /api/public/faqs
Returns all published FAQ entries for the current location.

# List FAQs

Returns the complete list of published FAQ entries for the current location, organised by group. Used to render the FAQ page in the portal.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `FaqList` object containing FAQ entries grouped by category.

### Top-Level Fields

| Field           | Type       | Description                                |
| --------------- | ---------- | ------------------------------------------ |
| `Categories`    | `string[]` | Array of distinct FAQ group/category names |
| `OpenAiEnabled` | `boolean`  | Whether AI-powered FAQ search is enabled   |

### FaqArticles Array

| Field           | Type             | Description                             |
| --------------- | ---------------- | --------------------------------------- |
| `Id`            | `number`         | Unique numeric identifier for the FAQ   |
| `UniqueId`      | `string`         | Globally unique identifier              |
| `Title`         | `string`         | FAQ question / title                    |
| `SummaryText`   | `string`         | Short answer summary                    |
| `FullText`      | `string`         | Full answer body (HTML)                 |
| `GroupName`     | `string`         | Category name the FAQ belongs to        |
| `DisplayOrder`  | `number`         | Sort order within the group             |
| `Active`        | `boolean`        | Whether the FAQ is published            |
| `HasImage`      | `boolean`        | Whether the FAQ has a thumbnail image   |
| `HasLargeImage` | `boolean`        | Whether the FAQ has a large image       |
| `CreatedOn`     | `string`         | Date created (business-local time)      |
| `UpdatedOn`     | `string \| null` | Date last updated (business-local time) |

## Examples

### Fetch FAQs

```http theme={null}
GET /api/public/faqs
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: faqs } = useTypedData(httpClient, endpoints.faqs.list())
```


# E-Sign Status
Source: https://learn.nexudus.com/api/endpoints/files/esign-status

GET /api/public/files/{fileId}/esign/status
Returns the electronic signature status for a specific file.

# E-Sign Status

Returns the current electronic signature status for a specific file. Used to check whether a document has been signed, is pending, or requires action.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the file.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a `HelloSignSignatureStatus` object with the e-signature status.

### E-Sign Status Fields

| Field            | Type             | Description                                      |
| ---------------- | ---------------- | ------------------------------------------------ |
| `SignatureId`    | `string`         | Identifier for the signature request             |
| `Status`         | `string`         | Current status (`pending`, `signed`, `declined`) |
| `SignedAt`       | `string \| null` | Date the document was signed                     |
| `LastViewedAt`   | `string \| null` | Date the document was last viewed                |
| `LastRemindedAt` | `string \| null` | Date the last reminder was sent                  |

## Examples

### Check e-sign status

```http theme={null}
GET /api/public/files/22/esign/status
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: status } = useTypedData(httpClient, endpoints.files.esign.status(22))
```


# List Files
Source: https://learn.nexudus.com/api/endpoints/files/list-files

GET /api/public/files/my
Returns the authenticated customer's files and documents.

# List Files

Returns the list of files and documents associated with the authenticated customer's account, including contracts, agreements, and uploaded documents.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns an array of file objects with the following fields.

### File Fields

#### Identity

| Field      | Type     | Description                            |
| ---------- | -------- | -------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the file |
| `UniqueId` | `string` | Globally unique identifier             |

#### Core

| Field                     | Type             | Description                             |
| ------------------------- | ---------------- | --------------------------------------- |
| `Name`                    | `string`         | File display name                       |
| `Description`             | `string`         | File description                        |
| `BusinessName`            | `string`         | Location that owns the file             |
| `Signed`                  | `boolean`        | Whether the document has been signed    |
| `RequestDigitalSignature` | `boolean`        | Whether a digital signature is required |
| `ProposalUniqueId`        | `string \| null` | Linked proposal GUID (if applicable)    |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch my files

```http theme={null}
GET /api/public/files/my
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.files.list)
```


# Get Form
Source: https://learn.nexudus.com/api/endpoints/forms/get-form

GET /api/public/forms/{formId}
Returns the full configuration of a form or survey for rendering.

# Get Form

Returns the complete form definition including fields, validation rules, and display settings. Used to render the form for user input.

## Authentication

No authentication required for public forms.

## Path Parameters

<ParamField type="string">
  Unique identifier (GUID) of the form.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns the form configuration object with the following fields.

### Form Fields

#### Identity

| Field      | Type     | Description                            |
| ---------- | -------- | -------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the form |
| `UniqueId` | `string` | Globally unique identifier             |

#### Core

| Field         | Type      | Description                     |
| ------------- | --------- | ------------------------------- |
| `Name`        | `string`  | Form display name               |
| `Description` | `string`  | Form description / instructions |
| `Active`      | `boolean` | Whether the form is active      |

#### Questions

Each form contains an array of question objects:

| Field                   | Type             | Description                              |
| ----------------------- | ---------------- | ---------------------------------------- |
| `Id`                    | `number`         | Question identifier                      |
| `Text`                  | `string`         | Question text                            |
| `Description`           | `string`         | Question description / help text         |
| `QuestionType`          | `string`         | Type of question (e.g. `Text`, `Select`) |
| `AvailableOptions`      | `string`         | Comma-separated list of options          |
| `AvailableOptionsArray` | `string[]`       | Array of option strings                  |
| `DisplayOrder`          | `number \| null` | Sort order of the question               |
| `AllowMultipleOptions`  | `boolean`        | Whether multiple selections are allowed  |
| `IsRequired`            | `boolean`        | Whether the question is required         |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.forms.show('abc123'))
```


# Preview Form
Source: https://learn.nexudus.com/api/endpoints/forms/preview-form

GET /api/public/forms/{formId}/preview
Returns the preview configuration for a form or survey.

# Preview Form

Returns the form schema and configuration for preview purposes. Used to render forms before they are submitted.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="string">
  Unique identifier (GUID) of the form.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns the form schema with field definitions, validation rules, and layout. Same structure as [`GET /api/public/forms/{formId}`](/api/endpoints/forms/get-form) — see that endpoint for the full field breakdown.

### Form Fields

#### Identity

| Field      | Type     | Description                            |
| ---------- | -------- | -------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the form |
| `UniqueId` | `string` | Globally unique identifier             |

#### Core

| Field         | Type      | Description                     |
| ------------- | --------- | ------------------------------- |
| `Name`        | `string`  | Form display name               |
| `Description` | `string`  | Form description / instructions |
| `Active`      | `boolean` | Whether the form is active      |

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.forms.preview('abc123'))
```


# Submit Form
Source: https://learn.nexudus.com/api/endpoints/forms/submit-form

POST /api/public/forms/{formId}
Submits a completed form or survey response.

# Submit Form

Submits the user's responses for a form or survey. The request body contains the field values matching the form schema.

## Authentication

Authentication requirements depend on form configuration. Some forms are public, others require a bearer token.

## Path Parameters

<ParamField type="string">
  Unique identifier (GUID) of the form.
</ParamField>

## Request Body

Dynamic field values matching the form's field definitions.

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.forms.submit('abc123'), formValues)
```


# Close Help Desk Message
Source: https://learn.nexudus.com/api/endpoints/helpdesk/close-message

PUT /api/public/helpdesk/messages/{messageId}/close
Closes an open help desk support ticket.

# Close Help Desk Message

Marks a help desk message as closed. Only the ticket author can close their own tickets.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the message to close.
</ParamField>

## Request Body

No request body required.

## Response

Returns a `200 OK` on success.

## Examples

### Close a ticket

```http theme={null}
PUT /api/public/helpdesk/messages/501/close
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.helpDesk.close(501))
```


# Create Help Desk Comment
Source: https://learn.nexudus.com/api/endpoints/helpdesk/create-comment

POST /api/public/helpdesk/messages/{messageId}/comments
Adds a comment to an existing help desk message thread.

# Create Help Desk Comment

Adds a follow-up comment to an existing help desk message thread. Used for back-and-forth communication between the customer and the support team.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the help desk message to comment on.
</ParamField>

## Request Body

<ParamField type="string">
  The text content of the comment.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Add a comment

```http theme={null}
POST /api/public/helpdesk/messages/501/comments
Authorization: Bearer {token}
Content-Type: application/json

{
  "MessageText": "The issue is still happening after restarting the router."
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.helpDesk.comments.create(501), {
  MessageText: 'The issue is still happening after restarting the router.',
})
```


# Create Help Desk Message
Source: https://learn.nexudus.com/api/endpoints/helpdesk/create-message

POST /api/public/helpdesk/messages
Creates a new help desk support ticket.

# Create Help Desk Message

Submits a new support ticket to the help desk. The message is assigned to the operator's configured department or default queue.

## Authentication

Requires a valid customer bearer token.

## Request Body

<ParamField type="string">
  Subject line for the support ticket.
</ParamField>

<ParamField type="string">
  Full description of the issue or request.
</ParamField>

<ParamField type="number">
  Optional department ID to route the ticket. See the departments endpoint.
</ParamField>

## Response

Returns a `200 OK` on success with the created message details.

## Examples

### Create a ticket

```http theme={null}
POST /api/public/helpdesk/messages
Authorization: Bearer {token}
Content-Type: application/json

{
  "Subject": "Wi-Fi not working",
  "MessageText": "The Wi-Fi on the 2nd floor has been down since this morning.",
  "DepartmentId": 3
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.helpDesk.create, {
  Subject: 'Wi-Fi not working',
  MessageText: 'The Wi-Fi on the 2nd floor has been down since this morning.',
  DepartmentId: 3,
})
```


# Delete Help Desk Comment
Source: https://learn.nexudus.com/api/endpoints/helpdesk/delete-comment

DELETE /api/public/helpdesk/messages/{messageId}/comments/{commentId}
Deletes a comment from a help desk message thread.

# Delete Help Desk Comment

Removes a specific comment from a help desk message thread. Only the comment author can delete their own comments.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the help desk message.
</ParamField>

<ParamField type="number">
  Numeric identifier of the comment to delete.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Delete a comment

```http theme={null}
DELETE /api/public/helpdesk/messages/501/comments/42
Authorization: Bearer {token}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.helpDesk.comments.delete(501, 42))
```


# List Help Desk Comments
Source: https://learn.nexudus.com/api/endpoints/helpdesk/list-comments

GET /api/public/helpdesk/messages/{messageId}/comments
Returns the comments on a help desk message thread.

# List Help Desk Comments

Returns all comments on a specific help desk message thread. Used to render the conversation history on the ticket detail page.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the help desk message.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.MessageText,Records.CoworkerId,Records.CreatedOn`.
</ParamField>

## Response

Returns an `ApiListResult<HelpDeskComment>` with the comment records.

The top-level response includes standard pagination fields (`CurrentPage`, `TotalItems`, `TotalPages`, etc.). Each item in the `Records` array has:

#### Identity

| Field      | Type     | Description                       |
| ---------- | -------- | --------------------------------- |
| `Id`       | `number` | Unique identifier for the comment |
| `UniqueId` | `string` | GUID identifier                   |

#### Content

| Field           | Type      | Description                             |
| --------------- | --------- | --------------------------------------- |
| `MessageText`   | `string`  | Comment text content                    |
| `IsAiGenerated` | `boolean` | Whether the comment was generated by AI |

#### Author

| Field        | Type       | Description                              |
| ------------ | ---------- | ---------------------------------------- |
| `Coworker`   | `Coworker` | Coworker who posted the comment (nested) |
| `CoworkerId` | `number`   | Coworker identifier                      |

#### Media

| Field           | Type      | Description                               |
| --------------- | --------- | ----------------------------------------- |
| `HasImage`      | `boolean` | Whether the comment has an attached image |
| `ImageFileName` | `string`  | Filename of the attached image            |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

## Examples

### Fetch comments

```http theme={null}
GET /api/public/helpdesk/messages/501/comments
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: comments } = useTypedData(httpClient, endpoints.helpDesk.comments.list(501))
```


# List Help Desk Departments
Source: https://learn.nexudus.com/api/endpoints/helpdesk/list-departments

GET /api/public/helpdesk/departments
Returns the available help desk departments for routing support tickets.

# List Help Desk Departments

Returns the list of help desk departments configured by the operator. Used to populate a department selector when creating new support tickets.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

<ResponseField name="Departments" type="Department[]">
  Array of available departments.
</ResponseField>

<ResponseField name="Departments[].Id" type="number">
  Unique identifier for the department. Use as `DepartmentId` when creating a message.
</ResponseField>

<ResponseField name="Departments[].Name" type="string">
  Display name of the department.
</ResponseField>

<ResponseField name="Departments[].Description" type="string">
  Description of the department's scope.
</ResponseField>

## Examples

### Fetch departments

```http theme={null}
GET /api/public/helpdesk/departments
Authorization: Bearer {token}
```

```json theme={null}
{
  "Departments": [
    { "Id": 1, "Name": "General", "Description": "General enquiries" },
    { "Id": 2, "Name": "Billing", "Description": "Invoice and payment issues" },
    { "Id": 3, "Name": "Facilities", "Description": "Building and equipment" }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: departments } = useTypedData(httpClient, endpoints.helpDesk.departments())
```


# List Help Desk Messages
Source: https://learn.nexudus.com/api/endpoints/helpdesk/list-messages

GET /api/public/helpdesk/messages
Returns the authenticated customer's help desk messages, optionally including closed tickets.

# List Help Desk Messages

Returns a list of help desk messages (support tickets) belonging to the authenticated customer. By default returns only open tickets; set `showClosed=true` to include resolved tickets.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  `true` — include closed/resolved tickets. `false` — return only open tickets.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Subject,Records.Closed,Records.CreatedOn`.
</ParamField>

## Response

Returns a `HelpDeskMessages` object containing an array of support ticket records.

### Help Desk Message Fields

#### Identity

| Field      | Type     | Description                               |
| ---------- | -------- | ----------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the message |
| `UniqueId` | `string` | Globally unique identifier                |

#### Core

| Field         | Type      | Description                             |
| ------------- | --------- | --------------------------------------- |
| `Subject`     | `string`  | Ticket subject line                     |
| `MessageText` | `string`  | Ticket body text                        |
| `Closed`      | `boolean` | Whether the ticket is closed / resolved |
| `HasImage`    | `boolean` | Whether an image attachment exists      |

#### Nested Objects

| Field        | Type       | Description                                             |
| ------------ | ---------- | ------------------------------------------------------- |
| `Department` | `object`   | Help desk department (`Id`, `Name`, `Description`)      |
| `Coworker`   | `object`   | Customer who opened the ticket (`Id`, `FullName`, etc.) |
| `Comments`   | `object[]` | Array of reply comments on this ticket                  |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch open tickets

```http theme={null}
GET /api/public/helpdesk/messages?showClosed=false
Authorization: Bearer {token}
```

### Fetch all tickets including closed

```http theme={null}
GET /api/public/helpdesk/messages?showClosed=true
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: messages } = useTypedData(httpClient, endpoints.helpDesk.list(false))
```


# Get Help Desk Message
Source: https://learn.nexudus.com/api/endpoints/helpdesk/message-details

GET /api/public/helpdesk/messages/{messageId}
Returns the full details of a single help desk message.

# Get Help Desk Message

Returns the complete details of a specific help desk message (support ticket), including status and associated metadata.

## Authentication

Requires a valid customer bearer token. The message must belong to the authenticated customer.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the help desk message. Returned as `Id` from the message list.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Subject,MessageText,Closed,Comments`.
</ParamField>

## Response

Returns a `HelpDeskMessage` object.

<ResponseField name="Id" type="number">
  Unique identifier for the message.
</ResponseField>

<ResponseField name="Subject" type="string">
  Subject line of the support ticket.
</ResponseField>

<ResponseField name="MessageText" type="string">
  Full body text of the message.
</ResponseField>

<ResponseField name="Closed" type="boolean">
  `true` when the ticket has been closed.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Creation timestamp in ISO 8601 format.
</ResponseField>

## Examples

### Fetch message details

```http theme={null}
GET /api/public/helpdesk/messages/501
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: message } = useTypedData(httpClient, endpoints.helpDesk.one(501))
```


# List Identity Checks
Source: https://learn.nexudus.com/api/endpoints/identity/list-identity-checks

GET /api/public/identityChecks/my
Returns the identity check requests for the authenticated customer.

# List Identity Checks

Returns identity check requests for the authenticated customer. These are verification requests (e.g. ID upload, KYC) that the operator has configured as part of the onboarding or compliance process.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  `true` — return only pending/incomplete checks. `false` — return all checks including completed ones.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns an `IdentityChecksList` object — a paginated list of identity check records.

### Identity Check Fields

#### Identity

| Field | Type     | Description                                      |
| ----- | -------- | ------------------------------------------------ |
| `Id`  | `number` | Unique numeric identifier for the identity check |

#### Core

| Field                   | Type     | Description                                       |
| ----------------------- | -------- | ------------------------------------------------- |
| `Name`                  | `string` | Check display name                                |
| `Description`           | `string` | Check description                                 |
| `Notes`                 | `string` | Additional notes                                  |
| `VerificationType`      | `string` | Type of verification (e.g. `Identity`, `Address`) |
| `IdentityCheckProvider` | `string` | Provider used for the check                       |
| `VerificationStatus`    | `string` | Current status (`Pending`, `Verified`, etc.)      |
| `LastError`             | `string` | Last error message (if any)                       |

#### Contact

| Field             | Type     | Description           |
| ----------------- | -------- | --------------------- |
| `ContactId`       | `number` | Contact identifier    |
| `ContactFullName` | `string` | Contact full name     |
| `BusinessId`      | `number` | Location identifier   |
| `BusinessName`    | `string` | Location display name |

#### Documents

| Field                            | Type             | Description               |
| -------------------------------- | ---------------- | ------------------------- |
| `IdentityDocumentType`           | `string`         | Type of identity document |
| `IdentityDocumentIssuedBy`       | `string`         | Issuing authority         |
| `IdentityDocumentExpirationDate` | `string \| null` | Document expiration date  |
| `AddressDocumentType`            | `string`         | Type of address document  |

#### Timestamps

| Field          | Type     | Description        |
| -------------- | -------- | ------------------ |
| `CreatedOnUtc` | `string` | Date created (UTC) |

## Examples

### Fetch pending checks

```http theme={null}
GET /api/public/identityChecks/my?showPending=true
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: checks } = useTypedData(httpClient, endpoints.identity.list(true))
```


# Upload Identity Document
Source: https://learn.nexudus.com/api/endpoints/identity/upload-document

POST /api/public/identityChecks/documents/upload/{id}
Uploads a verification document for a specific identity check.

# Upload Identity Document

Uploads a document (e.g. passport scan, driver's licence) for a specific identity check request. The file is submitted as a multipart form upload.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the identity check request.
</ParamField>

## Request Body

Multipart form data with the document file.

## Response

Returns a `200 OK` on successful upload.

## Examples

### Upload a document

```http theme={null}
POST /api/public/identityChecks/documents/upload/15
Authorization: Bearer {token}
Content-Type: multipart/form-data

[file data]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const formData = new FormData()
formData.append('file', file)
await httpClient.post(endpoints.identity.upload(15), formData)
```


# Subscribe to Newsletter
Source: https://learn.nexudus.com/api/endpoints/newsletter/subscribe

POST /api/public/newsletter/subscribe
Subscribes the current user or email address to the location newsletter.

# Subscribe to Newsletter

Registers an email address for the location's newsletter. Can be called by authenticated customers or public visitors providing an email address.

## Authentication

No authentication required for public subscription.

## Request Body

<ParamField type="string">
  Email address to subscribe.
</ParamField>

## Response

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the subscription was created or already existed.
</ResponseField>

## Examples

### Subscribe

```http theme={null}
POST /api/public/newsletter/subscribe
Content-Type: application/json

{
  "Email": "visitor@example.com"
}
```

```json theme={null}
{
  "WasSuccessful": true
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.newsletter.subscribe().url, {
  Email: 'visitor@example.com',
})
```


# Onboarding Tasks
Source: https://learn.nexudus.com/api/endpoints/onboarding/onboarding-tasks

GET /api/public/onboarding
Returns the list of onboarding tasks for the authenticated customer.

# Onboarding Tasks

Returns the current onboarding checklist for the authenticated customer. Tasks include items like completing their profile, adding directors, setting mail preferences, identity checks, or setting up e-invoicing. Used to display onboarding progress on the dashboard.

## Authentication

Requires a valid customer bearer token.

## Response

Returns an array of `OnBoardingTask` objects with completion status.

### Task Fields

| Field        | Type      | Description                                                                                  |
| ------------ | --------- | -------------------------------------------------------------------------------------------- |
| `CoworkerId` | `number`  | Numeric identifier for the customer the task belongs to                                      |
| `GroupId`    | `string`  | UUID that groups related tasks together (e.g. all virtual office tasks share the same group) |
| `Type`       | `string`  | The onboarding category. See [Task Types](#task-types) below                                 |
| `Action`     | `string`  | The specific action required. See [Task Actions](#task-actions) below                        |
| `Completed`  | `boolean` | Whether the customer has completed this task                                                 |

### Task Types

| Value                   | Description                                              |
| ----------------------- | -------------------------------------------------------- |
| `VirtualOffice`         | Virtual office setup tasks (directors, mail, recipients) |
| `IdentityCheck`         | Identity verification tasks                              |
| `DeferredRequiredField` | Required profile fields that must be completed later     |
| `CompleteProfile`       | Personal profile completion                              |
| `CompleteTeamProfile`   | Team profile completion                                  |
| `UnpaidInvoices`        | Outstanding invoices that need payment                   |
| `PendingDelivery`       | Pending mail or package deliveries                       |
| `EInvoicing`            | Electronic invoicing setup                               |

### Task Actions

| Value                    | Applicable Type(s)               | Description                                      |
| ------------------------ | -------------------------------- | ------------------------------------------------ |
| `AddDirectors`           | `VirtualOffice`                  | Add company directors to the virtual office      |
| `AddRecipients`          | `VirtualOffice`                  | Add mail recipients for the virtual office       |
| `SetMailPreferences`     | `VirtualOffice`                  | Configure mail handling preferences              |
| `StartIdentityChecks`    | `IdentityCheck`                  | Initiate identity verification                   |
| `CompleteIdentityChecks` | `IdentityCheck`, `VirtualOffice` | Finish all identity verification steps           |
| `CompleteProfile`        | `CompleteProfile`                | Fill in all required profile fields              |
| `PublishProfile`         | `CompleteProfile`                | Make the member profile visible in the directory |
| `CompleteTeamProfile`    | `CompleteTeamProfile`            | Fill in all required team profile fields         |
| `AddEInvoicingDetails`   | `EInvoicing`                     | Add electronic invoicing details                 |

## Examples

### Fetch onboarding tasks

```http theme={null}
GET /api/public/onboarding
Authorization: Bearer {token}
```

### Response — Virtual office tasks (mixed completion)

```json theme={null}
[
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddDirectors",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "CompleteIdentityChecks",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "SetMailPreferences",
    "Completed": false
  }
]
```

### Response — Identity check tasks

```json theme={null}
[
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "StartIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "CompleteIdentityChecks",
    "Completed": false
  }
]
```

### Response — Multiple task types

```json theme={null}
[
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddDirectors",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "SetMailPreferences",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "ad1d8608-9b95-454a-9a1c-944980f7eca5",
    "Type": "VirtualOffice",
    "Action": "AddRecipients",
    "Completed": true
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "StartIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "b2e4f910-3c78-4d1a-a5ef-82710dc3b6f1",
    "Type": "IdentityCheck",
    "Action": "CompleteIdentityChecks",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "f1a2b3c4-5678-9def-abcd-ef0123456789",
    "Type": "CompleteProfile",
    "Action": "CompleteProfile",
    "Completed": false
  },
  {
    "CoworkerId": 4706,
    "GroupId": "f1a2b3c4-5678-9def-abcd-ef0123456789",
    "Type": "EInvoicing",
    "Action": "AddEInvoicingDetails",
    "Completed": false
  }
]
```

### Response — No pending tasks

```json theme={null}
[]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.onboarding.tasks)
```

### Types

```typescript theme={null}
import type { OnBoardingTask, OnBoardingTasks } from '@/types/endpoints/OnBoardingTasks'
import { eOnBoardingType, eOnBoardingAction } from '@/types/endpoints/OnBoardingTasks'
```


# Get Passport Business Details
Source: https://learn.nexudus.com/api/endpoints/passport/business-details

GET /api/passport/business
Returns details for a specific business in the passport network.

# Get Passport Business Details

Returns the full details for a specific coworking business in the passport network. Used when a member selects a location on the passport map.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="number">
  Numeric identifier of the business.
</ParamField>

## Response

Returns a business detail object with location, amenities, and access information.

## Examples

### Fetch business details

```http theme={null}
GET /api/passport/business?businessId=5
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.passport.details(5))
```


# Search Passport Locations
Source: https://learn.nexudus.com/api/endpoints/passport/search-locations

GET /api/passport/map
Returns coworking locations near a geographic point, for the passport/network map.

# Search Passport Locations

Returns coworking locations within a specified distance of a geographic point. Powers the passport/network map feature that lets members discover and access partner spaces.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="number">
  Latitude of the search centre point.
</ParamField>

<ParamField type="number">
  Longitude of the search centre point.
</ParamField>

<ParamField type="number">
  Search radius (in kilometres).
</ParamField>

<ParamField type="number">
  Optional root business ID to scope results to a specific network.
</ParamField>

## Response

Returns an array of location objects with address, coordinates, and business details.

## Examples

### Search near a location

```http theme={null}
GET /api/passport/map?latitude=51.5074&longitude=-0.1278&distance=50
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.passport.getByCenter(51.5074, -0.1278, 50))
```


# Claim Perk
Source: https://learn.nexudus.com/api/endpoints/perks/claim-perk

POST /api/public/perks/{perkId}/claim
Claims a perk on behalf of the authenticated customer, returning a redirect URL if applicable.

# Claim Perk

Records that the authenticated customer has claimed a specific perk. If the perk has an associated external URL (e.g. a discount code landing page), the response includes a `Url` field for redirection.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  The integer ID of the perk to claim. Obtained as `Perks[].Id` from `GET /api/public/perks`.
</ParamField>

## Request Body

No request body required.

## Response

<ResponseField name="Url" type="string">
  External URL to redirect the customer to after claiming the perk. May be empty if the perk has no associated link.
</ResponseField>

## Examples

### Claim a perk

```http theme={null}
POST /api/public/perks/101/claim
Authorization: Bearer {token}
```

```json theme={null}
{
  "Url": "https://cornercafe.example.com/discount?code=NX15"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.perks.claim(101))
if (result.Url) {
  window.open(result.Url, '_blank')
}
```


# List Perks
Source: https://learn.nexudus.com/api/endpoints/perks/list-perks

GET /api/public/perks
Returns all published perks for the current location, grouped by category.

# List Perks

Returns all published perks available at the current location. Perks are grouped by their `GroupName` and include full-text descriptions suitable for rendering in a perks catalogue.

<Note>
  A **perk** is a benefit or discount offered by a partner business (restaurant, gym, etc.) to coworking members. Operators configure perks in the
  admin dashboard and members can claim them from the portal.
</Note>

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

### Core Fields

<ResponseField name="Groups" type="string[]">
  List of unique group names across all perks — use to build category tabs or filter UI.
</ResponseField>

<ResponseField name="Perks" type="Perk[]">
  Array of all published perks.
</ResponseField>

<ResponseField name="Perks[].Id" type="number">
  Unique identifier for the perk. Use as `{perkId}` in the claim endpoint.
</ResponseField>

<ResponseField name="Perks[].Title" type="string">
  Display title of the perk.
</ResponseField>

<ResponseField name="Perks[].GroupName" type="string">
  Category group this perk belongs to. Matches one of the values in the `Groups` array.
</ResponseField>

<ResponseField name="Perks[].FullText" type="string">
  Full description of the perk. May contain HTML.
</ResponseField>

<ResponseField name="Perks[].SummaryText" type="string">
  Short summary shown in perk cards.
</ResponseField>

## Examples

### Fetch all perks

```http theme={null}
GET /api/public/perks
Authorization: Bearer {token}
```

```json theme={null}
{
  "Groups": ["Food & Drink", "Fitness"],
  "Perks": [
    {
      "Id": 101,
      "Title": "15% off at Corner Café",
      "GroupName": "Food & Drink",
      "FullText": "<p>Show your member badge at Corner Café for 15% off any order.</p>",
      "SummaryText": "15% off any order"
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: perks } = useTypedData(httpClient, endpoints.perks.list())
// perks.Groups, perks.Perks
```


# Cancel Plan
Source: https://learn.nexudus.com/api/endpoints/plans/cancel-plan

POST /api/public/plans/cancel
Submits a cancellation request for an active plan.

# Cancel Plan

Submits a cancellation request for the authenticated customer's active plan. Depending on operator configuration, cancellation may take effect immediately or at the end of the current billing period.

## Authentication

Requires a valid customer bearer token.

## Request Body

The request body contains the contract/plan details for the cancellation.

<ParamField type="number">
  The integer ID of the contract to cancel.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Cancel a plan

```http theme={null}
POST /api/public/plans/cancel
Authorization: Bearer {token}
Content-Type: application/json

{
  "ContractId": 789
}
```

```
HTTP/1.1 200 OK
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.plans.cancel, { ContractId: 789 })
```


# List My Plans
Source: https://learn.nexudus.com/api/endpoints/plans/my-plans

GET /api/public/plans/my
Returns all active plans (contracts) for the authenticated customer.

# List My Plans

Returns the list of plans (contracts/tariffs) that the authenticated customer currently holds. Used to display the customer's active subscriptions on the dashboard.

<Note>
  A **plan** (also called a tariff) is a recurring membership package. Each plan creates a **contract** that tracks billing, start/end dates, and
  cancellation status.
</Note>

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Tariff.Name,Records.Price,Records.Active,Records.StartDate`.
</ParamField>

## Response

Returns an array of contract/plan objects for the authenticated customer.

### Contract Fields

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the contract |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Dates

| Field                      | Type             | Description                             |
| -------------------------- | ---------------- | --------------------------------------- |
| `StartDate`                | `string \| null` | Contract start date (business-local)    |
| `ContractTerm`             | `string \| null` | Contract end/term date (business-local) |
| `RenewalDate`              | `string \| null` | Next renewal date (business-local)      |
| `RenewalDateUtc`           | `string \| null` | Next renewal date (UTC)                 |
| `CancellationDate`         | `string \| null` | Scheduled cancellation date             |
| `CancellationDateUtc`      | `string \| null` | Scheduled cancellation date (UTC)       |
| `EarliestCancellationDate` | `string \| null` | Earliest allowed cancellation date      |
| `NextAutoInvoice`          | `string \| null` | Next automatic invoice date             |

#### Pricing

| Field                     | Type             | Description                               |
| ------------------------- | ---------------- | ----------------------------------------- |
| `Price`                   | `number \| null` | Current contract price                    |
| `PriceWithMinimum`        | `number \| null` | Price including minimum charge            |
| `PriceFormatted`          | `string`         | Price formatted with currency symbol      |
| `NextPrice`               | `number \| null` | Price after next renewal                  |
| `NextPriceFormatted`      | `string`         | Next price formatted with currency symbol |
| `Value`                   | `number \| null` | Contract value                            |
| `DepositsAmount`          | `number`         | Total deposit amount                      |
| `DepositsAmountFormatted` | `string`         | Deposits formatted with currency symbol   |

#### Status

| Field                      | Type             | Description                                 |
| -------------------------- | ---------------- | ------------------------------------------- |
| `Active`                   | `boolean`        | Whether the contract is currently active    |
| `Cancelled`                | `boolean`        | Whether the contract has been cancelled     |
| `MainContract`             | `boolean`        | Whether this is the primary contract        |
| `PricePlanTermsAccepted`   | `boolean`        | Whether T\&C have been accepted             |
| `PricePlanTermsAcceptedOn` | `string \| null` | When T\&C were accepted                     |
| `IsPaused`                 | `boolean`        | Whether the contract has a pause configured |
| `IsPausedNow`              | `boolean`        | Whether currently in a paused period        |
| `CanBePausedNow`           | `boolean`        | Whether the contract can be paused now      |
| `InPausedPeriod`           | `boolean`        | Whether currently within a pause period     |
| `InPausedPeriodFrom`       | `string \| null` | Pause start date (business-local)           |
| `InPausedPeriodUntil`      | `string \| null` | Pause end date (business-local)             |

#### Billing

| Field        | Type     | Description                         |
| ------------ | -------- | ----------------------------------- |
| `BillingDay` | `number` | Day of month billing occurs         |
| `Quantity`   | `number` | Number of units on this contract    |
| `Notes`      | `string` | Contract notes                      |
| `Desks`      | `string` | Comma-separated assigned desk names |

#### Nested Objects

| Field        | Type             | Description                                      |
| ------------ | ---------------- | ------------------------------------------------ |
| `IssuedBy`   | `object`         | Location that issued the contract                |
| `Coworker`   | `object`         | Customer the contract belongs to                 |
| `Tariff`     | `object`         | Plan/tariff object (see plan-details for fields) |
| `NextTariff` | `object \| null` | Next tariff after renewal (if changing)          |
| `Schedules`  | `object[]`       | Contract schedule entries                        |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch my plans

```http theme={null}
GET /api/public/plans/my
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.plans.my)
```


# Get Plan Details
Source: https://learn.nexudus.com/api/endpoints/plans/plan-details

GET /api/public/plans/{planId}
Returns the full details for a specific plan (tariff).

# Get Plan Details

Returns the full configuration and pricing details for a specific plan. Used on the plan detail page to show features, pricing tiers, and included benefits.

## Authentication

No authentication required for public plan details.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the plan. Returned as `Id` from the published plans endpoint.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,Price,Description,InvoiceEvery,TimePasses,ExtraServices`.
</ParamField>

## Response

Returns a `Tariff` object with full plan configuration.

<ResponseField name="Id" type="number">
  Unique identifier for the plan.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the plan.
</ResponseField>

<ResponseField name="Description" type="string">
  Full plan description. May contain HTML.
</ResponseField>

<ResponseField name="Price" type="number">
  Base recurring price.
</ResponseField>

<ResponseField name="PriceCurrencyCode" type="string">
  ISO 4217 currency code.
</ResponseField>

## Examples

### Fetch plan details

```http theme={null}
GET /api/public/plans/12
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: plan } = useTypedData(httpClient, endpoints.plans.one(12))
```


# List Published Plans
Source: https://learn.nexudus.com/api/endpoints/plans/published-plans

GET /api/public/plans/published
Returns all published plans available for sign-up, optionally filtered by invite code.

# List Published Plans

Returns all plans (tariffs) that are published and available for new customers to sign up for. Optionally accepts an invite GUID to show invite-only plans.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="string">
  Invite GUID to unlock private/invite-only plans. Omit to see only publicly listed plans.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Plans.Name,Plans.Price,Plans.Description`.
</ParamField>

## Response

Returns an object with a `Plans` array. Each plan has the following fields:

#### Identity

| Field      | Type     | Description                    |
| ---------- | -------- | ------------------------------ |
| `Id`       | `number` | Unique identifier for the plan |
| `UniqueId` | `string` | GUID identifier                |

#### Core

| Field                | Type      | Description                           |
| -------------------- | --------- | ------------------------------------- |
| `Name`               | `string`  | Display name of the plan              |
| `Description`        | `string`  | Plan description (may contain HTML)   |
| `TermsAndConditions` | `string`  | Terms and conditions text             |
| `GroupName`          | `string`  | Plan group name for categorisation    |
| `SystemTariffType`   | `number`  | Internal tariff type identifier       |
| `IsVirtualOffice`    | `boolean` | Whether this is a virtual office plan |

#### Pricing

| Field                 | Type       | Description                   |
| --------------------- | ---------- | ----------------------------- |
| `Price`               | `string`   | Formatted price string        |
| `PriceFormatted`      | `string`   | Locale-formatted price string |
| `PriceDecimal`        | `number`   | Price as decimal value        |
| `PriceDecimalExTax`   | `number`   | Price excluding tax           |
| `TotalPrice`          | `string`   | Total price string            |
| `TotalPriceFormatted` | `string`   | Locale-formatted total price  |
| `TotalPriceDecimal`   | `number`   | Total price as decimal        |
| `Currency`            | `Currency` | Currency object (nested)      |
| `TaxRate`             | `number?`  | Applicable tax rate           |

#### Billing

| Field                        | Type      | Description                               |
| ---------------------------- | --------- | ----------------------------------------- |
| `InvoiceEvery`               | `number`  | Invoice frequency                         |
| `InvoiceEveryWeeks`          | `number`  | Invoice frequency in weeks                |
| `InvoicePeriod`              | `number`  | Invoice period                            |
| `InvoiceInMonths`            | `boolean` | Whether billing is in months              |
| `DefaultContractTerm`        | `number?` | Default contract term length              |
| `DisablePortalCancellations` | `boolean` | Whether portal cancellations are disabled |
| `CanBePaused`                | `boolean` | Whether the plan can be paused            |
| `KeepNewAccountsOnHold`      | `boolean` | Whether new accounts are kept on hold     |

#### Limits

| Field                   | Type      | Description                   |
| ----------------------- | --------- | ----------------------------- |
| `CheckinPricePlanLimit` | `number?` | Check-in limit per price plan |
| `CheckinMonthLimit`     | `number?` | Monthly check-in limit        |
| `CheckinWeekLimit`      | `number?` | Weekly check-in limit         |
| `HoursPricePlanLimit`   | `number?` | Hours limit per price plan    |
| `HoursMonthLimit`       | `number?` | Monthly hours limit           |
| `HoursWeekLimit`        | `number?` | Weekly hours limit            |

#### Discounts

| Field                   | Type      | Description                |
| ----------------------- | --------- | -------------------------- |
| `DiscountCharges`       | `number?` | Discount on charges        |
| `DiscountExtraServices` | `number?` | Discount on extra services |
| `DiscountTimePasses`    | `number?` | Discount on time passes    |

#### Virtual Office

| Field                   | Type      | Description               |
| ----------------------- | --------- | ------------------------- |
| `MaximumAddresses`      | `number?` | Maximum virtual addresses |
| `MaximumCompanyAliases` | `number?` | Maximum company aliases   |
| `MaximumRecipients`     | `number?` | Maximum mail recipients   |

#### Nested Objects

| Field            | Type                    | Description                      |
| ---------------- | ----------------------- | -------------------------------- |
| `TimePasses`     | `TariffTimePass[]`      | Time passes included in the plan |
| `ExtraServices`  | `TariffExtraService[]`  | Extra services included          |
| `BookingCredits` | `TariffBookingCredit[]` | Booking credits included         |
| `SignupProducts` | `Product[]`             | Products added at sign-up        |
| `Products`       | `Product[]`             | Products included with the plan  |

#### Business

| Field                | Type     | Description          |
| -------------------- | -------- | -------------------- |
| `BusinessId`         | `number` | Business identifier  |
| `BusinessName`       | `string` | Business name        |
| `BusinessWebAddress` | `string` | Business web address |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

## Examples

### Fetch published plans

```http theme={null}
GET /api/public/plans/published
```

### Fetch with invite code

```http theme={null}
GET /api/public/plans/published?invite_guid=abc123-def456
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: plans } = useTypedData(httpClient, endpoints.plans.published())
// plans.Plans
```


# List Store Products
Source: https://learn.nexudus.com/api/endpoints/products/list-products

GET /api/public/store/products
Returns the list of products available in the store, with optional filtering by tag, type, and selected plans.

# List Store Products

Returns all products available in the ecommerce store for the current location. Supports filtering by tag, product type (time passes), and selected plans.

## Authentication

No authentication required for public product listing.

## Query Parameters

<ParamField type="number">
  Customer profile ID to personalise available products. Defaults to `0`.
</ParamField>

<ParamField type="string">
  Filter by product tag. URL-encoded.
</ParamField>

<ParamField type="number">
  Filter to a specific product by ID.
</ParamField>

<ParamField type="boolean">
  When `true`, returns only time-pass products.
</ParamField>

<ParamField type="number[]">
  Array of plan IDs to filter products compatible with specific plans.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Products.Name,Products.Price,Products.PriceFormatted`.
</ParamField>

## Response

Returns an object with a `Products` array. Each product has the following fields:

#### Identity

| Field      | Type     | Description                       |
| ---------- | -------- | --------------------------------- |
| `Id`       | `number` | Unique identifier for the product |
| `UniqueId` | `string` | GUID identifier                   |

#### Core

| Field               | Type      | Description                                 |
| ------------------- | --------- | ------------------------------------------- |
| `Name`              | `string`  | Display name of the product                 |
| `Description`       | `string`  | Product description (may contain HTML)      |
| `Tags`              | `string`  | Comma-separated tags                        |
| `DisplayOrder`      | `number`  | Sort order for display                      |
| `SystemProductType` | `number`  | Internal product type identifier            |
| `Visible`           | `boolean` | Whether the product is visible in the store |

#### Pricing

| Field                 | Type       | Description                   |
| --------------------- | ---------- | ----------------------------- |
| `Price`               | `number`   | Price amount                  |
| `PriceFormatted`      | `string`   | Locale-formatted price string |
| `ProductCurrencyCode` | `string`   | ISO currency code             |
| `Currency`            | `Currency` | Currency object (nested)      |
| `TaxRate`             | `number?`  | Applicable tax rate           |

#### Billing

| Field             | Type      | Description                        |
| ----------------- | --------- | ---------------------------------- |
| `Quantity`        | `number`  | Default quantity                   |
| `RegularCharge`   | `boolean` | Whether this is a recurring charge |
| `AlwaysRecurrent` | `boolean` | Always billed as recurring         |
| `AlwaysOneOff`    | `boolean` | Always billed as one-off           |
| `InvoiceCoworker` | `boolean` | Whether to invoice the coworker    |

#### Stock

| Field                | Type      | Description                       |
| -------------------- | --------- | --------------------------------- |
| `TrackStock`         | `boolean` | Whether stock tracking is enabled |
| `CurrentStock`       | `number?` | Current available stock           |
| `AllowNegativeStock` | `boolean` | Whether negative stock is allowed |

#### Business

| Field                | Type      | Description                                    |
| -------------------- | --------- | ---------------------------------------------- |
| `BusinessId`         | `number`  | Business identifier                            |
| `BusinessName`       | `string`  | Business name                                  |
| `BusinessWebAddress` | `string`  | Business web address                           |
| `HasTimePasses`      | `boolean` | Whether the product has associated time passes |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

## Examples

### Fetch all store products

```http theme={null}
GET /api/public/store/products?profileId=0
```

### Fetch time passes only

```http theme={null}
GET /api/public/store/products?profileId=0&onlyTimePasses=true
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: store } = useTypedData(
  httpClient,
  endpoints.products.products({
    profileId: 0,
    tag: 'day-pass',
  }),
)
// store.Products
```


# List My Products
Source: https://learn.nexudus.com/api/endpoints/products/my-products

GET /api/public/products/my
Returns the products purchased by the authenticated customer.

# List My Products

Returns all products that the authenticated customer has purchased or has active. Used on the customer's account page to show active memberships, passes, and add-on products.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.Product.Name,Records.Price,Records.Quantity`.
</ParamField>

## Response

Returns an array of `CoworkerProduct` objects with the following fields.

### CoworkerProduct Fields

#### Identity

| Field      | Type     | Description                |
| ---------- | -------- | -------------------------- |
| `Id`       | `number` | Unique numeric identifier  |
| `UniqueId` | `string` | Globally unique identifier |

#### Pricing

| Field            | Type     | Description                              |
| ---------------- | -------- | ---------------------------------------- |
| `Price`          | `number` | Calculated price (including tax display) |
| `PriceFormatted` | `string` | Price formatted with currency symbol     |

#### Billing

| Field           | Type             | Description                                |
| --------------- | ---------------- | ------------------------------------------ |
| `RegularCharge` | `boolean`        | Whether this is a recurring charge         |
| `RepeatCycle`   | `string`         | Billing cycle (e.g. `Monthly`, `Annually`) |
| `RepeatUnit`    | `number \| null` | Number of cycles between charges           |
| `Quantity`      | `number`         | Quantity purchased                         |
| `InvoiceOn`     | `string \| null` | Next invoice date                          |

#### Product Details

| Field     | Type     | Description                                      |
| --------- | -------- | ------------------------------------------------ |
| `Product` | `object` | Nested product object (see Product Fields below) |

### Nested Product Fields

| Field                 | Type             | Description                                 |
| --------------------- | ---------------- | ------------------------------------------- |
| `Id`                  | `number`         | Product identifier                          |
| `Name`                | `string`         | Product display name                        |
| `Description`         | `string`         | Product description                         |
| `Price`               | `number`         | Unit price (with tax display)               |
| `PriceFormatted`      | `string`         | Price formatted with currency symbol        |
| `Tags`                | `string`         | Comma-separated product tags                |
| `Visible`             | `boolean`        | Whether the product is visible in the store |
| `DisplayOrder`        | `number`         | Sort order in listings                      |
| `CurrentStock`        | `number \| null` | Current stock level (if tracked)            |
| `TrackStock`          | `boolean`        | Whether stock tracking is enabled           |
| `AllowNegativeStock`  | `boolean`        | Whether negative stock is permitted         |
| `ProductCurrencyCode` | `string`         | ISO 4217 currency code                      |
| `SystemProductType`   | `number`         | Internal product type identifier            |
| `BusinessId`          | `number`         | Location identifier                         |
| `BusinessName`        | `string`         | Location display name                       |
| `BusinessWebAddress`  | `string`         | Location subdomain                          |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch my products

```http theme={null}
GET /api/public/products/my
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.products.my)
```


# Get Product Details
Source: https://learn.nexudus.com/api/endpoints/products/product-details

GET /api/public/store/products/{productId}
Returns the full details for a single product in the store.

# Get Product Details

Returns the complete product information including pricing, description, and availability. Used on the product detail page and in the checkout flow.

## Authentication

No authentication required for public product details.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the product. Returned as `Id` from the products list.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,Price,PriceFormatted,Description`.
</ParamField>

## Response

Returns a `Product` object.

<ResponseField name="Id" type="number">
  Unique identifier for the product.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the product.
</ResponseField>

<ResponseField name="Description" type="string">
  Full product description. May contain HTML.
</ResponseField>

<ResponseField name="Price" type="number">
  Unit price.
</ResponseField>

<ResponseField name="PriceCurrencyCode" type="string">
  ISO 4217 currency code.
</ResponseField>

## Examples

### Fetch product details

```http theme={null}
GET /api/public/store/products/33
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: product } = useTypedData(httpClient, endpoints.products.one(33))
```


# Generate AI Profile
Source: https://learn.nexudus.com/api/endpoints/profile/generate-ai-profile

POST /en/profile/GenerateOpenAiProfile
Generate an AI-written professional profile summary for the authenticated customer based on their existing profile data.

# Generate AI Profile

Uses OpenAI to generate a professional profile summary for the authenticated customer. The AI drafts the `ProfileSummary` text based on the customer's existing profile fields (name, position, company, tags, etc.). The portal presents the result for the customer to review and accept before saving it via `PATCH /api/public/coworker/profile`.

<Note>
  This endpoint requires the location to have the OpenAI integration enabled. If it is not configured, the AI profile button will not appear in the
  portal UI.
</Note>

## Authentication

Requires a valid customer bearer token.

## Request Body

No body is required. The AI uses the customer's existing profile data from the server session.

```http theme={null}
POST /en/profile/GenerateOpenAiProfile
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
```

## Response

Returns a `Coworker` object with the `ProfileSummary` field populated with the AI-generated text. The customer's profile is **not** saved automatically — the customer must review and confirm, after which the portal calls `PATCH /api/public/coworker/profile` with `ProfileSummary`.

<ResponseField name="ProfileSummary" type="string | null">
  The AI-generated professional profile summary. May contain Markdown formatting. Presented to the customer for review before saving.
</ResponseField>

<ResponseField name="OpenAiProfileAvailable" type="boolean">
  `true` when AI profile generation is available for this location. Use this to show or hide the "Generate with AI" button.
</ResponseField>

## Example Response

```json theme={null}
{
  "ProfileSummary": "Jane is a product designer with over 8 years of experience building intuitive digital products for SaaS companies. Based at Nexudus Coworking, she specialises in design systems and user research.",
  "OpenAiProfileAvailable": true,
  "FullName": "Jane Doe",
  "Position": "Product Designer",
  "CompanyName": "Acme Design Co."
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { Coworker } from '@/types/spaces/Coworker'

const result = await httpClient.post<Coworker>(endpoints.profile.ai)

if (result.data.ProfileSummary) {
  // Present the generated text to the customer for review
  setGeneratedSummary(result.data.ProfileSummary)
}
```

## Usage in Portal

| Context                                               | Source file                                         |
| ----------------------------------------------------- | --------------------------------------------------- |
| Professional profile form — "Generate with AI" button | `src/views/user/components/ProfessionalProfile.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  The location does not have the OpenAI integration enabled, or the customer's profile lacks sufficient data to generate a summary.
</ResponseField>

## Related Endpoints

| Method  | Endpoint                         | Description                                          |
| ------- | -------------------------------- | ---------------------------------------------------- |
| `PATCH` | `/api/public/coworker/profile`   | Save the reviewed AI summary to the customer profile |
| `GET`   | `/en/profile?_resource=Coworker` | Retrieve full customer profile data                  |


# Update Profile
Source: https://learn.nexudus.com/api/endpoints/profile/update-profile

PATCH /api/public/coworker/profile
Partially update the authenticated customer profile — personal info, billing details, notifications, credentials, or professional profile fields.

# Update Profile

Partially updates the authenticated customer's profile. The same endpoint is used across all profile editing pages in the portal — personal information, billing details, notification preferences, account credentials, and the professional (public-facing) profile. Send only the fields you want to change; omitted fields are left unchanged.

## Authentication

Requires a valid customer bearer token.

## Request Body

Send a JSON object containing only the fields to update. All fields are optional; omitting a field leaves the current value unchanged.

### Personal Information

<ParamField type="string">
  The customer's display name.
</ParamField>

<ParamField type="string | null">
  Optional informal name displayed in some community contexts.
</ParamField>

<ParamField type="string">
  Gender identifier. Used for salutation generation.
</ParamField>

<ParamField type="string | null">
  ISO 8601 date of birth (e.g. `"1990-06-15"`).
</ParamField>

<ParamField type="string | null">
  Mobile phone number in any format.
</ParamField>

<ParamField type="string | null">
  Landline phone number.
</ParamField>

<ParamField type="string">
  Street address.
</ParamField>

<ParamField type="string">
  Postal or ZIP code.
</ParamField>

<ParamField type="string">
  City name.
</ParamField>

<ParamField type="string">
  State or region.
</ParamField>

<ParamField type="number">
  Numeric country identifier. Obtain valid IDs from `GET /api/public/countries`.
</ParamField>

### Billing Information

<ParamField type="string">
  Name to appear on invoices.
</ParamField>

<ParamField type="string">
  Email address for invoice delivery.
</ParamField>

<ParamField type="string | null">
  Billing street address.
</ParamField>

<ParamField type="string | null">
  Billing postal code.
</ParamField>

<ParamField type="string | null">
  Billing city.
</ParamField>

<ParamField type="string | null">
  Billing state or region.
</ParamField>

<ParamField type="number">
  Numeric country identifier for the billing address.
</ParamField>

<ParamField type="string">
  VAT or tax identification number printed on invoices.
</ParamField>

### Professional Profile

<ParamField type="string | null">
  Job title displayed on the public directory profile.
</ParamField>

<ParamField type="string">
  Company name displayed on the public directory profile.
</ParamField>

<ParamField type="string | null">
  Industry or area of work.
</ParamField>

<ParamField type="string | null">
  Free-text professional bio. Supports Markdown. Displayed on the public directory profile when `ProfileIsPublic` is `true`.
</ParamField>

<ParamField type="string | null">
  Personal or company website URL.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer's profile is listed in the member directory.
</ParamField>

<ParamField type="string">
  Comma-separated skill or interest tags shown on the directory profile.
</ParamField>

### Social Media

<ParamField type="string | null">
  Twitter profile URL or handle.
</ParamField>

<ParamField type="string | null">
  LinkedIn profile URL.
</ParamField>

<ParamField type="string | null">
  GitHub profile URL or username.
</ParamField>

<ParamField type="string | null">
  Instagram profile URL or handle.
</ParamField>

<ParamField type="string | null">
  Facebook profile URL.
</ParamField>

<ParamField type="string | null">
  Skype username.
</ParamField>

<ParamField type="string | null">
  Telegram username.
</ParamField>

### Notification Preferences

<ParamField type="boolean">
  When `true`, the customer receives email notifications for new help desk replies.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer receives email notifications for new community board posts.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer receives email notifications for new article comments.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer receives email notifications for new event comments.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer receives a periodic community activity digest email.
</ParamField>

<ParamField type="boolean">
  When `true`, the customer is opted in to the space's newsletter.
</ParamField>

### Credentials

<ParamField type="string">
  The customer's current password. Required when changing the password.
</ParamField>

<ParamField type="string">
  The new password to set. Must satisfy the location's password policy.
</ParamField>

<ParamField type="string">
  Must match `NewPassword` exactly. Validated server-side.
</ParamField>

## Response

Returns an `ActionConfirmation` envelope.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the profile was updated successfully.
</ResponseField>

<ResponseField name="Value" type="string | null">
  Usually `null` on success.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `null` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation error object. `null` on success. Check this when `WasSuccessful` is `false`.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { ActionConfirmation } from '@/types/ActionConfirmation'

const result = await httpClient.patch<ActionConfirmation>(endpoints.profile.patch, {
  FullName: 'Jane Doe',
  Position: 'Product Designer',
  ProfileIsPublic: true,
})

if (result.data.WasSuccessful) {
  // Refresh profile data and show success toast
}
```

## Usage in Portal

| Context                                | Source file                                  |
| -------------------------------------- | -------------------------------------------- |
| Personal information form (`/profile`) | `src/views/user/PersonalInformationPage.tsx` |
| Professional profile form (`/profile`) | `src/views/user/ProfessionalProfilePage.tsx` |
| Billing information form (`/profile`)  | `src/views/user/BillingInformationPage.tsx`  |
| Notification preferences (`/profile`)  | `src/views/user/NotificationsPage.tsx`       |
| Change password (`/profile`)           | `src/views/user/CredentialsPage.tsx`         |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  One or more fields failed validation (e.g. password mismatch, invalid `CountryId`). Check `Errors` in the response body.
</ResponseField>

## Related Endpoints

| Method | Endpoint                            | Description                                                    |
| ------ | ----------------------------------- | -------------------------------------------------------------- |
| `GET`  | `/login/me?`                        | Retrieve the current user session and notification preferences |
| `GET`  | `/en/profile?_resource=Coworker`    | Retrieve the full customer profile for editing                 |
| `GET`  | `/api/public/coworkers/profiles`    | List all customer profiles for the session                     |
| `POST` | `/en/profile/GenerateOpenAiProfile` | Generate an AI-written professional profile summary            |


# Start E-Sign
Source: https://learn.nexudus.com/api/endpoints/proposals/esign-start

POST /api/public/proposals/{proposalId}/esign/start
Initiates the electronic signature process for a proposal.

# Start E-Sign

Initiates the electronic signature flow for a proposal. Returns an object containing the signature request identifier that can be used to launch the e-sign UI.

## Authentication

No authentication required — proposals are accessed via their unique identifier.

## Path Parameters

<ParamField type="string">
  The unique string identifier (GUID) of the proposal.
</ParamField>

## Request Body

No request body required.

## Response

<ResponseField name="Id" type="number">
  Signature request identifier.
</ResponseField>

<ResponseField name="Name" type="string">
  Name of the signature request.
</ResponseField>

## Examples

### Start e-sign

```http theme={null}
POST /api/public/proposals/abc123-def456/esign/start
```

```json theme={null}
{
  "Id": 42,
  "Name": "Membership Agreement"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.proposals.esign.start('abc123-def456').url)
```


# Accept Proposal
Source: https://learn.nexudus.com/api/endpoints/proposals/proposal-accept

PUT /api/public/proposals/{proposalId}/accept
Accepts a proposal on behalf of the recipient.

# Accept Proposal

Accepts the proposal, triggering any associated plan sign-ups, contract creation, and billing. This is the final step in the proposal flow after the recipient has reviewed and optionally e-signed the document.

## Authentication

Requires prior proposal login authentication.

## Path Parameters

<ParamField type="string">
  The unique string identifier (GUID) of the proposal.
</ParamField>

## Request Body

No request body required.

## Response

Returns the proposal file ID and an access token. The portal exchanges this token for a full auth session.

<ResponseField name="file" type="number">
  The numeric identifier of the proposal file.
</ResponseField>

<ResponseField name="accessToken" type="string">
  A token exchanged for a full auth session via `exchangeToken()`.
</ResponseField>

## Examples

### Accept a proposal

```http theme={null}
PUT /api/public/proposals/abc123-def456/accept
Authorization: Bearer {token}
```

```json theme={null}
{
  "file": 42,
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const result = await httpClient.put<{ file: number; accessToken: string }>(endpoints.proposals.accept('abc123-def456'))
await exchangeToken(result.data.accessToken)
```


# Get Proposal Details
Source: https://learn.nexudus.com/api/endpoints/proposals/proposal-details

GET /api/public/proposals/{proposalId}
Returns the full details of a proposal by its unique identifier.

# Get Proposal Details

Returns the full content and status of a specific proposal. Proposals are sent by operators to prospective or existing members and may include plan selections, terms, and pricing.

## Authentication

No authentication required — proposals are accessed via their unique identifier.

## Path Parameters

<ParamField type="string">
  The unique string identifier (GUID) of the proposal.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Tariff.Name,Price,Status,StartDate,Contracts,Products`.
</ParamField>

## Response

Returns a `ProposalData` object containing the proposal, associated invoices, and bill run information.

### Proposal

The top-level `Proposal` object has the following fields:

#### Identity

| Field       | Type     | Description                        |
| ----------- | -------- | ---------------------------------- |
| `Id`        | `number` | Unique identifier for the proposal |
| `UniqueId`  | `string` | GUID identifier                    |
| `Reference` | `string` | Proposal reference code            |

#### Status

| Field           | Type      | Description                                 |
| --------------- | --------- | ------------------------------------------- |
| `Status`        | `string`  | Current proposal status                     |
| `HasExpired`    | `boolean` | Whether the proposal has expired            |
| `HasFile`       | `boolean` | Whether a file is attached                  |
| `HasFileToSend` | `boolean` | Whether there is a file to send             |
| `HasFileToSign` | `boolean` | Whether there is a file requiring signature |
| `FileToSignId`  | `number?` | File-to-sign identifier                     |

#### Pricing

| Field                 | Type      | Description                     |
| --------------------- | --------- | ------------------------------- |
| `Price`               | `number?` | Base price amount               |
| `PriceFormatted`      | `string`  | Locale-formatted price          |
| `TotalPrice`          | `number`  | Total price including all items |
| `TotalPriceFormatted` | `string`  | Locale-formatted total price    |
| `Quantity`            | `number`  | Quantity                        |
| `ApplyProrating`      | `boolean` | Whether prorating is applied    |
| `DoNotIssueInvoice`   | `boolean` | Whether invoicing is suppressed |

#### Dates

| Field              | Type      | Description              |
| ------------------ | --------- | ------------------------ |
| `StartDate`        | `string?` | Contract start date      |
| `CancellationDate` | `string?` | Cancellation date        |
| `BillingDay`       | `number`  | Day of month for billing |

#### Content

| Field                 | Type     | Description               |
| --------------------- | -------- | ------------------------- |
| `Notes`               | `string` | Proposal notes            |
| `DiscountDescription` | `string` | Discount description text |
| `Desks`               | `string` | Assigned desks            |

#### Nested Objects

| Field         | Type                 | Description                       |
| ------------- | -------------------- | --------------------------------- |
| `IssuedBy`    | `Business`           | Business that issued the proposal |
| `Coworker`    | `Coworker`           | Coworker the proposal is for      |
| `Responsible` | `User`               | User responsible for the proposal |
| `Tariff`      | `Tariff`             | Associated plan/tariff            |
| `Contracts`   | `ProposalContract[]` | Contract schedule items           |
| `Products`    | `ProposalProduct[]`  | Products included in the proposal |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

### ProposalProduct

Each item in the `Products` array has:

| Field                 | Type      | Description                        |
| --------------------- | --------- | ---------------------------------- |
| `Id`                  | `number`  | Unique identifier                  |
| `Product`             | `Product` | Full product object (nested)       |
| `Price`               | `number`  | Price amount                       |
| `PriceFormatted`      | `string`  | Locale-formatted price             |
| `TotalPrice`          | `number?` | Total price                        |
| `TotalPriceFormatted` | `string`  | Locale-formatted total price       |
| `Quantity`            | `number`  | Quantity                           |
| `RegularCharge`       | `boolean` | Whether this is a recurring charge |
| `IsContractProduct`   | `boolean` | Whether tied to a contract         |
| `RepeatCycle`         | `string`  | Repeat cycle description           |
| `RepeatUnit`          | `number?` | Repeat unit                        |
| `InvoiceOn`           | `string?` | Next invoice date                  |
| `RepeatFrom`          | `string?` | Repeat start date                  |
| `RepeatUntil`         | `string?` | Repeat end date                    |

### Invoices

`Invoices` is an array of invoice preview objects associated with the proposal.

### BillRun

Each item in the `BillRun` array has:

| Field                | Type      | Description              |
| -------------------- | --------- | ------------------------ |
| `FullName`           | `string`  | Customer full name       |
| `FloorPlanDeskNames` | `string`  | Assigned desk names      |
| `PurchaseOrder`      | `string`  | Purchase order reference |
| `ItemId`             | `number`  | Item identifier          |
| `Type`               | `string`  | Charge type              |
| `Date`               | `string`  | Charge date              |
| `PeriodStart`        | `string`  | Billing period start     |
| `PeriodEnd`          | `string`  | Billing period end       |
| `Description`        | `string`  | Charge description       |
| `Total`              | `number`  | Charge total             |
| `TeamNames`          | `string`  | Associated team names    |
| `PayingMemberId`     | `number?` | Paying member identifier |

## Examples

### Fetch proposal details

```http theme={null}
GET /api/public/proposals/abc123-def456
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { ProposalData } from '@/types/public/billing/Proposal'

const { resource: proposalData } = useTypedData(httpClient, endpoints.proposals.one('abc123-def456'))
// Access: proposalData.Proposal, proposalData.Invoices, proposalData.BillRun
```


# Proposal Login
Source: https://learn.nexudus.com/api/endpoints/proposals/proposal-login

PUT /api/public/proposals/{proposalId}/login
Authenticates a user to view and interact with a proposal.

# Proposal Login

Authenticates a user to access a specific proposal. Used when proposals require email verification before the recipient can view or accept them.

## Authentication

No prior authentication required.

## Path Parameters

<ParamField type="string">
  The unique string identifier (GUID) of the proposal.
</ParamField>

## Request Body

<ParamField type="string">
  Email address of the proposal recipient for verification.
</ParamField>

## Response

Returns the proposal file ID and an access token for subsequent proposal interactions.

<ResponseField name="file" type="number">
  The numeric identifier of the proposal file.
</ResponseField>

<ResponseField name="accessToken" type="string">
  A token used to authenticate further proposal actions (e.g. accepting the proposal). Exchanged for a full auth session via `exchangeToken()`.
</ResponseField>

## Examples

### Login to view a proposal

```http theme={null}
PUT /api/public/proposals/abc123-def456/login
Content-Type: application/json

{
  "Email": "member@example.com"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.proposals.login('abc123-def456'), {
  Email: 'member@example.com',
})
```


# Resource Details List
Source: https://learn.nexudus.com/api/endpoints/resources/resource-details

GET /api/public/resources/published/details
Returns detailed information for all published resources.

# Resource Details List

Returns full details for all published resources at the current location, including configuration, pricing, and availability metadata. Used to render the resources catalogue.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,ResourceTypeName,Capacity,Visible`.
</ParamField>

## Response

Returns a `PublicResources` object containing an array of resource records with full detail.

### Resource Fields

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the resource |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Core

| Field                | Type      | Description                              |
| -------------------- | --------- | ---------------------------------------- |
| `Name`               | `string`  | Resource display name (localised)        |
| `Description`        | `string`  | Resource description (localised)         |
| `GroupName`          | `string`  | Resource group name                      |
| `ResourceTypeName`   | `string`  | Resource type display name (localised)   |
| `Visible`            | `boolean` | Whether the resource is publicly visible |
| `DisplayOrder`       | `number`  | Sort order in listings                   |
| `SystemResourceType` | `number`  | Internal resource type identifier        |

#### Location

| Field                | Type             | Description           |
| -------------------- | ---------------- | --------------------- |
| `BusinessId`         | `number`         | Location identifier   |
| `BusinessName`       | `string`         | Location display name |
| `BusinessWebAddress` | `string`         | Location subdomain    |
| `Longitude`          | `number \| null` | Longitude coordinate  |
| `Latitude`           | `number \| null` | Latitude coordinate   |

#### Capacity & Booking Rules

| Field                              | Type             | Description                                    |
| ---------------------------------- | ---------------- | ---------------------------------------------- |
| `Allocation`                       | `number \| null` | Maximum concurrent bookings                    |
| `AllowMultipleBookings`            | `boolean`        | Whether multiple bookings are allowed          |
| `RequiresConfirmation`             | `boolean`        | Whether bookings require admin confirmation    |
| `BookInAdvanceLimit`               | `number \| null` | Max days in advance a booking can be made      |
| `LateBookingLimit`                 | `number \| null` | Min hours before a booking can start           |
| `LateCancellationLimit`            | `number \| null` | Min hours before booking for free cancellation |
| `IntervalLimit`                    | `number \| null` | Required gap between bookings (minutes)        |
| `MaxBookingLength`                 | `number \| null` | Maximum booking duration (minutes)             |
| `MinBookingLength`                 | `number \| null` | Minimum booking duration (minutes)             |
| `NoReturnPolicy`                   | `number \| null` | Hours before same resource can be rebooked     |
| `NoReturnPolicyAllResources`       | `number \| null` | Hours before any resource can be rebooked      |
| `NoReturnPolicyAllUsers`           | `number \| null` | Hours before any user can rebook               |
| `RepeatBookingQuantityLimit`       | `number \| null` | Max quantity for repeat bookings               |
| `RepeatBookingPeriodLimitInMonths` | `number \| null` | Max period for repeat bookings (months)        |

#### Amenities

| Field                  | Type      | Description               |
| ---------------------- | --------- | ------------------------- |
| `Projector`            | `boolean` | Has projector             |
| `Internet`             | `boolean` | Has internet              |
| `ConferencePhone`      | `boolean` | Has conference phone      |
| `StandardPhone`        | `boolean` | Has standard phone        |
| `WhiteBoard`           | `boolean` | Has whiteboard            |
| `LargeDisplay`         | `boolean` | Has large display         |
| `Catering`             | `boolean` | Has catering              |
| `TeaAndCoffee`         | `boolean` | Has tea and coffee        |
| `Drinks`               | `boolean` | Has drinks                |
| `SecurityLock`         | `boolean` | Has security lock         |
| `CCTV`                 | `boolean` | Has CCTV                  |
| `VoiceRecorder`        | `boolean` | Has voice recorder        |
| `AirConditioning`      | `boolean` | Has air conditioning      |
| `Heating`              | `boolean` | Has heating               |
| `NaturalLight`         | `boolean` | Has natural light         |
| `StandingDesk`         | `boolean` | Has standing desk         |
| `QuietZone`            | `boolean` | Is in a quiet zone        |
| `WirelessCharger`      | `boolean` | Has wireless charger      |
| `PrivacyScreen`        | `boolean` | Has privacy screen        |
| `VideoConferencing`    | `boolean` | Has video conferencing    |
| `DualDisplayScreen`    | `boolean` | Has dual display screens  |
| `DisplayScreen`        | `boolean` | Has display screen        |
| `WirelessPresentation` | `boolean` | Has wireless presentation |
| `PaSystem`             | `boolean` | Has PA system             |
| `DesktopMonitor`       | `boolean` | Has desktop monitor       |
| `FlipChart`            | `boolean` | Has flip chart            |
| `SecureStorage`        | `boolean` | Has secure storage        |
| `Soundproof`           | `boolean` | Is soundproofed           |

#### Media & Floor Plan

| Field            | Type             | Description                         |
| ---------------- | ---------------- | ----------------------------------- |
| `HasImage`       | `boolean`        | Whether the resource has an image   |
| `FloorPlanDesks` | `object[]`       | Available floor plan desk positions |
| `FloorPlanId`    | `number \| null` | Floor plan identifier               |

#### Availability (computed)

| Field            | Type      | Description                   |
| ---------------- | --------- | ----------------------------- |
| `IsAvailable`    | `boolean` | Whether currently available   |
| `AvailableUnits` | `number`  | Number of available units     |
| `Price`          | `number`  | Computed booking price        |
| `PriceFormatted` | `string`  | Price formatted with currency |
| `Message`        | `string`  | Availability message          |
| `ErrorCode`      | `string`  | Error code if unavailable     |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch resource details

```http theme={null}
GET /api/public/resources/published/details
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: resources } = useTypedData(httpClient, endpoints.resources.details())
```


# Get Resource
Source: https://learn.nexudus.com/api/endpoints/resources/resource-one

GET /api/public/resources/published/{resourceId}
Returns the full details for a single published resource.

# Get Resource

Returns the complete details for a single published resource, including configuration, pricing, images, and custom fields.

## Authentication

No authentication required.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the resource.
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,Description,ResourceTypeName,Price,PriceFormatted,Allocation`.
</ParamField>

## Response

Returns a `Resource` object with the full resource configuration. See [Resource Details](/api/endpoints/resources/resource-details) for the complete field reference.

#### Identity

| Field         | Type     | Description                                  |
| ------------- | -------- | -------------------------------------------- |
| `Id`          | `number` | Unique identifier for the resource           |
| `UniqueId`    | `string` | GUID identifier                              |
| `Name`        | `string` | Display name of the resource                 |
| `Description` | `string` | Full resource description (may contain HTML) |

#### Core

| Field                | Type           | Description                       |
| -------------------- | -------------- | --------------------------------- |
| `ResourceTypeName`   | `string`       | Resource type name                |
| `ResourceType`       | `ResourceType` | Resource type object (nested)     |
| `GroupName`          | `string`       | Group name for categorisation     |
| `SystemResourceType` | `number`       | Internal resource type identifier |
| `Visible`            | `boolean`      | Whether the resource is visible   |
| `DisplayOrder`       | `number`       | Sort order for display            |
| `HasImage`           | `boolean`      | Whether the resource has an image |
| `Message`            | `string`       | Custom message for the resource   |

#### Location

| Field                | Type      | Description          |
| -------------------- | --------- | -------------------- |
| `BusinessId`         | `number`  | Business identifier  |
| `BusinessName`       | `string`  | Business name        |
| `BusinessWebAddress` | `string`  | Business web address |
| `Longitude`          | `number?` | GPS longitude        |
| `Latitude`           | `number?` | GPS latitude         |

#### Pricing

| Field            | Type     | Description            |
| ---------------- | -------- | ---------------------- |
| `Price`          | `number` | Base price             |
| `PriceFormatted` | `string` | Locale-formatted price |

#### Capacity & Booking Rules

| Field                              | Type      | Description                             |
| ---------------------------------- | --------- | --------------------------------------- |
| `Allocation`                       | `number?` | Maximum capacity                        |
| `AllowMultipleBookings`            | `boolean` | Whether multiple bookings are allowed   |
| `RequiresConfirmation`             | `boolean` | Whether bookings require confirmation   |
| `BookInAdvanceLimit`               | `number?` | How far in advance bookings can be made |
| `LateBookingLimit`                 | `number?` | Latest a booking can be made            |
| `LateCancellationLimit`            | `number?` | Cancellation deadline                   |
| `IntervalLimit`                    | `number?` | Minimum interval between bookings       |
| `MaxBookingLength`                 | `number?` | Maximum booking duration                |
| `MinBookingLength`                 | `number?` | Minimum booking duration                |
| `NoReturnPolicy`                   | `number?` | No-return policy value                  |
| `RepeatBookingQuantityLimit`       | `number?` | Repeat booking quantity limit           |
| `RepeatBookingPeriodLimitInMonths` | `number?` | Repeat booking period limit             |

#### Amenities

| Field                  | Type      | Description               |
| ---------------------- | --------- | ------------------------- |
| `Projector`            | `boolean` | Has projector             |
| `Internet`             | `boolean` | Has internet              |
| `ConferencePhone`      | `boolean` | Has conference phone      |
| `StandardPhone`        | `boolean` | Has standard phone        |
| `WhiteBoard`           | `boolean` | Has whiteboard            |
| `LargeDisplay`         | `boolean` | Has large display         |
| `Catering`             | `boolean` | Catering available        |
| `TeaAndCoffee`         | `boolean` | Tea and coffee available  |
| `Drinks`               | `boolean` | Drinks available          |
| `SecurityLock`         | `boolean` | Has security lock         |
| `CCTV`                 | `boolean` | Has CCTV                  |
| `VoiceRecorder`        | `boolean` | Has voice recorder        |
| `AirConditioning`      | `boolean` | Has air conditioning      |
| `Heating`              | `boolean` | Has heating               |
| `NaturalLight`         | `boolean` | Has natural light         |
| `StandingDesk`         | `boolean` | Has standing desk         |
| `QuietZone`            | `boolean` | Is a quiet zone           |
| `WirelessCharger`      | `boolean` | Has wireless charger      |
| `PrivacyScreen`        | `boolean` | Has privacy screen        |
| `VideoConferencing`    | `boolean` | Has video conferencing    |
| `DualDisplayScreen`    | `boolean` | Has dual display screen   |
| `DisplayScreen`        | `boolean` | Has display screen        |
| `WirelessPresentation` | `boolean` | Has wireless presentation |
| `PaSystem`             | `boolean` | Has PA system             |
| `DesktopMonitor`       | `boolean` | Has desktop monitor       |
| `FlipChart`            | `boolean` | Has flip chart            |
| `SecureStorage`        | `boolean` | Has secure storage        |
| `Soundproof`           | `boolean` | Is soundproof             |

#### Availability

| Field              | Type      | Description                                 |
| ------------------ | --------- | ------------------------------------------- |
| `IsAvailable`      | `boolean` | Whether the resource is currently available |
| `AvailableUnits`   | `number`  | Number of available units                   |
| `Shifts`           | `Shift[]` | Available shift definitions                 |
| `ShiftsExpression` | `string`  | Shift schedule expression                   |
| `LastCleanedAt`    | `string?` | When the resource was last cleaned          |

#### Floor Plan

| Field            | Type              | Description             |
| ---------------- | ----------------- | ----------------------- |
| `FloorPlanDesks` | `FloorPlanDesk[]` | Floor plan desk objects |
| `FloorPlanId`    | `number?`         | Floor plan identifier   |
| `CustomFields`   | `CustomField[]`   | Custom field values     |

#### Timestamps (from base)

| Field          | Type     | Description                          |
| -------------- | -------- | ------------------------------------ |
| `CreatedOn`    | `string` | Record creation timestamp (local)    |
| `UpdatedOn`    | `string` | Record last-update timestamp (local) |
| `CreatedOnUtc` | `string` | Record creation timestamp (UTC)      |
| `UpdatedOnUtc` | `string` | Record last-update timestamp (UTC)   |

## Examples

### Fetch a resource

```http theme={null}
GET /api/public/resources/published/88
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: res } = useTypedData(httpClient, endpoints.resources.one(88))
```


# Resource Search Fields
Source: https://learn.nexudus.com/api/endpoints/resources/resource-search-fields

GET /api/public/resources/fields/searchable
Returns the custom fields available for filtering resources.

# Resource Search Fields

Returns the list of custom fields that the operator has made searchable for resources. Used to build dynamic filter UIs on the booking/resource pages.

## Authentication

No authentication required.

## Response

<ResponseField name="Fields" type="ResourceCustomField[]">
  Array of searchable custom field definitions.
</ResponseField>

## Examples

### Fetch searchable fields

```http theme={null}
GET /api/public/resources/fields/searchable
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: fields } = useTypedData(httpClient, endpoints.resources.searchFields())
```


# Resource Summary
Source: https://learn.nexudus.com/api/endpoints/resources/resource-summary

GET /api/public/resources/published/summary
Returns a summary list of all published resources.

# Resource Summary

Returns a lightweight summary of all published resources (desks, meeting rooms, offices, etc.) for the current location. Used for resource selectors and quick listings where full detail is not needed.

## Authentication

No authentication required.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,ResourceTypeName,Id`.
</ParamField>

## Response

Returns a `ResourceSummaries` object containing a lightweight summary of each published resource.

### Resource Summary Fields

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the resource |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Core

| Field              | Type      | Description                              |
| ------------------ | --------- | ---------------------------------------- |
| `Name`             | `string`  | Resource display name (localised)        |
| `Description`      | `string`  | Resource description (localised)         |
| `GroupName`        | `string`  | Resource group name                      |
| `ResourceTypeName` | `string`  | Resource type display name (localised)   |
| `Visible`          | `boolean` | Whether the resource is publicly visible |
| `DisplayOrder`     | `number`  | Sort order in listings                   |

#### Location

| Field                | Type     | Description           |
| -------------------- | -------- | --------------------- |
| `BusinessId`         | `number` | Location identifier   |
| `BusinessName`       | `string` | Location display name |
| `BusinessWebAddress` | `string` | Location subdomain    |

#### Media

| Field      | Type      | Description                       |
| ---------- | --------- | --------------------------------- |
| `HasImage` | `boolean` | Whether the resource has an image |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch resource summaries

```http theme={null}
GET /api/public/resources/published/summary
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: summaries } = useTypedData(httpClient, endpoints.resources.summary())
```


# List Sensors
Source: https://learn.nexudus.com/api/endpoints/sensors/list-sensors

GET /api/public/sensors
Returns the sensor data for the current location.

# List Sensors

Returns the list of IoT sensors and their current readings for the current location. Used to display environmental data (temperature, humidity, occupancy) on the dashboard.

## Authentication

Requires a valid customer bearer token.

## Response

Returns an array of sensor objects with current readings.

## Examples

### Fetch sensor data

```http theme={null}
GET /api/public/sensors
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.sensors.list)
```


# Get Multiple Settings
Source: https://learn.nexudus.com/api/endpoints/settings/get-many-settings

GET /api/public/settings/values/{names}
Returns multiple portal settings by comma-separated names.

# Get Multiple Settings

Returns multiple portal configuration settings in a single request. Setting names are provided as a comma-separated list.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="string">
  Comma-separated setting names. URL-encoded.
</ParamField>

## Response

<ResponseField name="Settings" type="Setting[]">
  Array of requested settings.
</ResponseField>

<ResponseField name="Settings[].Name" type="string">
  Setting name/key.
</ResponseField>

<ResponseField name="Settings[].Value" type="string">
  Setting value.
</ResponseField>

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: settings } = useTypedData(httpClient, endpoints.settings.getMany(['BookingMinDuration', 'BookingMaxDuration']))
```


# Get Setting
Source: https://learn.nexudus.com/api/endpoints/settings/get-setting

GET /api/public/settings/value/{name}
Returns a single portal setting by name.

# Get Setting

Returns the value of a specific portal configuration setting.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="string">
  The setting name/key. URL-encoded.
</ParamField>

## Response

<ResponseField name="Name" type="string">
  Setting name/key.
</ResponseField>

<ResponseField name="Value" type="string">
  Setting value.
</ResponseField>

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: setting } = useTypedData(httpClient, endpoints.settings.get('BookingMinDuration'))
```


# Search Settings
Source: https://learn.nexudus.com/api/endpoints/settings/search-settings

GET /api/public/settings/search
Searches portal settings by keyword.

# Search Settings

Searches the portal configuration settings by keyword. Returns matching setting name/value pairs.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Keyword to search for in setting names. URL-encoded.
</ParamField>

## Response

<ResponseField name="Settings" type="Setting[]">
  Array of matching settings.
</ResponseField>

<ResponseField name="Settings[].Name" type="string">
  Setting name/key.
</ResponseField>

<ResponseField name="Settings[].Value" type="string">
  Setting value.
</ResponseField>

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: results } = useTypedData(httpClient, endpoints.settings.search('booking'))
```


# Update Multiple Settings
Source: https://learn.nexudus.com/api/endpoints/settings/update-many-settings

PUT /api/public/settings/values/{coworkerId}
Updates multiple portal settings at once for a specific customer.

# Update Multiple Settings

Updates multiple portal configuration settings in a single request for a specific customer.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the customer to update settings for.
</ParamField>

## Request Body

Array or object of setting name/value pairs to update.

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.settings.setMany(42), settingsData)
```


# Update Setting
Source: https://learn.nexudus.com/api/endpoints/settings/update-setting

POST /api/public/settings/value/{name}
Updates a single portal setting value.

# Update Setting

Updates the value of a specific portal configuration setting for the authenticated customer's context.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="string">
  The setting name/key to update. URL-encoded.
</ParamField>

## Request Body

<ParamField type="string">
  The new value for the setting.
</ParamField>

## Response

Returns a `200 OK` on success.

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.post(endpoints.settings.set('PreferredLanguage'), {
  Value: 'en',
})
```


# Get Business Colors
Source: https://learn.nexudus.com/api/endpoints/system/business-colors

GET /api/sys/businesses/{businessId}/colors
Retrieve the custom brand color palette configured for a specific Nexudus location.

# Get Business Colors

Returns a key-value map of colour tokens configured for a specific location. The portal uses these values to apply the operator's brand palette at runtime, overriding the default theme. Colours are stored as CSS-compatible hex or RGB strings.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  The numeric identifier of the location whose colour palette you want to retrieve.
</ParamField>

## Response

Returns a flat `Record<string, string>` object where each key is a colour token name and each value is a CSS colour string.

```json theme={null}
{
  "primaryColor": "#ff5100",
  "secondaryColor": "#001279",
  "backgroundColor": "#F9FAFB",
  "textColor": "#111827"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'

const endpoint = endpoints.system.colors(businessId)
// endpoint.type is Record<string, string>

const { resource: colors } = useTypedData(httpClient, endpoint)
```

## Usage in Portal

| Context                             | Source file                                |
| ----------------------------------- | ------------------------------------------ |
| Location branding / theme injection | `src/states/useLocationByRouteContext.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No location with the given `businessId` was found.
</ResponseField>

## Related Endpoints

| Method | Endpoint                         | Description                          |
| ------ | -------------------------------- | ------------------------------------ |
| `GET`  | `/api/public/businesses/current` | Get the current location details     |
| `GET`  | `/api/public/configuration`      | Get portal configuration for a space |


# Get Current Business
Source: https://learn.nexudus.com/api/endpoints/system/business-current

GET /api/public/businesses/current
Retrieve the full profile and configuration for the Nexudus location associated with the current portal session.

# Get Current Business

Returns the full details of the Nexudus location (business) that the current portal session is operating under. This is the primary bootstrap call the portal makes when the application loads. The response drives theming, feature flags, localisation, and all location-specific configuration.

## Authentication

Requires a valid customer bearer token, or can return public data for unauthenticated sessions depending on location configuration.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,WebAddress,Currency.Code,TimeZone`.
</ParamField>

## Response

Returns a `Business` object. Key fields are described below.

### Identity

<ResponseField name="Id" type="number">
  Unique numeric identifier for the location.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  Globally unique identifier (GUID) for the location. Used in floor plan and booking requests.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the coworking space.
</ResponseField>

<ResponseField name="WebAddress" type="string">
  The subdomain identifier used in API requests (e.g. `"myspace"` in `myspace.spaces.nexudus.com`).
</ResponseField>

### Localisation

<ResponseField name="Currency" type="object">
  Currency object for the location.
</ResponseField>

<ResponseField name="Currency.Code" type="string">
  ISO 4217 currency code (e.g. `"GBP"`, `"USD"`, `"EUR"`).
</ResponseField>

<ResponseField name="Currency.Name" type="string">
  Display name of the currency (e.g. `"British Pound"`).
</ResponseField>

<ResponseField name="Currency.Format" type="string">
  Currency format string.
</ResponseField>

<ResponseField name="LanguageCulture" type="string">
  Default BCP 47 culture string for the location (e.g. `"en-GB"`).
</ResponseField>

<ResponseField name="TimeZone" type="string">
  IANA time zone identifier for the location (e.g. `"Europe/London"`).
</ResponseField>

### Contact

<ResponseField name="Address" type="string">
  Street address of the location.
</ResponseField>

<ResponseField name="TownCity" type="string">
  City or town where the location is based.
</ResponseField>

<ResponseField name="PostalCode" type="string">
  Postal code of the location.
</ResponseField>

<ResponseField name="Country" type="object">
  Country object with `Id`, `Name`, and `TwoDigitsCode` fields.
</ResponseField>

### Portal URLs

<ResponseField name="NativeHomeUrl" type="string">
  Base URL of the Nexudus backend for this location (used to build authenticated redirects).
</ResponseField>

<ResponseField name="NativeHomeUrlWithLanguage" type="string">
  Base URL including the default language prefix (e.g. `/en`). Used for authenticated redirect links.
</ResponseField>

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'
import { Business } from '@/types/Business'

const { resource: business } = useData<Business>(httpClient, endpoints.system.business.current)
```

## Usage in Portal

| Context                                   | Source file                                |
| ----------------------------------------- | ------------------------------------------ |
| Location context provider (app bootstrap) | `src/states/useLocationByRouteContext.tsx` |
| Business details throughout the portal    | `src/states/useLocationByHostContext.tsx`  |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  Authentication is required and no valid token was supplied.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No location could be resolved for the current session context.
</ResponseField>

## Related Endpoints

| Method | Endpoint                              | Description                                   |
| ------ | ------------------------------------- | --------------------------------------------- |
| `GET`  | `/api/public/configuration`           | Get portal feature configuration              |
| `GET`  | `/api/public/businesses/all`          | List all locations in the network             |
| `GET`  | `/api/public/businesses/withVisitors` | List locations that have visitor registration |
| `GET`  | `/api/public/businesses/withTour`     | List locations that offer space tours         |


# List All Businesses
Source: https://learn.nexudus.com/api/endpoints/system/business-list

GET /api/public/businesses/all
Retrieve all Nexudus locations in the network, with options to include the root organisation and hidden locations.

# List All Businesses

Returns all locations (businesses) within the Nexudus network, optionally including the root organisation entry and locations that have been hidden from public views. Used by multi-location portals to build location pickers and network-wide navigation.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  When `true`, the root organisation entry is included in the response alongside individual locations.
</ParamField>

<ParamField type="boolean">
  When `true`, locations that have been marked as hidden (not publicly listed) are included in the results.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Name,WebAddress,Address,TownCity`.
</ParamField>

## Response

Returns an array of location objects. Each entry follows the same shape as the `GET /api/public/businesses/current` response.

### Business Fields

#### Identity

| Field      | Type     | Description                                |
| ---------- | -------- | ------------------------------------------ |
| `Id`       | `number` | Unique numeric identifier for the location |
| `UniqueId` | `string` | Globally unique identifier                 |

#### Core

| Field               | Type     | Description                             |
| ------------------- | -------- | --------------------------------------- |
| `Name`              | `string` | Display name of the coworking space     |
| `WebAddress`        | `string` | Subdomain identifier (e.g. `"myspace"`) |
| `Address`           | `string` | Street address                          |
| `TownCity`          | `string` | Town or city                            |
| `State`             | `string` | State or province                       |
| `Phone`             | `string` | Phone number                            |
| `Fax`               | `string` | Fax number                              |
| `EmailContact`      | `string` | Contact email address                   |
| `WebContact`        | `string` | Contact website URL                     |
| `Quote`             | `string` | Location tagline / quote                |
| `AboutUs`           | `string` | About Us text                           |
| `ShortIntroduction` | `string` | Short intro text                        |

#### Localisation

| Field            | Type     | Description                                    |
| ---------------- | -------- | ---------------------------------------------- |
| `Country`        | `object` | Country object (`Id`, `Name`, `TwoDigitsCode`) |
| `Currency`       | `object` | Currency object (`Code`, `Name`, `Format`)     |
| `SimpleTimeZone` | `object` | Timezone object                                |

#### Location

| Field       | Type             | Description          |
| ----------- | ---------------- | -------------------- |
| `Longitude` | `number \| null` | Longitude coordinate |
| `Latitude`  | `number \| null` | Latitude coordinate  |

#### Branding

| Field              | Type      | Description                   |
| ------------------ | --------- | ----------------------------- |
| `HasLogo`          | `boolean` | Whether location has a logo   |
| `HasBanner`        | `boolean` | Whether location has a banner |
| `CurrentThemeName` | `string`  | Active theme name             |

#### Policies

| Field                | Type     | Description          |
| -------------------- | -------- | -------------------- |
| `CookiePolicyUrl`    | `string` | Cookie policy URL    |
| `PrivacyPolicyUrl`   | `string` | Privacy policy URL   |
| `TermsAndConditions` | `string` | Terms and conditions |

#### Network

| Field             | Type             | Description                      |
| ----------------- | ---------------- | -------------------------------- |
| `IsChildLocation` | `boolean`        | Whether this is a child location |
| `RootBusinessId`  | `number \| null` | Parent location identifier       |
| `Businesses`      | `object[]`       | Child locations (if any)         |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

````

## TypeScript Integration

```typescript
import endpoints from '@/api/endpoints'

const url = endpoints.system.business.businesses(false, false)
// => '/api/public/businesses/all?includeRoot=false&includeHidden=false'

const response = await httpClient.get(url)
````

## Usage in Portal

| Context                                  | Source file                        |
| ---------------------------------------- | ---------------------------------- |
| Multi-location switcher / network picker | `src/components/LocationSwitcher/` |
| Passport / map view                      | `src/views/passport/`              |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                              | Description                                     |
| ------ | ------------------------------------- | ----------------------------------------------- |
| `GET`  | `/api/public/businesses/current`      | Get the current location                        |
| `GET`  | `/api/public/businesses/withVisitors` | Get locations with visitor registration enabled |
| `GET`  | `/api/public/businesses/withTour`     | Get locations that offer space tours            |


# List Businesses with Tour
Source: https://learn.nexudus.com/api/endpoints/system/business-with-tour

GET /api/public/businesses/withTour
Retrieve all Nexudus locations that have the space tour booking feature enabled.

# List Businesses with Tour

Returns all locations in the network where the space tour feature is active. The portal uses this to determine which locations a prospective member can book a tour at, and to build location pickers in the tour booking flow.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Businesses.Name,Businesses.WebAddress`.
</ParamField>

## Response

<ResponseField name="Businesses" type="array">
  Array of location objects for locations that have the tour feature enabled.
</ResponseField>

<ResponseField name="Businesses[].Id" type="number">
  Unique numeric identifier for the location.
</ResponseField>

<ResponseField name="Businesses[].UniqueId" type="string">
  Globally unique identifier (GUID) for the location.
</ResponseField>

<ResponseField name="Businesses[].Name" type="string">
  Display name of the location.
</ResponseField>

<ResponseField name="Businesses[].WebAddress" type="string">
  Subdomain identifier for the location (e.g. `"myspace"`).
</ResponseField>

## Example Response

```json theme={null}
{
  "Businesses": [
    {
      "Id": 1,
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "Name": "Main Location",
      "WebAddress": "mainlocation"
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'
import { AllLocations } from '@/types/AllLocations'

const endpoint = endpoints.system.business.withTour()
// endpoint.type is { Businesses: AllLocations[] }

const { resource } = useTypedData(httpClient, endpoint)
const tourLocations = resource?.Businesses ?? []
```

## Usage in Portal

| Context                            | Source file                         |
| ---------------------------------- | ----------------------------------- |
| Space tour booking location picker | `src/views/tours/` or checkout flow |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                              | Description                              |
| ------ | ------------------------------------- | ---------------------------------------- |
| `GET`  | `/api/public/businesses/current`      | Get the current location                 |
| `GET`  | `/api/public/businesses/all`          | List all locations in the network        |
| `GET`  | `/api/public/businesses/withVisitors` | List locations with visitor registration |


# List Businesses with Visitor Registration
Source: https://learn.nexudus.com/api/endpoints/system/business-with-visitors

GET /api/public/businesses/withVisitors
Retrieve all Nexudus locations that have the visitor registration feature enabled.

# List Businesses with Visitor Registration

Returns all locations in the network where the visitor registration feature is active. The portal uses this to determine which locations a member can register a visitor for, and to build location pickers in the visitor registration flow.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Businesses.Name,Businesses.WebAddress`.
</ParamField>

## Response

<ResponseField name="Businesses" type="array">
  Array of location objects for locations that have visitor registration enabled.
</ResponseField>

<ResponseField name="Businesses[].Id" type="number">
  Unique numeric identifier for the location.
</ResponseField>

<ResponseField name="Businesses[].UniqueId" type="string">
  Globally unique identifier (GUID) for the location.
</ResponseField>

<ResponseField name="Businesses[].Name" type="string">
  Display name of the location.
</ResponseField>

<ResponseField name="Businesses[].WebAddress" type="string">
  Subdomain identifier for the location (e.g. `"myspace"`).
</ResponseField>

## Example Response

```json theme={null}
{
  "Businesses": [
    {
      "Id": 1,
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "Name": "Main Location",
      "WebAddress": "mainlocation"
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'
import { AllLocations } from '@/types/AllLocations'

const endpoint = endpoints.system.business.withVisitors()
// endpoint.type is { Businesses: AllLocations[] }

const { resource } = useTypedData(httpClient, endpoint)
const businesses = resource?.Businesses ?? []
```

## Usage in Portal

| Context                              | Source file           |
| ------------------------------------ | --------------------- |
| Visitor registration location picker | `src/views/visitors/` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                          | Description                                     |
| ------ | --------------------------------- | ----------------------------------------------- |
| `GET`  | `/api/public/businesses/current`  | Get the current location                        |
| `GET`  | `/api/public/businesses/all`      | List all locations in the network               |
| `GET`  | `/api/public/businesses/withTour` | List locations offering space tours             |
| `GET`  | `api/public/visitors/my`          | List the current customer's registered visitors |


# Complete Password Reset
Source: https://learn.nexudus.com/api/endpoints/system/complete-password-reset

POST /api/sys/users/completePasswordReset
Set a new password for a customer account using the token received in the password-reset email.

# Complete Password Reset

Validates the one-time reset token sent to the customer's email and sets the new password. On success, Nexudus returns a JWT that the portal immediately exchanges for a bearer token, signing the customer in automatically without an extra login step.

## Authentication

No authentication required. The `token` in the request body acts as the credential.

## Request Body

<ParamField type="string">
  The one-time reset token extracted from the password-reset link sent to the customer's email. This token is single-use and expires after a short
  period.
</ParamField>

<ParamField type="string">
  The new password the customer wants to set. Must satisfy the location's password policy.
</ParamField>

<ParamField type="number">
  The numeric ID of the business/location. Obtained from the current location context.
</ParamField>

## Response

Returns an `ActionConfirmation` envelope. On success, `Value` contains a JWT that can be exchanged for a bearer token via `POST /api/sys/users/exchange`.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the password was changed successfully.
</ResponseField>

<ResponseField name="Value" type="string | null">
  One-time JWT to exchange for a bearer token via `POST /api/sys/users/exchange`. Pass this directly to `endpoints.system.auth.login(Value)`.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message or error description.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation errors object. `null` on success.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0MiIsImV4cCI6MTcw...",
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { ActionConfirmation } from '@/types/ActionConfirmation'

const url = endpoints.system.users.completePasswordReset
// => '/api/sys/users/completePasswordReset'

const response = await httpClient.post<ActionConfirmation>(url, {
  Token: resetToken,
  Password: newPassword,
  BusinessId: business.Id,
})

if (response.data.WasSuccessful && response.data.Value) {
  // Exchange the JWT for a bearer token and sign the customer in
  const exchangeUrl = endpoints.system.auth.login(response.data.Value)
  await httpClient.post(exchangeUrl)
}
```

## Usage in Portal

| Context                    | Source file                     |
| -------------------------- | ------------------------------- |
| Reset password page / flow | `src/views/auth/ResetPassword/` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The token is invalid, expired, or already used. The customer must restart the password-reset flow via `POST /api/sys/users/startPasswordReset`.
</ResponseField>

<ResponseField name="400 Bad Request — password policy" type="error">
  The new password does not meet the location's password requirements. Check `Errors` in the response body.
</ResponseField>

## Related Endpoints

| Method | Endpoint                            | Description                                  |
| ------ | ----------------------------------- | -------------------------------------------- |
| `POST` | `/api/sys/users/startPasswordReset` | Trigger the password-reset email             |
| `POST` | `/api/sys/users/exchange`           | Exchange the returned JWT for a bearer token |
| `POST` | `/api/token`                        | Standard credential-based sign-in            |


# List Countries
Source: https://learn.nexudus.com/api/endpoints/system/countries

GET /api/public/countries
Retrieve the full list of countries supported by the Nexudus platform, including culture codes and ISO identifiers.

# List Countries

Returns all countries supported by the Nexudus platform. Used by address and profile forms across the portal to populate country dropdowns and map culture codes to display names.

## Authentication

No authentication required. This is a public endpoint.

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Countries.Name,Countries.TwoDigitsCode`.
</ParamField>

## Response

<ResponseField name="Countries" type="array">
  Array of country objects.
</ResponseField>

<ResponseField name="Countries[].Id" type="number">
  Numeric identifier for the country.
</ResponseField>

<ResponseField name="Countries[].Name" type="string">
  Display name of the country in English.
</ResponseField>

<ResponseField name="Countries[].TwoDigitsCode" type="string">
  ISO 3166-1 alpha-2 two-letter country code (e.g. `"GB"`, `"US"`, `"DE"`).
</ResponseField>

<ResponseField name="Countries[].Culture" type="string">
  BCP 47 culture/locale string for the country (e.g. `"en-GB"`, `"en-US"`, `"de-DE"`).
</ResponseField>

## Example Response

```json theme={null}
{
  "Countries": [
    {
      "Id": 1,
      "Name": "United Kingdom",
      "TwoDigitsCode": "GB",
      "Culture": "en-GB"
    },
    {
      "Id": 2,
      "Name": "United States",
      "TwoDigitsCode": "US",
      "Culture": "en-US"
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'

const endpoint = endpoints.system.countries
// endpoint.type is { Countries: { Culture: string; Id: number; Name: string; TwoDigitsCode: string }[] }

const { resource } = useTypedData(httpClient, endpoint)
const countries = resource?.Countries ?? []
```

## Usage in Portal

| Context                          | Source file                |
| -------------------------------- | -------------------------- |
| Profile / address country picker | `src/views/profile/`       |
| Checkout country selector        | `src/views/checkout/`      |
| Virtual Office form              | `src/views/virtualOffice/` |

## Error Responses

<ResponseField name="500 Internal Server Error" type="error">
  Unexpected server-side error. Retry with exponential back-off.
</ResponseField>

## Related Endpoints

| Method | Endpoint                         | Description              |
| ------ | -------------------------------- | ------------------------ |
| `GET`  | `/api/public/businesses/current` | Get the current location |
| `GET`  | `/api/public/configuration`      | Get portal configuration |


# Get Enum Values
Source: https://learn.nexudus.com/api/endpoints/system/enum-values

GET /api/utils/enums
Retrieve the list of valid values for a named Nexudus enumeration type.

# Get Enum Values

Returns all valid values for a named Nexudus enumeration. Enums are used throughout the platform to represent fixed sets of choices — for example, invoice status, resource types, booking states, or delivery status. The portal uses this endpoint to build dropdowns and validate field values dynamically.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  The name of the enumeration to retrieve. This must match the exact server-side enum name (e.g. `"InvoiceStatus"`, `"ResourceType"`).
</ParamField>

## Response

Returns an array of enum entry objects. The exact shape depends on the enum requested, but each entry typically includes:

<ResponseField name="Id" type="number">
  Numeric value of the enum entry (as stored in the database).
</ResponseField>

<ResponseField name="Name" type="string">
  Machine-readable key for the enum entry.
</ResponseField>

<ResponseField name="Label" type="string">
  Human-readable localised label for display in the UI.
</ResponseField>

## Example Response

```json theme={null}
[
  { "Id": 1, "Name": "Draft", "Label": "Draft" },
  { "Id": 2, "Name": "Sent", "Label": "Sent" },
  { "Id": 3, "Name": "Paid", "Label": "Paid" },
  { "Id": 4, "Name": "Cancelled", "Label": "Cancelled" }
]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.enum('InvoiceStatus')
// => '/api/utils/enums?name=InvoiceStatus'

const response = await httpClient.get<{ Id: number; Name: string; Label: string }[]>(url)
const enumValues = response.data
```

## Usage in Portal

| Context                               | Source file           |
| ------------------------------------- | --------------------- |
| Dynamic dropdowns for resource fields | `src/views/bookings/` |
| Checkout and product configuration    | `src/views/checkout/` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The `name` parameter is missing or does not match a known server-side enum.
</ResponseField>

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                  | Description                                      |
| ------ | ----------------------------------------- | ------------------------------------------------ |
| `GET`  | `/api/public/configuration`               | Get full portal configuration including settings |
| `GET`  | `/api/public/resources/fields/searchable` | Get searchable custom fields for resources       |


# Get Impersonation Token
Source: https://learn.nexudus.com/api/endpoints/system/impersonation-token

GET /api/sys/users/impersonate
Issue an impersonation token that allows an admin user to act as a specific customer within the portal.

# Get Impersonation Token

Generates a short-lived token that an operator or admin can use to sign in as a specific customer without knowing their password. This is useful for customer support scenarios where an operator needs to view the portal exactly as a member sees it.

<Warning>This endpoint requires elevated (admin/operator) privileges. It is not available to standard customer sessions.</Warning>

## Authentication

Requires a valid admin or operator bearer token. Standard customer sessions will receive a `401 Unauthorized` response.

## Query Parameters

<ParamField type="number">
  The numeric identifier of the customer to impersonate.
</ParamField>

## Response

<Note>
  This endpoint is registered in `endpoints.ts` but **not invoked** anywhere in the portal frontend. The response shape below is inferred from the
  sibling endpoint `GET /api/public/coworkers/{coworkerId}/impersonate`, which returns the same structure and is actively used.
</Note>

Returns a JSON object containing a short-lived impersonation token. Pass the token to the `/api/sys/users/exchange` endpoint to obtain a full bearer session.

<ResponseField name="token" type="string">
  A short-lived JWT that can be exchanged for a full authentication session via the token exchange endpoint.
</ResponseField>

### Example Response

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

## TypeScript Integration

The endpoint is defined in `endpoints.ts` but has no callers in the portal. The public sibling endpoint (`/api/public/coworkers/{coworkerId}/impersonate`) is used instead for team-admin impersonation flows:

```typescript theme={null}
import endpoints from '@/api/endpoints'

// Admin-level URL builder (defined but unused in the portal)
const adminUrl = endpoints.system.getImpersonationToken(coworkerId)
// => '/api/sys/users/impersonate?coworkerId=42'

// The portal uses the public impersonation endpoint instead:
const response = await httpClient.get<{ token: string }>(endpoints.coworkers.impersonate(coworkerId))
await exchangeToken(response.data.token, true)
```

## Usage in Portal

<Note>
  This endpoint has **no active callers** in the portal codebase. Team-admin impersonation is handled by `GET /api/public/coworkers/{coworkerId}
      /impersonate` via `useSignIn().impersonate()`.
</Note>

| Context                                    | Source file                                                          |
| ------------------------------------------ | -------------------------------------------------------------------- |
| Endpoint definition (unused)               | `src/api/endpoints.ts`                                               |
| Team member impersonation (public sibling) | `src/views/auth/SignIn/useSignIn.ts`                                 |
| Impersonate button in team management      | `src/views/user/team/permissions/components/TeamPermissionTable.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The caller does not have admin or operator privileges.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No customer with the given `coworkerId` was found in this location.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                         | Description                                                        |
| ------ | ------------------------------------------------ | ------------------------------------------------------------------ |
| `GET`  | `/api/public/coworkers/{coworkerId}/impersonate` | Public impersonation — used by team admins in the portal           |
| `POST` | `/api/sys/users/exchange`                        | Exchange a JWT for a bearer token                                  |
| `GET`  | `/api/public/coworkers/profiles`                 | List all profiles for the current session (source of `coworkerId`) |
| `PUT`  | `/api/public/coworkers/profiles/current`         | Switch the active profile without impersonation                    |


# Accept Legal Terms
Source: https://learn.nexudus.com/api/endpoints/system/legal-accept

POST /api/public/legal/accept
Record the customer's acceptance of the general terms and any pending contract terms.

# Accept Legal Terms

Records that the authenticated customer has accepted the current general terms and conditions, and optionally any pending contract-specific terms. The portal calls this endpoint when a customer clicks "Accept" on the legal terms modal that is shown when `MustAgreeToTerms` is `true` on the `/api/public/legal/status` response.

## Authentication

Requires a valid customer bearer token.

## Request Body

Send an empty body or a JSON object indicating the accepted terms. The portal typically posts with no body after the customer explicitly accepts on-screen.

```http theme={null}
POST /api/public/legal/accept
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
```

## Response

Returns an `ActionConfirmation` envelope.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the acceptance was recorded. The terms modal should be dismissed and the customer should be granted access to the portal.
</ResponseField>

<ResponseField name="Value" type="string | null">
  Usually `null` on success.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `null` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation errors. `null` on success.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { ActionConfirmation } from '@/types/ActionConfirmation'

const url = endpoints.system.accept_terms()
// => '/api/public/legal/accept'

const response = await httpClient.post<ActionConfirmation>(url)

if (response.data.WasSuccessful) {
  // Dismiss the legal terms modal and continue
}
```

## Usage in Portal

| Context                      | Source file                                   |
| ---------------------------- | --------------------------------------------- |
| Legal terms acceptance modal | `src/components/LegalTerms/` or app bootstrap |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  The request is malformed or there are no pending terms to accept.
</ResponseField>

## Related Endpoints

| Method | Endpoint                   | Description                                    |
| ------ | -------------------------- | ---------------------------------------------- |
| `GET`  | `/api/public/legal/status` | Check whether the customer must agree to terms |


# Get Legal Status
Source: https://learn.nexudus.com/api/endpoints/system/legal-status

GET /api/public/legal/status
Check whether the authenticated customer must accept general or contract-specific terms and conditions before using the portal.

# Get Legal Status

Returns the legal terms acceptance status for the current customer. The portal checks this on every authenticated session bootstrap. If `MustAgreeToTerms` is `true`, a blocking modal is shown with the full terms text before the customer can continue.

## Authentication

Requires a valid customer bearer token.

## Response

<ResponseField name="MustAgreeToTerms" type="boolean">
  `true` when the customer must accept one or more outstanding terms before accessing the portal. Show the acceptance modal when this is `true`.
</ResponseField>

<ResponseField name="GeneralTermsAccepted" type="boolean">
  Whether the customer has already accepted the space's general terms and conditions.
</ResponseField>

<ResponseField name="GeneralTerms" type="string">
  HTML or plain-text content of the general terms and conditions to display to the customer.
</ResponseField>

<ResponseField name="ContractTerms" type="array | undefined">
  Array of contract-specific terms the customer must accept. Present only when there are pending contract terms. Each entry contains:
</ResponseField>

<ResponseField name="ContractTerms[].Id" type="number">
  Unique identifier of the contract.
</ResponseField>

<ResponseField name="ContractTerms[].StartDate" type="string">
  ISO 8601 date when the contract starts.
</ResponseField>

<ResponseField name="ContractTerms[].TariffName" type="string">
  Display name of the plan associated with this contract.
</ResponseField>

<ResponseField name="ContractTerms[].TermsAndConditions" type="string">
  HTML or plain-text content of the contract-specific terms to display.
</ResponseField>

## Example Response

```json theme={null}
{
  "MustAgreeToTerms": true,
  "GeneralTermsAccepted": false,
  "GeneralTerms": "<p>By using this portal you agree to our <a href='...'>terms</a>.</p>",
  "ContractTerms": [
    {
      "Id": 101,
      "StartDate": "2026-04-01T00:00:00Z",
      "TariffName": "Hot Desk Monthly",
      "TermsAndConditions": "<p>These terms govern your Hot Desk Monthly membership...</p>"
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'

const endpoint = endpoints.system.legal_status()

const { resource: legalStatus } = useTypedData(httpClient, endpoint)

if (legalStatus?.MustAgreeToTerms) {
  // Show the legal terms modal
}
```

## Usage in Portal

| Context                              | Source file                   |
| ------------------------------------ | ----------------------------- |
| Session bootstrap — legal terms gate | `src/App.tsx` or auth context |
| Legal terms acceptance modal         | `src/components/LegalTerms/`  |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid. The customer must sign in.
</ResponseField>

## Related Endpoints

| Method | Endpoint                   | Description                            |
| ------ | -------------------------- | -------------------------------------- |
| `POST` | `/api/public/legal/accept` | Record acceptance of outstanding terms |


# Get Media Token
Source: https://learn.nexudus.com/api/endpoints/system/media-token

GET /api/auth/media/customer
Obtain a short-lived JWT that authorises access to protected media files hosted by Nexudus.

# Get Media Token

Issues a short-lived JWT scoped to the authenticated customer that can be appended to media URLs (as the `t` query parameter) to access protected files — such as invoice PDFs, uploaded documents, and other customer-specific media stored by Nexudus.

<Note>
  This token is distinct from the bearer token used for API calls. It is a lightweight media-access credential with a short expiry and must be
  refreshed before downloading files in long-lived sessions.
</Note>

## Authentication

Requires a valid customer bearer token in the `Authorization` header.

## Request

No request body or query parameters are required.

```http theme={null}
GET /api/auth/media/customer
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
```

## Response

Returns a `JwtMedia` object.

<ResponseField name="jwt" type="string">
  Short-lived JWT to append as `?t={jwt}` when constructing authenticated media URLs. For example: `/api/public/billing/invoices/{id}/pdf?t={jwt}`.
</ResponseField>

## Example Response

```json theme={null}
{
  "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MiIsIm..."
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'
import { JwtMedia } from '@/types/JwtMedia'

// The endpoint value is the raw URL string
const mediaTokenUrl = endpoints.system.mediaToken
// => '/api/auth/media/customer'

const { resource: mediaJwt } = useData<JwtMedia>(httpClient, mediaTokenUrl)

// Use the JWT when building a PDF link
const pdfUrl = endpoints.billing.invoices.pdf(invoiceId, mediaJwt)
```

## Usage in Portal

| Context                                  | Source file                            |
| ---------------------------------------- | -------------------------------------- |
| Invoice PDF download                     | `src/views/billing/invoices/`          |
| File downloads (authenticated documents) | `src/components/AuthenticatedLink.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid. The customer must sign in again.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                       | Description                                   |
| ------ | ---------------------------------------------- | --------------------------------------------- |
| `GET`  | `/api/public/billing/invoices/{invoiceId}/pdf` | Download an invoice PDF (requires this token) |
| `POST` | `/api/sys/users/token/refresh`                 | Obtain an authenticated redirect token        |
| `GET`  | `/api/public/files/my`                         | List files accessible to the current customer |


# Get Navigation Outline
Source: https://learn.nexudus.com/api/endpoints/system/outline-navigation

GET /api/public/outlines/navigation
Retrieve the navigation structure that defines the portal menu, routes, and page layout.

# Get Navigation Outline

Returns the navigation outline that defines the portal's top-level menu structure, sidebar navigation, and page hierarchy. Operators customise this outline in the Nexudus dashboard. The portal renders its navigation tree directly from this response, making it the single source of truth for what menu items and pages are visible.

## Authentication

Requires a valid customer bearer token.

## Response

Returns an object with a single `Json` property containing the navigation structure as a serialised JSON string. Consumers must `JSON.parse()` the value to get the navigation tree.

<ResponseField name="Json" type="string">
  Serialised JSON string containing the navigation tree structure. Parse this to get the navigation items, routes, and page hierarchy.
</ResponseField>

## Example Response

```json theme={null}
{
  "Json": "{\"Items\":[{\"Name\":\"Dashboard\",\"Url\":\"/\",\"Icon\":\"home\"}]}"
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'

const { resource: navResource } = useData<{ Json: string }>(httpClient, endpoints.system.outlines.navigation)
const navigation = JSON.parse(navResource.Json) // -> NavigationConfig
```

## Usage in Portal

| Context                         | Source file                     |
| ------------------------------- | ------------------------------- |
| Portal sidebar / top navigation | `src/layouts/DefaultLayout.tsx` |
| Route generation                | `src/routes/`                   |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description                                 |
| ------ | --------------------------------------- | ------------------------------------------- |
| `GET`  | `/api/public/outlines/all`              | Get all system outlines                     |
| `GET`  | `/api/public/outlines/custom`           | Get custom outlines created by the operator |
| `GET`  | `/api/public/outlines/custom/published` | Get published custom outlines               |
| `GET`  | `/api/public/configuration`             | Get portal feature configuration            |


# Outline Management
Source: https://learn.nexudus.com/api/endpoints/system/outlines

Endpoints for managing system and custom portal outlines — the structured definitions that control portal pages and navigation.

# Outline Management

Outlines are the structured page and navigation definitions that control what appears in the portal. The Nexudus platform provides built-in system outlines and allows operators to create custom outlines. These endpoints cover listing, retrieving, creating, updating, and deleting outlines.

***

## List All System Outlines

<api>GET /api/public/outlines/all</api>

Returns all system outlines available for the current portal. System outlines are the built-in page definitions provided by the Nexudus platform.

### Authentication

Requires a valid customer bearer token.

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.all
// => '/api/public/outlines/all'

const response = await httpClient.get(url)
```

***

## List Custom Outlines

<api>GET /api/public/outlines/custom</api>

Returns all custom outlines created by the operator for the current portal.

### Authentication

Requires a valid customer bearer token.

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.custom
// => '/api/public/outlines/custom'
```

***

## Get Custom Outline by ID

<api>GET /api/public/outlines/custom/</api>

Returns a specific custom outline by its numeric file identifier.

### Path Parameters

<ParamField type="number">
  The numeric identifier of the custom outline to retrieve.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.getCustom(fileId)
// => '/api/public/outlines/custom/42'
```

***

## Get Published Custom Outline by ID

<api>GET /api/public/outlines/custom/published/</api>

Returns the published version of a specific custom outline. Only published outlines are shown to members.

### Path Parameters

<ParamField type="number">
  The numeric identifier of the published custom outline.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.getCustomPublished(fileId)
// => '/api/public/outlines/custom/published/42'
```

***

## List Published Custom Outlines

<api>GET /api/public/outlines/custom/published</api>

Returns all published custom outlines for the current portal.

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.customPublished
// => '/api/public/outlines/custom/published'
```

***

## Update a System Outline

<api>PUT /api/public/outlines/</api>

Updates a named system outline. Requires operator-level permissions.

### Path Parameters

<ParamField type="string">
  The machine-readable name of the system outline to update.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.update('navigation')
// => '/api/public/outlines/navigation'

await httpClient.put(url, updatedOutlineData)
```

***

## Delete a System Outline

<api>DELETE /api/public/outlines/</api>

Deletes a named system outline. Requires operator-level permissions.

### Path Parameters

<ParamField type="string">
  The machine-readable name of the system outline to delete.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.delete('my-custom-page')
// => '/api/public/outlines/my-custom-page'

await httpClient.delete(url)
```

***

## Create a Custom Outline

<api>POST /api/public/outlines/custom</api>

Creates a new custom outline for the portal.

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.createCustom()
// => '/api/public/outlines/custom'

await httpClient.post(url, newOutlineData)
```

***

## Update a Custom Outline

<api>PUT /api/public/outlines/custom/</api>

Updates an existing custom outline by its numeric ID.

### Path Parameters

<ParamField type="number">
  The numeric identifier of the custom outline to update.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.updateCustom(42)
// => '/api/public/outlines/custom/42'

await httpClient.put(url, updatedData)
```

***

## Delete a Custom Outline

<api>DELETE /api/public/outlines/custom/</api>

Deletes a custom outline by its numeric ID.

### Path Parameters

<ParamField type="number">
  The numeric identifier of the custom outline to delete.
</ParamField>

### TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.deleteCustom(42)
// => '/api/public/outlines/custom/42'

await httpClient.delete(url)
```

***

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The authenticated user does not have operator-level permission to manage outlines.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No outline with the given name or ID was found.
</ResponseField>

## Related Endpoints

| Method | Endpoint                          | Description                       |
| ------ | --------------------------------- | --------------------------------- |
| `GET`  | `/api/public/outlines/navigation` | Get the portal navigation outline |
| `GET`  | `/api/public/configuration`       | Get portal feature configuration  |


# Get Portal Configuration
Source: https://learn.nexudus.com/api/endpoints/system/portal-configuration

GET /api/public/configuration
Retrieve the full portal feature configuration for the current Nexudus location.

# Get Portal Configuration

Returns the complete portal configuration object for the current location. This includes feature flags, payment provider settings, branding configuration, checkout options, module availability, and all other operator-controlled settings that determine how the Members Portal behaves. The portal fetches this on startup and re-fetches when switching locations.

## Authentication

Requires a valid customer bearer token, or returns public configuration for unauthenticated sessions depending on space settings.

## Response

Returns `BusinessSetting[]` — a flat array of name–value pairs. Each setting corresponds to a portal configuration option set by the operator.

<ResponseField name="[].Name" type="string">
  The setting key (e.g. `"PublicWebSite.Tour.TimeSlots.Enabled"`, `"PaymentProvider"`, `"AllowSelfSignup"`).
</ResponseField>

<ResponseField name="[].Value" type="string">
  The setting value as a string. Boolean settings use `"True"`/`"False"`. Numeric settings are stringified.
</ResponseField>

## Example Response

```json theme={null}
[
  { "Name": "PaymentProvider", "Value": "Stripe" },
  { "Name": "AllowSelfSignup", "Value": "True" },
  { "Name": "DefaultLanguage", "Value": "en" },
  { "Name": "PublicWebSite.Tour.TimeSlots.Enabled", "Value": "False" }
]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'
import { BusinessSetting } from '@/types/sys/BusinessSetting'

const { resource: settings } = useData<BusinessSetting[]>(httpClient, endpoints.system.business.configuration)

const getSetting = (name: string) => settings?.find((x) => x.Name?.toLocaleLowerCase() === name.toLocaleLowerCase())?.Value

if (getSetting('AllowSelfSignup') === 'True') {
  // Show signup flow
}
```

## Usage in Portal

| Context                               | Source file                                |
| ------------------------------------- | ------------------------------------------ |
| App bootstrap / feature flag provider | `src/states/useLocationByRouteContext.tsx` |
| Payment provider initialisation       | `src/views/checkout/`                      |
| Navigation and route guard            | `src/routes/`                              |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  Authentication is required and no valid token was supplied.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No configuration found for the resolved location.
</ResponseField>

## Related Endpoints

| Method | Endpoint                          | Description                       |
| ------ | --------------------------------- | --------------------------------- |
| `GET`  | `/api/public/businesses/current`  | Get the current location profile  |
| `GET`  | `/api/sys/businesses/{id}/colors` | Get the brand colour palette      |
| `GET`  | `/api/public/outlines/navigation` | Get the portal navigation outline |


# Send OTP
Source: https://learn.nexudus.com/api/endpoints/system/send-otp

GET /api/sys/users/sendOtp
Send a one-time password (OTP) to a customer email address for passwordless sign-in.

# Send OTP

Sends a one-time password to the provided email address for passwordless authentication. The customer enters the OTP in the portal to obtain a bearer token without needing their full password. This supports magic-link and OTP-based sign-in flows.

## Authentication

No authentication required. This is a public endpoint.

## Query Parameters

<ParamField type="string">
  The email address of the customer to send the OTP to. URL-encode this value.
</ParamField>

<ParamField type="number">
  The numeric identifier of the location. Ensures the OTP email uses the correct branding and is associated with the right space.
</ParamField>

## Response

Returns an `ActionConfirmation` envelope. As with the password-reset flow, the response does not reveal whether the email address is registered.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the OTP was dispatched (or when no account was found — intentionally the same to prevent enumeration).
</ResponseField>

<ResponseField name="Value" type="string | null">
  Usually `null`.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `null` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation errors. `null` on success.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.users.sendOtp(email, businessId)
// => '/api/sys/users/sendOtp?email=jane.doe%40example.com&businessId=7'

await httpClient.get(url)
```

## Usage in Portal

| Context                       | Source file              |
| ----------------------------- | ------------------------ |
| OTP / magic-link sign-in flow | `src/views/auth/SignIn/` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The `email` or `businessId` parameter is missing or malformed.
</ResponseField>

<ResponseField name="429 Too Many Requests" type="error">
  OTP requests are rate-limited. The customer must wait before requesting another code.
</ResponseField>

## Related Endpoints

| Method | Endpoint                            | Description                                       |
| ------ | ----------------------------------- | ------------------------------------------------- |
| `POST` | `/api/sys/users/startPasswordReset` | Trigger a full password-reset email               |
| `POST` | `/api/sys/users/exchange`           | Exchange a JWT (including OTP result) for a token |
| `POST` | `/api/token`                        | Standard credential-based sign-in                 |


# Start Password Reset
Source: https://learn.nexudus.com/api/endpoints/system/start-password-reset

POST /api/sys/users/startPasswordReset
Trigger a password-reset email for a customer account.

# Start Password Reset

Sends a password-reset email to the customer's registered email address. The email contains a one-time link that the customer can follow to set a new password. The portal calls this from the "Forgot your password?" flow on the sign-in page.

## Authentication

No authentication required. This is a public endpoint.

## Request Body

<ParamField type="string">
  The email address of the account for which the password reset should be triggered.
</ParamField>

<ParamField type="number">
  The numeric identifier of the location the customer belongs to. Providing this ensures the correct branded email template is used.
</ParamField>

## Response

Returns an `ActionConfirmation` envelope. The portal treats any successful response as confirmation that the email was sent — it does not reveal whether the email address is registered, to prevent enumeration attacks.

<ResponseField name="WasSuccessful" type="boolean">
  `true` when the reset email was dispatched (or when no account was found — the response is intentionally the same to prevent user enumeration).
</ResponseField>

<ResponseField name="Value" type="string | null">
  Usually `null`.
</ResponseField>

<ResponseField name="Status" type="number">
  HTTP-style status code mirrored in the body. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string | null">
  Human-readable message. Usually `null` on success.
</ResponseField>

<ResponseField name="Errors" type="any">
  Validation errors. `null` on success.
</ResponseField>

## Example Response

```json theme={null}
{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const url = endpoints.system.users.startPasswordReset
// => '/api/sys/users/startPasswordReset'

await httpClient.post(url, { email: userEmail, businessId })
```

## Usage in Portal

| Context                      | Source file                      |
| ---------------------------- | -------------------------------- |
| Forgot password page / modal | `src/views/auth/ForgotPassword/` |

## Error Responses

<ResponseField name="400 Bad Request" type="error">
  The email field is missing or the request body is malformed.
</ResponseField>

## Related Endpoints

| Method | Endpoint                               | Description                                           |
| ------ | -------------------------------------- | ----------------------------------------------------- |
| `POST` | `/api/sys/users/completePasswordReset` | Complete the reset flow with the token from the email |
| `POST` | `/api/token`                           | Sign in after completing the password reset           |
| `GET`  | `/api/sys/users/sendOtp`               | Send a one-time password for passwordless sign-in     |


# Add Team Members
Source: https://learn.nexudus.com/api/endpoints/teams/add-team-members

POST /api/public/teams/{teamId}/members
Adds one or more new members to a team by email address.

# Add Team Members

Adds one or more members to a team by providing their full names and email addresses. Each new member is assigned the specified membership plan with the given start date. A maximum of 25 members can be added in a single request.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Request Body

<ParamField type="number">
  ID of the membership plan to assign to the new members. Obtain available plans from the team's default tariff or from the plans list.
</ParamField>

<ParamField type="string[]">
  Array of full names for each new member. Must have the same number of entries as `Emails`.
</ParamField>

<ParamField type="string[]">
  Array of email addresses for each new member. Must have the same number of entries as `FullNames`. Each entry must be a valid email address.
</ParamField>

<ParamField type="string">
  ISO 8601 date for when the new members' plans should begin.
</ParamField>

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Add two members to a team

```http theme={null}
POST /api/public/teams/55/members
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "TariffId": 301,
  "FullNames": ["Alice Johnson", "Carlos Rivera"],
  "Emails": ["alice@example.com", "carlos@example.com"],
  "StartDate": "2025-02-01T00:00:00.000Z"
}
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

await httpClient.post(endpoints.teams.addMembers(teamId), {
  TariffId: 301,
  FullNames: ['Alice Johnson'],
  Emails: ['alice@example.com'],
  StartDate: new Date().toISOString(),
})
```

## Usage in Portal

| Context                                     | Source file                                                     |
| ------------------------------------------- | --------------------------------------------------------------- |
| Add member modal (`/team/members/{teamId}`) | `src/views/user/team/members/components/TeamMemberAddModal.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Validation error — for example, mismatched array lengths for `FullNames` and `Emails`, more than 25 members, or invalid email format.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method   | Endpoint                                            | Description                 |
| -------- | --------------------------------------------------- | --------------------------- |
| `DELETE` | `/api/public/teams/{teamId}/members/{coworkerId}`   | Remove a member from a team |
| `GET`    | `/api/public/teams/my`                              | List the customer's teams   |
| `GET`    | `/api/public/teams/{teamId}/profile`                | Full team profile           |
| `PUT`    | `/api/public/teams/{teamId}/permissions/{memberId}` | Update member permissions   |


# List Published Teams
Source: https://learn.nexudus.com/api/endpoints/teams/directory-list

GET /api/public/teams/published
Returns a paginated list of teams with public profiles, filterable by search query and tags.

# List Published Teams

Returns a paginated list of teams whose profiles are publicly visible in the member directory. Supports full-text search by name and filtering by profile tag. Used by the community directory page to render team cards alongside member profiles.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="string">
  Full-text search string matched against team names and descriptions. **Default**: `""` (no filter).
</ParamField>

<ParamField type="string">
  Filter results to teams that have this tag in their `ProfileTags`. **Default**: `""` (no filter).
</ParamField>

<ParamField type="number">
  Sort order. **Default**: `1`.
</ParamField>

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. **Example**:
  `_shape=Records.Id,Records.Name,Records.ProfileSummary`
</ParamField>

<ParamField type="number">
  1-based page number. **Default**: `1`
</ParamField>

<ParamField type="number">
  Records per page. **Default**: `25` · **Maximum**: `100`
</ParamField>

## Response

Returns the standard `ApiListResult<Team>` envelope (see [API Overview](/api/overview) for pagination fields). The `Records` array contains team objects with the same shape as [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams). See that endpoint for the full field breakdown.

### Key Team Fields

| Field              | Type      | Description                             |
| ------------------ | --------- | --------------------------------------- |
| `Id`               | `number`  | Unique numeric identifier for the team  |
| `Name`             | `string`  | Team display name                       |
| `ProfileSummary`   | `string`  | Short team bio                          |
| `ProfileIsPublic`  | `boolean` | Whether the profile is publicly visible |
| `ProfileWebsite`   | `string`  | Team website URL                        |
| `HasTeamLogo`      | `boolean` | Whether the team has a logo image       |
| `TeamMembersCount` | `number`  | Number of team members                  |
| `BusinessName`     | `string`  | Location display name                   |
| `Twitter`          | `string`  | Twitter handle/URL                      |
| `Linkedin`         | `string`  | LinkedIn URL                            |
| `Github`           | `string`  | GitHub URL                              |
| `Instagram`        | `string`  | Instagram URL                           |

## Examples

### Search published teams

```http theme={null}
GET /api/public/teams/published?query=tech&tag=innovation&order=1
Authorization: Bearer {token}
```

```json theme={null}
{
  "Records": [
    {
      "Id": 55,
      "Name": "Tech Innovators",
      "ProfileSummary": "Building the future, one innovation at a time",
      "ProfileIsPublic": true,
      "ProfileTags": "technology startup innovation",
      "ProfileTagsList": ["technology", "startup", "innovation"],
      "HasTeamLogo": true,
      "TeamMembersCount": 12,
      "BusinessName": "Downtown Coworking Hub"
    }
  ],
  "CurrentPageSize": 1,
  "CurrentPage": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "TotalItems": 1,
  "TotalPages": 1
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { useData } from '@/hooks/useData'

const { resource: teams } = useData(httpClient, endpoints.teams.directory.published_list(query, tag, order))
```

## Usage in Portal

| Context                                      | Source file                                                    |
| -------------------------------------------- | -------------------------------------------------------------- |
| Community directory (`/community/directory`) | `src/views/community/directory/components/useDirectoryData.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

## Related Endpoints

| Method | Endpoint                               | Description                             |
| ------ | -------------------------------------- | --------------------------------------- |
| `GET`  | `/api/public/teams/published/{teamId}` | Full profile of a single published team |
| `GET`  | `/api/public/teams/directory/meta`     | Directory metadata (tags, config)       |
| `GET`  | `/api/public/teams/my`                 | List the customer's own teams           |


# Get Directory Meta
Source: https://learn.nexudus.com/api/endpoints/teams/directory-meta

GET /api/public/teams/directory/meta
Returns directory configuration and tag cloud data for the team and member directory.

# Get Directory Meta

Returns metadata that controls how the community directory behaves — including whether the directory is enabled, what content it shows (teams only, members only, or both), the tag cloud for filtering, and any custom fields configured for directory search.

## Authentication

Requires a valid customer bearer token.

## Response

<ResponseField name="Meta" type="DirectoryMeta">
  The directory metadata object.
</ResponseField>

### Meta Fields

<ResponseField name="Meta.DirectoryEnabled" type="boolean">
  When `true`, the community directory is enabled for this location.
</ResponseField>

<ResponseField name="Meta.DirectoryContents" type="eDirectoryContents">
  Controls which profiles appear in the directory: `1` = Published profiles, `2` = Published profiles with a price plan, `3` = Everyone, `4` =
  Everyone with a price plan.
</ResponseField>

<ResponseField name="Meta.DirectoryRecords" type="eDirectoryRecordType">
  Controls the record types shown: `1` = Teams and members, `2` = Only teams, `3` = Only members.
</ResponseField>

<ResponseField name="Meta.OnlyInvoicingSpace" type="boolean">
  When `true`, only members from the invoicing space are shown.
</ResponseField>

<ResponseField name="Meta.ShowCheckInMembers" type="boolean">
  When `true`, members who are currently checked in are highlighted.
</ResponseField>

<ResponseField name="Meta.Tags" type="TagCloud[]">
  Tag cloud entries derived from all published profiles.
</ResponseField>

<ResponseField name="Meta.Tags[].Tag" type="string">
  The tag text.
</ResponseField>

<ResponseField name="Meta.Tags[].Count" type="number">
  Number of profiles using this tag.
</ResponseField>

<ResponseField name="Meta.Tags[].Percentage" type="number">
  Relative weight of this tag as a percentage — used to size tags in a tag cloud UI.
</ResponseField>

<ResponseField name="Meta.CustomFields" type="CustomField[]">
  Custom fields configured for directory search.
</ResponseField>

<ResponseField name="Meta.CustomFields[].Id" type="number">
  Unique identifier of the custom field.
</ResponseField>

<ResponseField name="Meta.CustomFields[].Name" type="string">
  Display name of the custom field.
</ResponseField>

<ResponseField name="Meta.CustomFields[].FieldType" type="string">
  Field type (e.g., `"Text"`, `"Dropdown"`).
</ResponseField>

<ResponseField name="Meta.CustomFields[].CustomFieldIndex" type="number">
  Index used to map the field to the correct slot.
</ResponseField>

<ResponseField name="Meta.CustomFields[].DisplayInDirectorySearch" type="boolean">
  When `true`, this field appears as a search filter in the directory UI.
</ResponseField>

<ResponseField name="Meta.CustomFields[].NameInSearch" type="string">
  Label shown in the search filter UI.
</ResponseField>

<ResponseField name="Meta.CustomFields[].AvailableOptions" type="string[]">
  Available values for dropdown-type fields.
</ResponseField>

## Examples

### Fetch directory metadata

```http theme={null}
GET /api/public/teams/directory/meta
Authorization: Bearer {token}
```

```json theme={null}
{
  "Meta": {
    "DirectoryEnabled": true,
    "DirectoryContents": 1,
    "DirectoryRecords": 1,
    "OnlyInvoicingSpace": false,
    "ShowCheckInMembers": true,
    "Tags": [
      { "Tag": "technology", "Count": 8, "Percentage": 40 },
      { "Tag": "design", "Count": 5, "Percentage": 25 },
      { "Tag": "marketing", "Count": 4, "Percentage": 20 }
    ],
    "CustomFields": [
      {
        "Id": 1,
        "Name": "Industry",
        "FieldType": "Dropdown",
        "CustomFieldIndex": 0,
        "DisplayInDirectorySearch": true,
        "NameInSearch": "Industry",
        "AvailableOptions": ["Technology", "Finance", "Design", "Marketing"]
      }
    ]
  }
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { DirectoryMetaData } from '@/types/endpoints/DirectoryMeta'
import { useData } from '@/hooks/useData'

const { resource: meta } = useData<DirectoryMetaData>(httpClient, endpoints.teams.directory.meta)
```

## Usage in Portal

| Context                                      | Source file                                                    |
| -------------------------------------------- | -------------------------------------------------------------- |
| Community directory (`/community/directory`) | `src/views/community/directory/components/useDirectoryData.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

## Related Endpoints

| Method | Endpoint                               | Description                           |
| ------ | -------------------------------------- | ------------------------------------- |
| `GET`  | `/api/public/teams/published`          | List published teams in the directory |
| `GET`  | `/api/public/teams/published/{teamId}` | Get a single published team profile   |
| `GET`  | `/api/public/teams/my`                 | List the customer's own teams         |


# Get Published Team
Source: https://learn.nexudus.com/api/endpoints/teams/directory-team

GET /api/public/teams/published/{teamId}
Returns the full public profile of a single published team from the directory.

# Get Published Team

Returns the full public profile for a single team in the member directory. Used when a customer clicks on a team card in the directory to view its detailed profile in a modal.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` in the `Records` array from [`GET
      /api/public/teams/published`](/api/endpoints/teams/directory-list).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size.
</ParamField>

## Response

Returns a team profile object with the same fields as [`GET /api/public/teams/{teamId}/profile`](/api/endpoints/teams/team-details), but scoped to publicly visible information. See that endpoint for the full field breakdown.

### Key Team Profile Fields

| Field               | Type      | Description                             |
| ------------------- | --------- | --------------------------------------- |
| `Id`                | `number`  | Unique numeric identifier for the team  |
| `Name`              | `string`  | Team display name                       |
| `Description`       | `string`  | Team description                        |
| `ProfileSummary`    | `string`  | Short team bio                          |
| `ProfileIsPublic`   | `boolean` | Whether the profile is publicly visible |
| `ProfileWebsite`    | `string`  | Team website URL                        |
| `HasTeamLogo`       | `boolean` | Whether the team has a logo image       |
| `TeamMembersCount`  | `number`  | Number of team members                  |
| `BusinessName`      | `string`  | Location display name                   |
| `HasCommunityGroup` | `boolean` | Whether the team has a discussion group |
| `Twitter`           | `string`  | Twitter handle/URL                      |
| `Linkedin`          | `string`  | LinkedIn URL                            |

## Examples

### Fetch a published team profile

```http theme={null}
GET /api/public/teams/published/55
Authorization: Bearer {token}
```

```json theme={null}
{
  "Id": 55,
  "Name": "Tech Innovators",
  "ProfileSummary": "Building the future, one innovation at a time",
  "ProfileIsPublic": true,
  "ProfileWebsite": "https://techinnovators.example.com",
  "ProfileTags": "technology startup innovation",
  "ProfileTagsList": ["technology", "startup", "innovation"],
  "BusinessName": "Downtown Coworking Hub",
  "Twitter": "https://twitter.com/techinnovators",
  "Linkedin": "https://linkedin.com/company/techinnovators",
  "Github": "https://github.com/techinnovators",
  "HasTeamLogo": true,
  "TeamMembersCount": 12
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { useData } from '@/hooks/useData'

const { resource: team } = useData(httpClient, endpoints.teams.directory.published_one(teamId))
```

## Usage in Portal

| Context                                                  | Source file                                                              |
| -------------------------------------------------------- | ------------------------------------------------------------------------ |
| Team profile modal in directory (`/community/directory`) | `src/views/community/directory/components/TeamDirectoryProfileModal.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist or is not publicly visible.
</ResponseField>

## Related Endpoints

| Method | Endpoint                             | Description                       |
| ------ | ------------------------------------ | --------------------------------- |
| `GET`  | `/api/public/teams/published`        | List all published teams          |
| `GET`  | `/api/public/teams/directory/meta`   | Directory metadata (tags, config) |
| `GET`  | `/api/public/teams/{teamId}/profile` | Full team profile (member access) |


# List User Teams
Source: https://learn.nexudus.com/api/endpoints/teams/list-teams

GET /api/public/teams/my
Returns the teams the authenticated customer belongs to, optionally filtered to admin-only teams.

# List User Teams

Returns a paginated list of teams the authenticated customer belongs to. Pass `isTeamAdmin=true` to restrict the results to teams where the customer has admin rights — used across the portal to gate management interfaces. Pass `isTeamAdmin=false` to return all teams regardless of role.

<Note>
  A **team** is a group of customers within a coworking location that can share resources, bookings, and billing. The portal maps teams to companies
  or departments that co-habit a space.
</Note>

## Authentication

Requires a valid customer bearer token. The response is automatically scoped to the authenticated customer — no additional filtering is needed.

## Query Parameters

<ParamField type="boolean">
  `true` — return only teams where the customer is an administrator. `false` — return all teams the customer belongs to (admins and members).
</ParamField>

<ParamField type="number">
  Filter results to a single team by its numeric ID. When omitted, returns all teams matching the `isTeamAdmin` filter.
</ParamField>

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. **Example**:
  `_shape=Records.Id,Records.Name,Records.TeamMembersCount`
</ParamField>

<ParamField type="number">
  1-based page number. **Default**: `1`
</ParamField>

<ParamField type="number">
  Records per page. **Default**: `25` · **Maximum**: `100`
</ParamField>

<ParamField type="string">
  Response field to sort by. **Default**: `Name`
</ParamField>

<ParamField type="string">
  `asc` or `desc`. **Default**: `asc`
</ParamField>

## Response

Returns the standard `ApiListResult<Team>` envelope (see [API Overview](/api/overview) for pagination fields). The `Records` array contains team objects.

### Core Fields

<ResponseField name="Records[].Id" type="number">
  Unique integer identifier for the team. Use this as `{teamId}` in all team-scoped endpoints.
</ResponseField>

<ResponseField name="Records[].Name" type="string">
  Display name of the team.
</ResponseField>

<ResponseField name="Records[].UniqueId" type="string">
  UUID for the team — stable across renames and useful as a cache key.
</ResponseField>

<ResponseField name="Records[].IdString" type="string">
  String cast of `Id`. Provided for environments that lose integer precision (e.g., JavaScript `JSON.parse` on 64-bit IDs).
</ResponseField>

### Profile Fields

<ResponseField name="Records[].Description" type="string | null">
  Full-length team description. May contain HTML.
</ResponseField>

<ResponseField name="Records[].ProfileSummary" type="string">
  Short tagline shown in team cards and selectors.
</ResponseField>

<ResponseField name="Records[].ProfileIsPublic" type="boolean">
  When `true`, the team profile is visible in the public member directory.
</ResponseField>

<ResponseField name="Records[].ProfileWebsite" type="string | null">
  Team website URL.
</ResponseField>

<ResponseField name="Records[].ProfileTags" type="string">
  Space-separated tag string. Use `ProfileTagsList` for array access.
</ResponseField>

<ResponseField name="Records[].ProfileTagsList" type="string[]">
  Pre-split array of tag strings derived from `ProfileTags`.
</ResponseField>

### Location

<ResponseField name="Records[].BusinessName" type="string">
  Name of the coworking location this team belongs to.
</ResponseField>

<ResponseField name="Records[].BusinessHomeUrl" type="string">
  URL of the coworking location's home page.
</ResponseField>

### Social Media

All social fields are `string | null`. Provide a full URL (e.g., `https://twitter.com/handle`) unless stated otherwise.

| Field       | Description               |
| ----------- | ------------------------- |
| `Twitter`   | X / Twitter profile URL   |
| `Facebook`  | Facebook page URL         |
| `Linkedin`  | LinkedIn company page URL |
| `Instagram` | Instagram profile URL     |
| `Github`    | GitHub org or user URL    |
| `Pinterest` | Pinterest profile URL     |
| `Skype`     | Skype username            |
| `Telegram`  | Telegram handle           |
| `Flickr`    | Flickr profile URL        |
| `Vimeo`     | Vimeo channel URL         |
| `Tumblr`    | Tumblr blog URL           |
| `Blogger`   | Blogger profile URL       |

### Members

<ResponseField name="Records[].TeamMembersCount" type="number">
  Total count of active members (admins + regular members).
</ResponseField>

<ResponseField name="Records[].TeamAdministratorsFullNames" type="string[]">
  Display names of all team admins — useful for a quick summary without loading full `Customer` objects.
</ResponseField>

<ResponseField name="Records[].TeamAdministrators" type="Coworker[]">
  Full `Coworker` objects for admins only.
</ResponseField>

<ResponseField name="Records[].TeamMembers" type="Coworker[]">
  Full `Coworker` objects for non-admin members.
</ResponseField>

<ResponseField name="Records[].AllTeamMembers" type="Coworker[]">
  Combined `Coworker` objects for all members (admins + regular). Use this instead of merging the two arrays above.
</ResponseField>

### Billing & Configuration

<ResponseField name="Records[].PayingMemberId" type="number | null">
  Customer ID of the member who receives consolidated invoices, if `CreateSingleInvoiceForTeam` is `true`.
</ResponseField>

<ResponseField name="Records[].CreateSingleInvoiceForTeam" type="boolean">
  When `true`, all team charges are rolled into a single invoice addressed to `PayingMemberId`.
</ResponseField>

<ResponseField name="Records[].MaxTeamMemberCount" type="number | null">
  Maximum allowed members. `null` means unlimited.
</ResponseField>

<ResponseField name="Records[].HasContactDetails" type="boolean">
  Whether billing/contact details have been configured for this team.
</ResponseField>

<ResponseField name="Records[].HasDefaultPlan" type="boolean">
  Whether the team has a default membership plan assigned.
</ResponseField>

<ResponseField name="Records[].DefaultTariffId" type="number | null">
  ID of the default membership plan assigned to new team members. `null` if no default plan is set.
</ResponseField>

<ResponseField name="Records[].DefaultTariffName" type="string | null">
  Display name of the default membership plan.
</ResponseField>

<ResponseField name="Records[].DefaultMemberTariffKeepNewAccountsOnHold" type="boolean">
  When `true`, new members added to the team are placed on hold until manually activated.
</ResponseField>

<ResponseField name="Records[].DisableAttendaceDashboard" type="boolean">
  When `true`, the attendance dashboard is hidden for this team. Note the typo in the field name (`Attendace`) — it is preserved as-is in the API.
</ResponseField>

<ResponseField name="Records[].DiscountCharges" type="number | null">
  Percentage discount applied to charges for team members.
</ResponseField>

<ResponseField name="Records[].DiscountExtraServices" type="number | null">
  Percentage discount applied to extra services for team members.
</ResponseField>

<ResponseField name="Records[].DiscountTariffs" type="number | null">
  Percentage discount applied to membership plans for team members.
</ResponseField>

<ResponseField name="Records[].DiscountTimePasses" type="number | null">
  Percentage discount applied to time passes for team members.
</ResponseField>

<ResponseField name="Records[].HasCommunityGroup" type="boolean">
  When `true`, the team has an associated community discussion group.
</ResponseField>

<ResponseField name="Records[].GoogleMapsLink" type="string | null">
  Google Maps link for the team's location.
</ResponseField>

### Media

<ResponseField name="Records[].HasTeamLogo" type="boolean">
  `true` if the team has an uploaded logo. Construct the logo URL as: `https://[space].spaces.nexudus.com/api/public/teams/{Id}/logo`
</ResponseField>

<ResponseField name="Records[].HasImage1" type="boolean">
  `true` if profile image 1 has been uploaded.
</ResponseField>

<ResponseField name="Records[].HasImage2" type="boolean">
  `true` if profile image 2 has been uploaded.
</ResponseField>

<ResponseField name="Records[].HasImage3" type="boolean">
  `true` if profile image 3 has been uploaded.
</ResponseField>

<ResponseField name="Records[].HasImages" type="boolean">
  Convenience flag — `true` if any of the three profile images are present.
</ResponseField>

### Timestamps

All datetime fields are ISO 8601 strings. `*On` fields are in the location's local timezone; `*OnUtc` fields are UTC.

<ResponseField name="Records[].CreatedOn" type="string">
  Local datetime the team was created.
</ResponseField>

<ResponseField name="Records[].CreatedOnUtc" type="string">
  UTC datetime the team was created.
</ResponseField>

<ResponseField name="Records[].UpdatedOn" type="string">
  Local datetime of the last update.
</ResponseField>

<ResponseField name="Records[].UpdatedOnUtc" type="string">
  UTC datetime of the last update.
</ResponseField>

## Examples

### Fetch admin teams (full payload)

```http theme={null}
GET /api/public/teams/my?isTeamAdmin=true
Authorization: Bearer {token}
```

```json theme={null}
{
  "Records": [
    {
      "Id": 55,
      "Name": "Tech Innovators",
      "Description": "A collaborative team focused on cutting-edge technology solutions",
      "ProfileSummary": "Building the future, one innovation at a time",
      "ProfileIsPublic": true,
      "ProfileWebsite": "https://techinnovators.example.com",
      "ProfileTags": "technology startup innovation collaboration",
      "ProfileTagsList": ["technology", "startup", "innovation", "collaboration"],
      "BusinessName": "Downtown Coworking Hub",
      "BusinessHomeUrl": "https://downtown-hub.example.com",
      "Twitter": "https://twitter.com/techinnovators",
      "Facebook": null,
      "Linkedin": "https://linkedin.com/company/techinnovators",
      "Instagram": null,
      "Github": "https://github.com/techinnovators",
      "Pinterest": null,
      "Skype": null,
      "Telegram": null,
      "Flickr": null,
      "Vimeo": null,
      "Tumblr": null,
      "Blogger": null,
      "TeamMembersCount": 12,
      "TeamAdministratorsFullNames": ["Jane Smith", "John Doe"],
      "TeamAdministrators": [{ "Id": 101, "FullName": "Jane Smith", "Email": "jane@techinnovators.com" }],
      "TeamMembers": [{ "Id": 102, "FullName": "Bob Wilson", "Email": "bob@techinnovators.com" }],
      "AllTeamMembers": [
        { "Id": 101, "FullName": "Jane Smith", "Email": "jane@techinnovators.com" },
        { "Id": 102, "FullName": "Bob Wilson", "Email": "bob@techinnovators.com" }
      ],
      "PayingMemberId": 101,
      "CreateSingleInvoiceForTeam": true,
      "HasContactDetails": true,
      "HasDefaultPlan": true,
      "MaxTeamMemberCount": 20,
      "DisableAttendaceDashboard": false,
      "HasTeamLogo": true,
      "HasImage1": true,
      "HasImage2": false,
      "HasImage3": false,
      "HasImages": true,
      "Id": 55,
      "IdString": "55",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "CreatedOn": "2024-01-15T09:30:00",
      "UpdatedOn": "2024-07-20T14:22:33",
      "CreatedOnUtc": "2024-01-15T09:30:00Z",
      "UpdatedOnUtc": "2024-07-20T14:22:33Z"
    }
  ],
  "CurrentPageSize": 1,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": "asc",
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 25,
  "TotalItems": 1,
  "TotalPages": 1
}
```

### Fetch all teams with a minimal field set

Use `_shape` to return only the fields your UI needs, reducing payload size significantly.

```http theme={null}
GET /api/public/teams/my?isTeamAdmin=false&_shape=Records.Id,Records.Name,Records.TeamMembersCount
Authorization: Bearer {token}
```

```json theme={null}
{
  "Records": [
    { "Id": 55, "Name": "Tech Innovators", "TeamMembersCount": 12 },
    { "Id": 67, "Name": "Marketing Team", "TeamMembersCount": 8 },
    { "Id": 89, "Name": "Design Studio", "TeamMembersCount": 5 }
  ],
  "CurrentPageSize": 3,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": "asc",
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 3,
  "PageNumber": 1,
  "PageSize": 25,
  "TotalItems": 3,
  "TotalPages": 1
}
```

## TypeScript Integration

The portal types this response as `TeamList` (from `src/types/endpoints/TeamList.ts`) and accesses it through the `endpoints.teams` helper:

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { TeamList } from '@/types/endpoints/TeamList'
import { useData } from '@/hooks/useData'

// Minimal selector data (team switcher dropdowns, nav menus)
const { resource: adminTeams } = useData<TeamList>(
  httpClient,
  endpoints.teams.list(true), // isTeamAdmin=true
  { shape: { fields: ['Records.Id', 'Records.Name'] } },
)

// Richer data for management pages
const { resource: allTeams } = useData<TeamList>(
  httpClient,
  endpoints.teams.list(false), // isTeamAdmin=false
  {
    shape: {
      fields: ['Records.Id', 'Records.Name', 'Records.ProfileSummary', 'Records.TeamMembersCount'],
    },
  },
)
```

## Usage in Portal

The `isTeamAdmin` flag drives a clear permission split across the portal:

| Context                      | `isTeamAdmin` | Source file                                                                                          |
| ---------------------------- | :-----------: | ---------------------------------------------------------------------------------------------------- |
| Team Dashboard team-switcher |     `true`    | `src/views/user/dashboards/team/TeamDashboardPage.tsx`                                               |
| Team Profile editor          |     `true`    | `src/views/user/team/profile/TeamProfessionalProfilePage.tsx`                                        |
| Team Permissions management  |     `true`    | `src/views/user/team/permissions/TeamPermissionsPage.tsx`                                            |
| Team Attendance management   |     `true`    | `src/views/user/team/attendance/AttendanceManagementPage.tsx`                                        |
| Global navigation menu       |     `true`    | `src/states/useMenuItems.tsx`                                                                        |
| Team Attendance dashboard    |    `false`    | `src/views/user/team/attendance/AttendanceDashboardPage.tsx`                                         |
| Attendance management        |     `true`    | `src/views/user/team/attendance/AttendanceManagementPage.tsx`                                        |
| My Bookings team selector    |    `false`    | `src/views/user/activity/bookings/MyBookingsSection.tsx`                                             |
| Booking visitors             |    `false`    | `src/views/public/checkout/booking/components/BookingVisitors.tsx`                                   |
| Onboarding profile action    |    `false`    | `src/views/user/dashboards/personal/components/OnBoarding/components/CompleteProfileActionPanel.tsx` |
| Team members section         |    `false`    | `src/views/user/team/members/TeamMembersSection.tsx`                                                 |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired. Re-authenticate and retry.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  A query parameter value is invalid — for example, a non-boolean `isTeamAdmin` or an out-of-range `_pageSize`.
</ResponseField>

## Related Endpoints

| Method   | Endpoint                                          | Description                      |
| -------- | ------------------------------------------------- | -------------------------------- |
| `GET`    | `/api/public/teams/{teamId}/profile`              | Full profile for a single team   |
| `PUT`    | `/api/public/teams/{teamId}/profile`              | Update team profile (admin only) |
| `GET`    | `/api/public/teams/{teamId}/kpi`                  | Team KPI metrics                 |
| `GET`    | `/api/public/teams/{teamId}/attendance`           | Team attendance data             |
| `GET`    | `/api/public/teams/{teamId}/metrics`              | Team performance metrics         |
| `POST`   | `/api/public/teams/{teamId}/members`              | Add members to a team            |
| `DELETE` | `/api/public/teams/{teamId}/members/{coworkerId}` | Remove a member from a team      |


# Remove Team Member
Source: https://learn.nexudus.com/api/endpoints/teams/remove-team-member

DELETE /api/public/teams/{teamId}/members/{coworkerId}
Removes a member from a team by their customer ID.

# Remove Team Member

Removes a single member from a team. The customer cannot remove themselves — attempting to do so returns a `CANNOT_REMOVE_ITSELF` error. Members with active contracts should have their contracts cancelled before removal.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

<ParamField type="number">
  Numeric identifier of the customer to remove. Returned as `Id` in the `AllTeamMembers` array from [`GET /api/public/teams/{teamId}
      /profile`](/api/endpoints/teams/team-details).
</ParamField>

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Remove a member

```http theme={null}
DELETE /api/public/teams/55/members/102
Authorization: Bearer {token}
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

await httpClient.delete(endpoints.teams.removeMember(teamId, coworkerId))
```

## Usage in Portal

| Context                                       | Source file                                                          |
| --------------------------------------------- | -------------------------------------------------------------------- |
| Team members table (`/team/members/{teamId}`) | `src/views/user/team/members/components/TeamMembersTableSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  The request is invalid — for example, the member has active contracts, or the response message is `CANNOT_REMOVE_ITSELF` when attempting
  self-removal.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team or member with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                            | Description               |
| ------ | --------------------------------------------------- | ------------------------- |
| `POST` | `/api/public/teams/{teamId}/members`                | Add members to a team     |
| `GET`  | `/api/public/teams/{teamId}/profile`                | Full team profile         |
| `GET`  | `/api/public/teams/my`                              | List the customer's teams |
| `PUT`  | `/api/public/teams/{teamId}/permissions/{memberId}` | Update member permissions |


# Get Team Attendance
Source: https://learn.nexudus.com/api/endpoints/teams/team-attendance

GET /api/public/teams/{teamId}/attendance
Returns attendance data for a team on a given week, including per-member schedules and bookings.

# Get Team Attendance

Returns the attendance matrix for a team centred on a given date. Includes per-member day-of-week attendance preferences (office, home, abroad, not working), aggregate statistics, and any bookings overlapping the requested week.

## Authentication

Requires a valid customer bearer token. The customer must be a member or administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Query Parameters

<ParamField type="string">
  ISO 8601 UTC datetime specifying the week to retrieve. The API returns the full week containing this date.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

<ResponseField name="IsTeamAdministrator" type="boolean">
  Whether the authenticated customer is an administrator of this team. Used by the portal to show or hide the attendance editing UI.
</ResponseField>

<ResponseField name="Attendance" type="TeamAttendanceDetails">
  The attendance data object.
</ResponseField>

### Attendance Details

<ResponseField name="Attendance.TeamId" type="number">
  Numeric identifier of the team.
</ResponseField>

<ResponseField name="Attendance.TeamName" type="string">
  Display name of the team.
</ResponseField>

<ResponseField name="Attendance.AvgBookedMinutesPerWeek" type="number">
  Average booked minutes per week across all members.
</ResponseField>

<ResponseField name="Attendance.AvgBookingsCoworkersPerDay" type="number">
  Average number of members with bookings per day.
</ResponseField>

<ResponseField name="Attendance.AvgCheckedinCoworkersPerDay" type="number">
  Average number of members checked in per day.
</ResponseField>

<ResponseField name="Attendance.AvgCheckinsDaysPerWeek" type="number">
  Average check-in days per week.
</ResponseField>

### Attendance.Coworkers\[]

<ResponseField name="Attendance.Coworkers[].CoworkerId" type="number">
  Numeric identifier of the member.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].CoworkerFullName" type="string">
  Display name of the member.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].CoworkerType" type="number">
  Member type code.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].CoworkerCompanyName" type="string | undefined">
  Company name associated with the member, if any.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].MondayAttendance" type="eCoworkerAttendance">
  Monday attendance status: `1` = Office, `2` = Home, `3` = Abroad, `4` = Not Working, `5` = Undefined.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].TuesdayAttendance" type="eCoworkerAttendance">
  Tuesday attendance status (same values as Monday).
</ResponseField>

<ResponseField name="Attendance.Coworkers[].WednesdayAttendance" type="eCoworkerAttendance">
  Wednesday attendance status.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].ThursdayAttendance" type="eCoworkerAttendance">
  Thursday attendance status.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].FridayAttendance" type="eCoworkerAttendance">
  Friday attendance status.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].SaturdayAttendance" type="eCoworkerAttendance">
  Saturday attendance status.
</ResponseField>

<ResponseField name="Attendance.Coworkers[].SundayAttendance" type="eCoworkerAttendance">
  Sunday attendance status.
</ResponseField>

### Attendance.Days\[]

<ResponseField name="Attendance.Days[].Date" type="string">
  ISO 8601 date for this day.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings" type="AttendanceBooking[]">
  Bookings on this day.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].Id" type="number">
  Booking identifier.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].FromTime" type="string">
  Booking start time.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].ToTime" type="string">
  Booking end time.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].ResourceId" type="number">
  Identifier of the booked resource.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].ResourceName" type="string">
  Name of the booked resource.
</ResponseField>

<ResponseField name="Attendance.Days[].Bookings[].CoworkerId" type="number | undefined">
  Customer who owns the booking, if applicable.
</ResponseField>

## Examples

### Fetch attendance for a week

```http theme={null}
GET /api/public/teams/55/attendance?date=2025-01-20T00:00:00.000Z
Authorization: Bearer {token}
```

```json theme={null}
{
  "IsTeamAdministrator": true,
  "Attendance": {
    "TeamId": 55,
    "TeamName": "Tech Innovators",
    "AvgBookedMinutesPerWeek": 480,
    "AvgBookingsCoworkersPerDay": 3,
    "AvgCheckedinCoworkersPerDay": 5,
    "AvgCheckinsDaysPerWeek": 4.2,
    "Coworkers": [
      {
        "CoworkerId": 101,
        "CoworkerFullName": "Jane Smith",
        "CoworkerType": 1,
        "CoworkerCompanyName": "Tech Innovators Ltd",
        "MondayAttendance": 1,
        "TuesdayAttendance": 1,
        "WednesdayAttendance": 2,
        "ThursdayAttendance": 1,
        "FridayAttendance": 2,
        "SaturdayAttendance": 4,
        "SundayAttendance": 4
      }
    ],
    "Days": [
      {
        "Date": "2025-01-20T00:00:00",
        "Bookings": [
          {
            "Id": 5001,
            "FromTime": "09:00",
            "ToTime": "17:00",
            "ResourceId": 201,
            "ResourceName": "Meeting Room A",
            "CoworkerId": 101
          }
        ]
      }
    ]
  }
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { TeamAttendance } from '@/types/endpoints/TeamAttandance'
import { useData } from '@/hooks/useData'
import { DateTime } from 'luxon'

const { resource: attendance } = useData<TeamAttendance>(httpClient, endpoints.teams.attendance(teamId, DateTime.now()))
```

## Usage in Portal

| Context                                                     | Source file                                                                 |
| ----------------------------------------------------------- | --------------------------------------------------------------------------- |
| Team dashboard attendance KPIs (`/dashboard/team/{teamId}`) | `src/views/user/dashboards/team/components/TeamAttendanceKpiSection.tsx`    |
| Team attendance section (`/team/attendance/{teamId}`)       | `src/views/user/team/attendance/components/TeamAttedanceSection.tsx`        |
| Attendance management (`/team/attendance/{teamId}`)         | `src/views/user/team/attendance/components/AttendanceManagementSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description                          |
| ------ | --------------------------------------- | ------------------------------------ |
| `PUT`  | `/api/public/teams/{teamId}/attendance` | Update member attendance preferences |
| `GET`  | `/api/public/teams/{teamId}/kpi`        | Team KPI data                        |
| `GET`  | `/api/public/teams/{teamId}/metrics`    | Team performance metrics             |
| `GET`  | `/api/public/teams/{teamId}/profile`    | Full team profile                    |


# Update Team Attendance
Source: https://learn.nexudus.com/api/endpoints/teams/team-attendance-update

PUT /api/public/teams/{teamId}/attendance
Updates per-member weekly attendance preferences for a team.

# Update Team Attendance

Updates the weekly attendance preferences for one or more team members. Each entry specifies a member and their day-of-week attendance status (office, home, abroad, not working). Only team administrators can update attendance.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Request Body

The request body is an **array** of attendance update objects. Each object specifies a member and one or more day-of-week attendance values.

<ParamField type="number">
  Numeric identifier of the team member whose attendance is being updated.
</ParamField>

<ParamField type="number">
  Monday attendance status: `1` = Office, `2` = Home, `3` = Abroad, `4` = Not Working, `5` = Undefined.
</ParamField>

<ParamField type="number">
  Tuesday attendance status (same values).
</ParamField>

<ParamField type="number">
  Wednesday attendance status.
</ParamField>

<ParamField type="number">
  Thursday attendance status.
</ParamField>

<ParamField type="number">
  Friday attendance status.
</ParamField>

<ParamField type="number">
  Saturday attendance status.
</ParamField>

<ParamField type="number">
  Sunday attendance status.
</ParamField>

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Update attendance for two members

```http theme={null}
PUT /api/public/teams/55/attendance
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
[
  {
    "CoworkerId": 101,
    "MondayAttendance": 1,
    "TuesdayAttendance": 1,
    "WednesdayAttendance": 2,
    "ThursdayAttendance": 1,
    "FridayAttendance": 2,
    "SaturdayAttendance": 4,
    "SundayAttendance": 4
  },
  {
    "CoworkerId": 102,
    "WednesdayAttendance": 1,
    "FridayAttendance": 3
  }
]
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

const data = Object.entries(updatedAttendance).map(([coworkerId, updates]) => ({
  CoworkerId: Number(coworkerId),
  ...updates,
}))

await httpClient.put(endpoints.teams.attendanceUpdate(teamId), data)
```

## Usage in Portal

| Context                                                | Source file                                                          |
| ------------------------------------------------------ | -------------------------------------------------------------------- |
| Attendance matrix editor (`/team/attendance/{teamId}`) | `src/views/user/team/attendance/components/TeamAttendanceMatrix.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Invalid request data — for example, an invalid attendance value or unknown member ID.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description                 |
| ------ | --------------------------------------- | --------------------------- |
| `GET`  | `/api/public/teams/{teamId}/attendance` | Get current attendance data |
| `GET`  | `/api/public/teams/{teamId}/kpi`        | Team KPI data               |
| `GET`  | `/api/public/teams/{teamId}/profile`    | Full team profile           |
| `GET`  | `/api/public/teams/my`                  | List the customer's teams   |


# Get Team Profile
Source: https://learn.nexudus.com/api/endpoints/teams/team-details

GET /api/public/teams/{teamId}/profile
Returns the full profile for a single team, including members, billing settings, and social links.

# Get Team Profile

Returns the complete profile for a specific team, including member lists, billing configuration, social media links, and media flags. Team administrators use this to manage the team's public profile; regular members use it for read-only access.

<Note>
  A **team** is a group of customers within a coworking location that can share resources, bookings, and billing. The portal maps teams to companies
  or departments that co-habit a space.
</Note>

## Authentication

Requires a valid customer bearer token. The customer must be a member or administrator of the requested team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` in the `Records` array from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated dot-notated field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. **Example**:
  `_shape=Name,ProfileSummary,ProfileIsPublic,TeamMembers`
</ParamField>

## Response

Returns a single team profile object (not wrapped in a list envelope).

### Core Fields

<ResponseField name="Id" type="number">
  Unique integer identifier. Use as `{teamId}` in all team-scoped endpoints.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID for the team — stable across renames and useful as a cache key.
</ResponseField>

<ResponseField name="IdString" type="string">
  String cast of `Id`. Provided for environments that lose integer precision.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the team.
</ResponseField>

### Profile

<ResponseField name="Description" type="string | null">
  Full-length team description. May contain HTML.
</ResponseField>

<ResponseField name="ProfileSummary" type="string">
  Short tagline shown in team cards and selectors.
</ResponseField>

<ResponseField name="ProfileIsPublic" type="boolean">
  When `true`, the team profile is visible in the public member directory.
</ResponseField>

<ResponseField name="ProfileWebsite" type="string | null">
  Team website URL.
</ResponseField>

<ResponseField name="ProfileTags" type="string">
  Space-separated tag string. Use `ProfileTagsList` for array access.
</ResponseField>

<ResponseField name="ProfileTagsList" type="string[]">
  Pre-split array of tag strings derived from `ProfileTags`.
</ResponseField>

### Location

<ResponseField name="BusinessName" type="string">
  Name of the coworking location this team belongs to.
</ResponseField>

<ResponseField name="BusinessHomeUrl" type="string">
  URL of the coworking location's home page.
</ResponseField>

### Social Media

All social fields are `string | null`. Provide a full URL unless stated otherwise.

| Field       | Description               |
| ----------- | ------------------------- |
| `Twitter`   | X / Twitter profile URL   |
| `Facebook`  | Facebook page URL         |
| `Linkedin`  | LinkedIn company page URL |
| `Instagram` | Instagram profile URL     |
| `Github`    | GitHub org or user URL    |
| `Pinterest` | Pinterest profile URL     |
| `Skype`     | Skype username            |
| `Telegram`  | Telegram handle           |
| `Flickr`    | Flickr profile URL        |
| `Vimeo`     | Vimeo channel URL         |
| `Tumblr`    | Tumblr blog URL           |
| `Blogger`   | Blogger profile URL       |

### Members

<ResponseField name="TeamMembersCount" type="number">
  Total count of active members (admins + regular members).
</ResponseField>

<ResponseField name="TeamAdministratorsFullNames" type="string[]">
  Display names of all team admins.
</ResponseField>

<ResponseField name="TeamAdministrators" type="Customer[]">
  Full `Customer` objects for admins only.
</ResponseField>

<ResponseField name="TeamMembers" type="Customer[]">
  Full `Customer` objects for non-admin members.
</ResponseField>

<ResponseField name="AllTeamMembers" type="Customer[]">
  Combined `Customer` objects for all members (admins + regular). Use this instead of merging the two arrays above.
</ResponseField>

### Billing & Configuration

<ResponseField name="PayingMemberId" type="number | null">
  Customer ID of the member who receives consolidated invoices, if `CreateSingleInvoiceForTeam` is `true`.
</ResponseField>

<ResponseField name="CreateSingleInvoiceForTeam" type="boolean">
  When `true`, all team charges are rolled into a single invoice addressed to `PayingMemberId`.
</ResponseField>

<ResponseField name="MaxTeamMemberCount" type="number | null">
  Maximum allowed members. `null` means unlimited.
</ResponseField>

<ResponseField name="HasContactDetails" type="boolean">
  Whether billing/contact details have been configured for this team.
</ResponseField>

<ResponseField name="HasDefaultPlan" type="boolean">
  Whether the team has a default membership plan assigned.
</ResponseField>

<ResponseField name="DefaultTariffId" type="number | null">
  ID of the default membership plan assigned to new team members.
</ResponseField>

<ResponseField name="DefaultTariffName" type="string | null">
  Display name of the default membership plan.
</ResponseField>

<ResponseField name="DefaultMemberTariffKeepNewAccountsOnHold" type="boolean">
  When `true`, new members added to the team are placed on hold until manually activated.
</ResponseField>

<ResponseField name="DisableAttendaceDashboard" type="boolean">
  When `true`, the attendance dashboard is hidden for this team. Note the typo in the field name (`Attendace`) — it is preserved as-is in the API.
</ResponseField>

<ResponseField name="DiscountCharges" type="number | null">
  Percentage discount applied to charges for team members.
</ResponseField>

<ResponseField name="DiscountExtraServices" type="number | null">
  Percentage discount applied to extra services for team members.
</ResponseField>

<ResponseField name="DiscountTariffs" type="number | null">
  Percentage discount applied to membership plans for team members.
</ResponseField>

<ResponseField name="DiscountTimePasses" type="number | null">
  Percentage discount applied to time passes for team members.
</ResponseField>

<ResponseField name="HasCommunityGroup" type="boolean">
  When `true`, the team has an associated community discussion group.
</ResponseField>

<ResponseField name="GoogleMapsLink" type="string | null">
  Google Maps link for the team's location.
</ResponseField>

### Media

<ResponseField name="HasTeamLogo" type="boolean">
  `true` if the team has an uploaded logo. Construct the logo URL as: `https://[space].spaces.nexudus.com/api/public/teams/{Id}/logo`
</ResponseField>

<ResponseField name="HasImage1" type="boolean">
  `true` if profile image 1 has been uploaded.
</ResponseField>

<ResponseField name="HasImage2" type="boolean">
  `true` if profile image 2 has been uploaded.
</ResponseField>

<ResponseField name="HasImage3" type="boolean">
  `true` if profile image 3 has been uploaded.
</ResponseField>

<ResponseField name="HasImages" type="boolean">
  Convenience flag — `true` if any of the three profile images are present.
</ResponseField>

### Timestamps

All datetime fields are ISO 8601 strings. `*On` fields are in the location's local timezone; `*OnUtc` fields are UTC.

<ResponseField name="CreatedOn" type="string">
  Local datetime the team was created.
</ResponseField>

<ResponseField name="CreatedOnUtc" type="string">
  UTC datetime the team was created.
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Local datetime of the last update.
</ResponseField>

<ResponseField name="UpdatedOnUtc" type="string">
  UTC datetime of the last update.
</ResponseField>

## Examples

### Fetch full team profile

```http theme={null}
GET /api/public/teams/55/profile
Authorization: Bearer {token}
```

```json theme={null}
{
  "Id": 55,
  "IdString": "55",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "Name": "Tech Innovators",
  "Description": "A collaborative team focused on cutting-edge technology solutions",
  "ProfileSummary": "Building the future, one innovation at a time",
  "ProfileIsPublic": true,
  "ProfileWebsite": "https://techinnovators.example.com",
  "ProfileTags": "technology startup innovation collaboration",
  "ProfileTagsList": ["technology", "startup", "innovation", "collaboration"],
  "BusinessName": "Downtown Coworking Hub",
  "BusinessHomeUrl": "https://downtown-hub.example.com",
  "Twitter": "https://twitter.com/techinnovators",
  "Facebook": null,
  "Linkedin": "https://linkedin.com/company/techinnovators",
  "Instagram": null,
  "Github": "https://github.com/techinnovators",
  "Pinterest": null,
  "Skype": null,
  "Telegram": null,
  "Flickr": null,
  "Vimeo": null,
  "Tumblr": null,
  "Blogger": null,
  "TeamMembersCount": 12,
  "TeamAdministratorsFullNames": ["Jane Smith", "John Doe"],
  "TeamAdministrators": [
    {
      "Id": 101,
      "FullName": "Jane Smith",
      "Email": "jane@techinnovators.com"
    }
  ],
  "TeamMembers": [
    {
      "Id": 102,
      "FullName": "Bob Wilson",
      "Email": "bob@techinnovators.com"
    }
  ],
  "AllTeamMembers": [
    {
      "Id": 101,
      "FullName": "Jane Smith",
      "Email": "jane@techinnovators.com"
    },
    {
      "Id": 102,
      "FullName": "Bob Wilson",
      "Email": "bob@techinnovators.com"
    }
  ],
  "PayingMemberId": 101,
  "CreateSingleInvoiceForTeam": true,
  "HasContactDetails": true,
  "HasDefaultPlan": true,
  "MaxTeamMemberCount": 20,
  "DisableAttendaceDashboard": false,
  "HasTeamLogo": true,
  "HasImage1": true,
  "HasImage2": false,
  "HasImage3": false,
  "HasImages": true,
  "CreatedOn": "2024-01-15T09:30:00",
  "UpdatedOn": "2024-07-20T14:22:33",
  "CreatedOnUtc": "2024-01-15T09:30:00Z",
  "UpdatedOnUtc": "2024-07-20T14:22:33Z"
}
```

### Fetch profile with a minimal field set

Use `_shape` to request only the fields your UI needs, reducing payload size.

```http theme={null}
GET /api/public/teams/55/profile?_shape=Name,ProfileSummary,ProfileIsPublic,TeamMembersCount
Authorization: Bearer {token}
```

```json theme={null}
{
  "Name": "Tech Innovators",
  "ProfileSummary": "Building the future, one innovation at a time",
  "ProfileIsPublic": true,
  "TeamMembersCount": 12
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { Team } from '@/types/endpoints/TeamList'
import { useData } from '@/hooks/useData'

const { resource: team } = useData<Team>(httpClient, endpoints.teams.one(teamId), {
  shape: {
    fields: ['Name', 'ProfileWebsite', 'ProfileSummary', 'ProfileTagsList', 'ProfileIsPublic', 'TeamMembers'],
  },
})
```

## Usage in Portal

| Context                                                   | Source file                                                   |
| --------------------------------------------------------- | ------------------------------------------------------------- |
| Team Professional Profile Page (`/team/profile/{teamId}`) | `src/views/user/team/profile/TeamProfessionalProfilePage.tsx` |
| Team Dashboard (`/dashboard/team/{teamId}`)               | `src/views/user/dashboards/team/TeamDashboardPage.tsx`        |
| Team Permissions (`/team/permissions/{teamId}`)           | `src/views/user/team/permissions/TeamPermissionsPage.tsx`     |
| Team Bookings (`/team/bookings/{teamId}`)                 | `src/views/user/team/bookings/TeamBookingsPage.tsx`           |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated, the session has expired, or the customer is not a member of the specified team.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description                      |
| ------ | --------------------------------------- | -------------------------------- |
| `GET`  | `/api/public/teams/my`                  | List the customer's teams        |
| `PUT`  | `/api/public/teams/{teamId}/profile`    | Update team profile (admin only) |
| `GET`  | `/api/public/teams/{teamId}/kpi`        | Team KPI metrics                 |
| `GET`  | `/api/public/teams/{teamId}/attendance` | Team attendance data             |
| `GET`  | `/api/public/teams/{teamId}/metrics`    | Team performance metrics         |


# Update Team Profile
Source: https://learn.nexudus.com/api/endpoints/teams/team-details-update

PUT /api/public/teams/{teamId}/profile
Updates the profile, social links, and public visibility settings for a team.

# Update Team Profile

Updates the profile information for a specific team, including display name, social media links, and public visibility. Only team administrators can call this endpoint; partial updates are supported.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` in the `Records` array from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Request Body

The request body should contain the team profile fields to update. Only include fields that are being modified — partial updates are supported.

### Basic Information

<ParamField type="string">
  Display name of the team. Cannot be empty.
</ParamField>

<ParamField type="string">
  Full-length team description. May contain HTML. Omit to leave unchanged.
</ParamField>

<ParamField type="string">
  Short tagline shown in team cards and selectors.
</ParamField>

<ParamField type="boolean">
  When `true`, the team profile is visible in the public member directory.
</ParamField>

<ParamField type="string">
  Team website URL. Must be a valid URL format when provided.
</ParamField>

<ParamField type="string">
  Space-separated tags describing the team.
</ParamField>

### Social Media

All social media fields are optional `string` values. Must be valid URL format when provided (except `Skype` which accepts a username).

| Field       | Description               |
| ----------- | ------------------------- |
| `Twitter`   | X / Twitter profile URL   |
| `Facebook`  | Facebook page URL         |
| `Linkedin`  | LinkedIn company page URL |
| `Instagram` | Instagram profile URL     |
| `Github`    | GitHub org or user URL    |
| `Pinterest` | Pinterest profile URL     |
| `Skype`     | Skype username            |
| `Telegram`  | Telegram handle           |
| `Flickr`    | Flickr profile URL        |
| `Vimeo`     | Vimeo channel URL         |
| `Tumblr`    | Tumblr blog URL           |
| `Blogger`   | Blogger profile URL       |

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Update team name and social links

```http theme={null}
PUT /api/public/teams/55/profile
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "Name": "Tech Innovators Updated",
  "ProfileSummary": "Building the future, one innovation at a time — now with AI focus",
  "ProfileIsPublic": true,
  "ProfileWebsite": "https://techinnovators-ai.example.com",
  "ProfileTags": "technology startup innovation collaboration AI machine-learning",
  "Twitter": "https://twitter.com/techinnovators_ai",
  "Linkedin": "https://linkedin.com/company/techinnovators-ai",
  "Github": "https://github.com/techinnovators-ai"
}
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { Team } from '@/types/endpoints/TeamList'

const updateTeamProfile = async (teamId: number, profileData: Partial<Team>) => {
  await httpClient.put(endpoints.teams.one(teamId), profileData)
}
```

## Usage in Portal

| Context                                                   | Source file                                                          |
| --------------------------------------------------------- | -------------------------------------------------------------------- |
| Team Professional Profile Page (`/team/profile/{teamId}`) | `src/views/user/team/profile/TeamProfessionalProfilePage.tsx`        |
| Team Professional Profile form component                  | `src/views/user/team/profile/components/TeamProfessionalProfile.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Invalid request data — for example, missing required `Name` field or invalid URL format in a social media field.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description               |
| ------ | --------------------------------------- | ------------------------- |
| `GET`  | `/api/public/teams/{teamId}/profile`    | Get current team profile  |
| `GET`  | `/api/public/teams/my`                  | List the customer's teams |
| `GET`  | `/api/public/teams/{teamId}/kpi`        | Team KPI metrics          |
| `GET`  | `/api/public/teams/{teamId}/attendance` | Team attendance data      |
| `GET`  | `/api/public/teams/{teamId}/metrics`    | Team performance metrics  |


# Update Team Profile Images
Source: https://learn.nexudus.com/api/endpoints/teams/team-images-update

PATCH /api/public/teams/{teamId}/profile/images
Uploads, replaces, or deletes team profile images (logo and up to 3 additional images).

# Update Team Profile Images

Uploads, replaces, or deletes team profile images, including the team logo and up to 3 additional images. Only team administrators can call this endpoint.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` in the `Records` array from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Request Body

The request body can include **either** Base64-encoded images to upload/replace **or** delete flags to remove existing images. You can combine both in a single request.

### Upload or Replace Images

Provide the full Base64-encoded image data (including the data URI prefix, e.g. `data:image/png;base64,...`) for any image you want to upload or replace.

<ParamField type="string">
  Full Base64-encoded string for the team logo, including the data URI prefix (e.g. `data:image/png;base64,iVBORw0KGgo...`). Omit or set to `null` to leave unchanged.
</ParamField>

<ParamField type="string">
  Full Base64-encoded string for the first team image. Omit or set to `null` to leave unchanged.
</ParamField>

<ParamField type="string">
  Full Base64-encoded string for the second team image. Omit or set to `null` to leave unchanged.
</ParamField>

<ParamField type="string">
  Full Base64-encoded string for the third team image. Omit or set to `null` to leave unchanged.
</ParamField>

### Delete Images

Set the corresponding delete flag to `true` to remove an existing image.

<ParamField type="boolean">
  Set to `true` to delete the current team logo. Default is `false`.
</ParamField>

<ParamField type="boolean">
  Set to `true` to delete the current first team image. Default is `false`.
</ParamField>

<ParamField type="boolean">
  Set to `true` to delete the current second team image. Default is `false`.
</ParamField>

<ParamField type="boolean">
  Set to `true` to delete the current third team image. Default is `false`.
</ParamField>

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Upload a new team logo

```http theme={null}
PATCH /api/public/teams/55/profile/images
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "Base64TeamLogo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}
```

```
Status: 200 OK
Body: (empty)
```

### Delete an existing team image

```http theme={null}
PATCH /api/public/teams/55/profile/images
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "DeleteTeamImage1": true
}
```

```
Status: 200 OK
Body: (empty)
```

### Replace logo and delete an old image in one request

```http theme={null}
PATCH /api/public/teams/55/profile/images
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "Base64TeamLogo": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
  "DeleteTeamImage2": true
}
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

const updateTeamImages = async (
  teamId: number,
  imagePayload: {
    base64TeamLogo?: string | null
    base64TeamImage1?: string | null
    base64TeamImage2?: string | null
    base64TeamImage3?: string | null
    deleteTeamLogo?: boolean
    deleteTeamImage1?: boolean
    deleteTeamImage2?: boolean
    deleteTeamImage3?: boolean
  }
) => {
  await httpClient.patch(
    endpoints.teams.patchImages(teamId),
    imagePayload
  )
}
```

## Usage in Portal

| Context                                                        | Source file                                                          |
| -------------------------------------------------------------- | -------------------------------------------------------------------- |
| Team Professional Profile Page (`/team/profile/{teamId}`)      | `src/views/user/team/profile/TeamProfessionalProfilePage.tsx`        |
| Team Professional Profile form component (image upload fields) | `src/views/user/team/profile/components/TeamProfessionalProfile.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Invalid request data — for example, malformed Base64 encoding.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                             | Description                |
| ------ | ------------------------------------ | -------------------------- |
| `PUT`  | `/api/public/teams/{teamId}/profile` | Update team profile fields |
| `GET`  | `/api/public/teams/{teamId}/profile` | Get current team profile   |
| `GET`  | `/api/public/teams/my`               | List the customer's teams  |
| `GET`  | `/api/public/teams/{teamId}/kpi`     | Team KPI metrics           |


# Get Team KPIs
Source: https://learn.nexudus.com/api/endpoints/teams/team-kpi

GET /api/public/teams/{teamId}/kpi
Returns per-member KPI data for a team, including uninvoiced charges, remaining credits, and usage totals.

# Get Team KPIs

Returns key performance indicators for every member of a team. Each entry includes uninvoiced charges, remaining booking and time credits, and total/monthly usage. Used on the team dashboard to give administrators a quick financial and usage overview.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

<ResponseField name="Kpi" type="TeamKpi[]">
  Array of per-member KPI objects.
</ResponseField>

### Per-Member Fields

<ResponseField name="Kpi[].CoworkerId" type="number">
  Numeric identifier of the team member.
</ResponseField>

<ResponseField name="Kpi[].CoworkerFullName" type="string">
  Display name of the team member.
</ResponseField>

<ResponseField name="Kpi[].CoworkerEmail" type="string">
  Email address of the team member.
</ResponseField>

<ResponseField name="Kpi[].UninvoicedProducts" type="number">
  Count of purchased products not yet invoiced.
</ResponseField>

<ResponseField name="Kpi[].UninvoicedExtraServices" type="number">
  Count of extra services not yet invoiced.
</ResponseField>

<ResponseField name="Kpi[].UnivoicedEventAttendees" type="number">
  Count of event attendee charges not yet invoiced. Note the typo (`Univoiced`) — it is preserved as-is in the API.
</ResponseField>

<ResponseField name="Kpi[].UnivoicedTimepasses" type="number">
  Count of time passes not yet invoiced. Note the typo (`Univoiced`) — it is preserved as-is in the API.
</ResponseField>

<ResponseField name="Kpi[].RemainingBookingCredit" type="number">
  Remaining booking credit balance.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimeCreditMinutes" type="number">
  Remaining time credit in minutes.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimeCreditDays" type="number">
  Remaining time credit in days.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimeCreditWeeks" type="number">
  Remaining time credit in weeks.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimeCreditMonths" type="number">
  Remaining time credit in months.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimeCreditUses" type="number">
  Remaining time credit uses.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimePassesMinutes" type="number">
  Remaining time pass minutes.
</ResponseField>

<ResponseField name="Kpi[].RemainingTimePassesCount" type="number">
  Remaining time pass count.
</ResponseField>

<ResponseField name="Kpi[].BookedTimeTotal" type="number">
  Total booked time in minutes across all time.
</ResponseField>

<ResponseField name="Kpi[].BookedTimeThisMonth" type="number">
  Total booked time in minutes for the current month.
</ResponseField>

<ResponseField name="Kpi[].CheckedTimeTotal" type="number">
  Total checked-in time in minutes across all time.
</ResponseField>

<ResponseField name="Kpi[].CheckedTimeThisMonth" type="number">
  Total checked-in time in minutes for the current month.
</ResponseField>

## Examples

### Fetch team KPIs

```http theme={null}
GET /api/public/teams/55/kpi
Authorization: Bearer {token}
```

```json theme={null}
{
  "Kpi": [
    {
      "CoworkerId": 101,
      "CoworkerFullName": "Jane Smith",
      "CoworkerEmail": "jane@techinnovators.com",
      "UninvoicedProducts": 2,
      "UninvoicedExtraServices": 0,
      "UnivoicedEventAttendees": 1,
      "UnivoicedTimepasses": 0,
      "RemainingBookingCredit": 500,
      "RemainingTimeCreditMinutes": 120,
      "RemainingTimeCreditDays": 0,
      "RemainingTimeCreditWeeks": 0,
      "RemainingTimeCreditMonths": 0,
      "RemainingTimeCreditUses": 5,
      "RemainingTimePassesMinutes": 60,
      "RemainingTimePassesCount": 1,
      "BookedTimeTotal": 4200,
      "BookedTimeThisMonth": 360,
      "CheckedTimeTotal": 3800,
      "CheckedTimeThisMonth": 300
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { TeamKpiList } from '@/types/endpoints/TeamKpi'
import { useData } from '@/hooks/useData'

const { resource: kpiData } = useData<TeamKpiList>(httpClient, endpoints.teams.kpi(teamId), { shape: { fields: ['Kpi'] } })
```

## Usage in Portal

| Context                                                 | Source file                                                    |
| ------------------------------------------------------- | -------------------------------------------------------------- |
| Team dashboard KPI section (`/dashboard/team/{teamId}`) | `src/views/user/dashboards/team/components/TeamKpiSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description               |
| ------ | --------------------------------------- | ------------------------- |
| `GET`  | `/api/public/teams/{teamId}/metrics`    | Team performance metrics  |
| `GET`  | `/api/public/teams/{teamId}/attendance` | Team attendance data      |
| `GET`  | `/api/public/teams/{teamId}/profile`    | Full team profile         |
| `GET`  | `/api/public/teams/my`                  | List the customer's teams |


# Get Team Meta
Source: https://learn.nexudus.com/api/endpoints/teams/team-meta

GET /api/public/teams/{teamGuidId}/meta
Returns lightweight metadata for a team, including its name, member cap, and default plan.

# Get Team Meta

Returns a minimal metadata object for a team identified by its GUID. Used during checkout flows to resolve team details without loading the full profile — for example, to display the team name and validate member limits when signing up for a tariff.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="string">
  The team's UUID (`UniqueId`). Returned as `UniqueId` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns a flat object with core team metadata.

<ResponseField name="Id" type="number">
  Numeric identifier for the team.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the team.
</ResponseField>

<ResponseField name="MaxTeamMemberCount" type="number">
  Maximum allowed members. `0` or absent means unlimited.
</ResponseField>

<ResponseField name="Tariff" type="object | undefined">
  The team's default membership plan, if one is assigned.
</ResponseField>

<ResponseField name="Tariff.Id" type="number">
  Numeric identifier of the default plan.
</ResponseField>

<ResponseField name="Tariff.UniqueId" type="string">
  UUID of the default plan.
</ResponseField>

<ResponseField name="Tariff.Name" type="string">
  Display name of the default plan.
</ResponseField>

## Examples

### Fetch team meta by GUID

```http theme={null}
GET /api/public/teams/a1b2c3d4-e5f6-7890-abcd-ef1234567890/meta
Authorization: Bearer {token}
```

```json theme={null}
{
  "Id": 55,
  "Name": "Tech Innovators",
  "MaxTeamMemberCount": 20,
  "Tariff": {
    "Id": 301,
    "UniqueId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "Name": "Team Professional"
  }
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

const endpoint = endpoints.teams.meta(teamGuidId)
const { data } = await httpClient.get<typeof endpoint.type>(endpoint.url)
```

## Usage in Portal

| Context                              | Source file                                     |
| ------------------------------------ | ----------------------------------------------- |
| Tariff signup step (`/checkout/...`) | `src/views/checkout/steps/TariffSignupStep.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  No team exists with the specified GUID.
</ResponseField>

## Related Endpoints

| Method | Endpoint                             | Description               |
| ------ | ------------------------------------ | ------------------------- |
| `GET`  | `/api/public/teams/my`               | List the customer's teams |
| `GET`  | `/api/public/teams/{teamId}/profile` | Full team profile         |
| `GET`  | `/api/public/teams/{teamId}/kpi`     | Team KPI metrics          |


# Get Team Metrics
Source: https://learn.nexudus.com/api/endpoints/teams/team-metrics

GET /api/public/teams/{teamId}/metrics
Returns monthly financial and usage metrics for a team, including invoiced amounts, bookings, and check-in time.

# Get Team Metrics

Returns an array of monthly metric snapshots for a team. Each entry covers one calendar month and includes invoiced amounts, booking and check-in minutes, revenue, and outstanding charges. Used on the team dashboard to render trend charts.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

## Query Parameters

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

<ResponseField name="Metrics" type="TeamMetric[]">
  Array of monthly metric snapshots, ordered chronologically.
</ResponseField>

### Per-Month Fields

<ResponseField name="Metrics[].Id" type="number">
  Unique identifier for the metric record.
</ResponseField>

<ResponseField name="Metrics[].MonthDate" type="string">
  ISO 8601 date representing the first day of the month this record covers.
</ResponseField>

<ResponseField name="Metrics[].CurrencyCode" type="string">
  ISO 4217 currency code for all monetary values in this record.
</ResponseField>

<ResponseField name="Metrics[].InvoicedAmount" type="number">
  Total invoiced amount for the member in this month.
</ResponseField>

<ResponseField name="Metrics[].TeamInvoicedAmount" type="number">
  Total invoiced amount across the entire team in this month.
</ResponseField>

<ResponseField name="Metrics[].Revenue" type="number">
  Total revenue for the team in this month.
</ResponseField>

<ResponseField name="Metrics[].CheckingMinutes" type="number">
  Member's checked-in time in minutes.
</ResponseField>

<ResponseField name="Metrics[].TeamCheckingMinutes" type="number">
  Total team checked-in time in minutes.
</ResponseField>

<ResponseField name="Metrics[].BookingMinutes" type="number">
  Member's booked time in minutes.
</ResponseField>

<ResponseField name="Metrics[].TeamBookingMinutes" type="number">
  Total team booked time in minutes.
</ResponseField>

<ResponseField name="Metrics[].TotalBookings" type="number">
  Total number of bookings.
</ResponseField>

<ResponseField name="Metrics[].TotalTariffs" type="number">
  Total number of active membership plans.
</ResponseField>

<ResponseField name="Metrics[].TotalOther" type="number">
  Total other charges.
</ResponseField>

<ResponseField name="Metrics[].TimePasses" type="number">
  Number of time passes used.
</ResponseField>

<ResponseField name="Metrics[].Bookings" type="number">
  Revenue from bookings.
</ResponseField>

<ResponseField name="Metrics[].TotalUnpaid" type="number">
  Total unpaid amount.
</ResponseField>

<ResponseField name="Metrics[].TotalUnpaidNexKiosk" type="number">
  Total unpaid NexKiosk charges.
</ResponseField>

<ResponseField name="Metrics[].TotalDue" type="number">
  Total amount currently due.
</ResponseField>

<ResponseField name="Metrics[].UnPaidAttendees" type="number">
  Unpaid event attendee charges.
</ResponseField>

<ResponseField name="Metrics[].NotInvoicedCharges" type="number">
  Total charges not yet invoiced.
</ResponseField>

<ResponseField name="Metrics[].UnInvoicedCharges" type="number">
  Uninvoiced miscellaneous charges.
</ResponseField>

<ResponseField name="Metrics[].UnInvoicedProducts" type="number">
  Uninvoiced product charges.
</ResponseField>

<ResponseField name="Metrics[].UnInvoicedTimePasses" type="number">
  Uninvoiced time pass charges.
</ResponseField>

<ResponseField name="Metrics[].UnInvoicedExtraServices" type="number">
  Uninvoiced extra service charges.
</ResponseField>

<ResponseField name="Metrics[].NextInvoice" type="string | null">
  ISO 8601 datetime of the next scheduled invoice, or `null` if none is scheduled.
</ResponseField>

<ResponseField name="Metrics[].DasySinceLastAccess" type="number">
  Days since the member's last portal access. Note the typo (`Dasy`) — it is preserved as-is in the API.
</ResponseField>

## Examples

### Fetch team metrics

```http theme={null}
GET /api/public/teams/55/metrics
Authorization: Bearer {token}
```

```json theme={null}
{
  "Metrics": [
    {
      "Id": 1001,
      "MonthDate": "2025-01-01T00:00:00",
      "CurrencyCode": "GBP",
      "InvoicedAmount": 1250.0,
      "TeamInvoicedAmount": 8500.0,
      "Revenue": 8500.0,
      "CheckingMinutes": 2400,
      "TeamCheckingMinutes": 18000,
      "BookingMinutes": 480,
      "TeamBookingMinutes": 3200,
      "TotalBookings": 15,
      "TotalTariffs": 12,
      "TotalOther": 0,
      "TimePasses": 3,
      "Bookings": 450.0,
      "TotalUnpaid": 200.0,
      "TotalUnpaidNexKiosk": 0,
      "TotalDue": 200.0,
      "UnPaidAttendees": 0,
      "NotInvoicedCharges": 50.0,
      "UnInvoicedCharges": 25.0,
      "UnInvoicedProducts": 15.0,
      "UnInvoicedTimePasses": 10.0,
      "UnInvoicedExtraServices": 0,
      "NextInvoice": "2025-02-01T00:00:00",
      "DasySinceLastAccess": 2
    }
  ]
}
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { TeamMetrics } from '@/types/endpoints/TeamMetrics'
import { useData } from '@/hooks/useData'

const { resource: metricsData } = useData<TeamMetrics>(httpClient, endpoints.teams.metrics(teamId))
```

## Usage in Portal

| Context                                                     | Source file                                                        |
| ----------------------------------------------------------- | ------------------------------------------------------------------ |
| Team dashboard metrics section (`/dashboard/team/{teamId}`) | `src/views/user/dashboards/team/components/TeamMetricsSection.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method | Endpoint                                | Description               |
| ------ | --------------------------------------- | ------------------------- |
| `GET`  | `/api/public/teams/{teamId}/kpi`        | Per-member KPI data       |
| `GET`  | `/api/public/teams/{teamId}/attendance` | Team attendance data      |
| `GET`  | `/api/public/teams/{teamId}/profile`    | Full team profile         |
| `GET`  | `/api/public/teams/my`                  | List the customer's teams |


# Update Member Permissions
Source: https://learn.nexudus.com/api/endpoints/teams/team-permissions

PUT /api/public/teams/{teamId}/permissions/{memberId}
Updates the permission flags for a specific member within a team.

# Update Member Permissions

Updates the permission flags for a single team member, controlling what actions they can perform within the team context — such as making bookings, purchasing products, or accessing community features. Only team administrators can modify permissions. An administrator cannot change their own `IsTeamAdministrator` flag.

## Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the team. Returned as `Id` from [`GET /api/public/teams/my`](/api/endpoints/teams/list-teams).
</ParamField>

<ParamField type="number">
  Numeric identifier of the member whose permissions are being updated. Returned as `Id` in the `AllTeamMembers` array from [`GET /api/public/teams/   {teamId}/profile`](/api/endpoints/teams/team-details).
</ParamField>

## Request Body

<ParamField type="number">
  Member ID (mirrors the path parameter).
</ParamField>

<ParamField type="boolean">
  When `true`, grants the member full administrative rights. Disabled when editing one's own permissions.
</ParamField>

<ParamField type="boolean">
  When `true`, the member can create bookings.
</ParamField>

<ParamField type="boolean">
  When `true`, the member can create bookings on behalf of the team.
</ParamField>

<ParamField type="boolean">
  When `true`, the member can purchase products.
</ParamField>

<ParamField type="boolean">
  When `true`, the member can purchase event tickets.
</ParamField>

<ParamField type="boolean">
  When `true`, the member can access community features (directory, discussion boards).
</ParamField>

<ParamField type="string">
  Access card identifier for physical access control. Maximum 15 characters.
</ParamField>

## Response

Returns HTTP `200 OK` with an empty body on success.

## Examples

### Grant admin rights and booking permissions

```http theme={null}
PUT /api/public/teams/55/permissions/102
Authorization: Bearer {token}
Content-Type: application/json
```

```json theme={null}
{
  "Id": 102,
  "IsTeamAdministrator": false,
  "CanMakeBookings": true,
  "CanBookForTeam": true,
  "CanPurchaseProducts": true,
  "CanPurchaseEvents": false,
  "CanAccessCommunity": true,
  "AccessCardId": "CARD-00102"
}
```

```
Status: 200 OK
Body: (empty)
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'

await httpClient.put(endpoints.teams.permissions(teamId, memberId), {
  IsTeamAdministrator: false,
  CanMakeBookings: true,
  CanBookForTeam: true,
  CanPurchaseProducts: true,
  CanPurchaseEvents: false,
  CanAccessCommunity: true,
})
```

## Usage in Portal

| Context                                               | Source file                                                          |
| ----------------------------------------------------- | -------------------------------------------------------------------- |
| Team permissions modal (`/team/permissions/{teamId}`) | `src/views/user/team/permissions/components/TeamPermissionModal.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

<ResponseField name="403 Forbidden" type="error">
  The customer is not an administrator of the specified team.
</ResponseField>

<ResponseField name="400 Bad Request" type="error">
  Invalid request data — for example, `AccessCardId` exceeding 15 characters.
</ResponseField>

<ResponseField name="404 Not Found" type="error">
  Team or member with the specified ID does not exist.
</ResponseField>

## Related Endpoints

| Method   | Endpoint                                          | Description                    |
| -------- | ------------------------------------------------- | ------------------------------ |
| `GET`    | `/api/public/teams/{teamId}/profile`              | Full team profile with members |
| `POST`   | `/api/public/teams/{teamId}/members`              | Add members to a team          |
| `DELETE` | `/api/public/teams/{teamId}/members/{coworkerId}` | Remove a member from a team    |
| `GET`    | `/api/public/teams/my`                            | List the customer's teams      |


# List Team Profiles
Source: https://learn.nexudus.com/api/endpoints/teams/team-profiles

GET /en/team/profiles
Returns team profile summaries including member lists, permissions, and recent bookings for the booking flow.

# List Team Profiles

Returns an array of team profile summaries for teams the authenticated customer belongs to. Each entry includes the team's details, permission flags (can add/remove/cancel members), all team members with their contracts, and recent bookings. Primarily used in the booking flow to populate the "book for team" selector.

<Note>
  This endpoint uses a view-style URL (`/en/team/profiles`) rather than the `/api/public/` convention. It returns server-rendered JSON and is called
  with the `bookForTeam=true` query parameter in the booking context.
</Note>

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  When `true`, scopes the response to teams the customer can book on behalf of. Added conditionally in the booking flow.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation.
</ParamField>

## Response

Returns an array of `TeamProfile` objects (not wrapped in a list envelope).

### TeamProfile Fields

<ResponseField name="[].CanAddNewMembers" type="boolean">
  Whether the authenticated customer can add new members to this team.
</ResponseField>

<ResponseField name="[].CanRemoveMembers" type="boolean">
  Whether the authenticated customer can remove members from this team.
</ResponseField>

<ResponseField name="[].CanCancelMembers" type="boolean">
  Whether the authenticated customer can cancel member contracts in this team.
</ResponseField>

<ResponseField name="[].Team" type="Team">
  Full team object with the same fields as the response from [`GET /api/public/teams/{teamId}/profile`](/api/endpoints/teams/team-details).
</ResponseField>

<ResponseField name="[].RecentBookings" type="any">
  Recent bookings made by team members.
</ResponseField>

<ResponseField name="[].AllTeamMembers" type="AllTeamMember[]">
  Extended member objects that include contract information alongside standard `Customer` fields.
</ResponseField>

<ResponseField name="[].AllTeamMembers[].Contracts" type="CoworkerContract[]">
  Active contracts for this member, including plan name, start date, next invoice date, price, and cancellation details.
</ResponseField>

## Examples

### Fetch team profiles for booking

```http theme={null}
GET /en/team/profiles?bookForTeam=true
Authorization: Bearer {token}
```

```json theme={null}
[
  {
    "CanAddNewMembers": true,
    "CanRemoveMembers": true,
    "CanCancelMembers": false,
    "Team": {
      "Id": 55,
      "Name": "Tech Innovators",
      "BusinessName": "Downtown Coworking Hub",
      "TeamMembersCount": 12,
      "ProfileSummary": "Building the future",
      "MaxTeamMemberCount": 20
    },
    "RecentBookings": null,
    "AllTeamMembers": [
      {
        "Id": 101,
        "FullName": "Jane Smith",
        "Email": "jane@techinnovators.com",
        "Contracts": [
          {
            "Id": 5001,
            "StartDate": "2024-01-15T00:00:00",
            "NextInvoice": "2025-02-01T00:00:00",
            "Price": 250.0,
            "CurrencyCode": "GBP"
          }
        ]
      }
    ]
  }
]
```

## TypeScript Integration

```typescript theme={null}
import { endpoints } from '@/api/endpoints'
import { TeamProfiles } from '@/types/endpoints/TeamProfiles'
import { useData } from '@/hooks/useData'

const { resource: teamProfiles } = useData<TeamProfiles>(httpClient, endpoints.teams.profiles)
```

## Usage in Portal

| Context                                      | Source file                                            |
| -------------------------------------------- | ------------------------------------------------------ |
| Booking flow team selector (`/checkout/...`) | `src/views/public/checkout/booking/useBookingData.tsx` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The customer is not authenticated or the session has expired.
</ResponseField>

## Related Endpoints

| Method | Endpoint                             | Description               |
| ------ | ------------------------------------ | ------------------------- |
| `GET`  | `/api/public/teams/my`               | List the customer's teams |
| `GET`  | `/api/public/teams/{teamId}/profile` | Full team profile         |
| `POST` | `/api/public/teams/{teamId}/members` | Add members to a team     |


# Register Visitor
Source: https://learn.nexudus.com/api/endpoints/visitors/create-visitor

POST /api/public/visitors
Registers a new visitor for the authenticated customer.

# Register Visitor

Registers a new visitor expected at the coworking space. The visitor receives a notification and the front desk is alerted when they arrive.

## Authentication

Requires a valid customer bearer token.

## Request Body

The request body is an **array** of visitor objects. Multiple visitors can be registered in a single request (e.g. for recurring visits).

<ParamField type="number">
  Numeric identifier of the location where the visitor is expected.
</ParamField>

<ParamField type="string">
  Full name of the visitor.
</ParamField>

<ParamField type="string">
  Email address of the visitor (for notifications).
</ParamField>

<ParamField type="string">
  Phone number of the visitor.
</ParamField>

<ParamField type="string">
  Expected arrival date/time in ISO 8601 format.
</ParamField>

<ParamField type="string">
  Notes from the host for the visitor or front desk.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Register a visitor

```http theme={null}
POST /api/public/visitors
Authorization: Bearer {token}
Content-Type: application/json

[
  {
    "BusinessId": 1,
    "FullName": "Sarah Connor",
    "Email": "sarah@example.com",
    "PhoneNumber": "+44 7700 900000",
    "ExpectedArrival": "2026-04-01T10:00:00Z",
    "CustomerNotes": "Meeting in room 3"
  }
]
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const visitors = repeatDates.map((date) => ({
  BusinessId: values.BusinessId,
  FullName: values.FullName,
  Email: values.Email,
  PhoneNumber: values.PhoneNumber,
  ExpectedArrival: date.toJSDate(),
  CustomerNotes: values.CustomerNotes,
}))

await httpClient.post(endpoints.visitors.create, visitors)
```


# Delete Visitor
Source: https://learn.nexudus.com/api/endpoints/visitors/delete-visitor

DELETE /api/public/visitors/{visitorId}
Removes a registered visitor.

# Delete Visitor

Cancels and removes a visitor registration. The visitor will no longer receive arrival notifications.

## Authentication

Requires a valid customer bearer token.

## Path Parameters

<ParamField type="number">
  Numeric identifier of the visitor to remove.
</ParamField>

## Response

Returns a `200 OK` on success.

## Examples

### Delete a visitor

```http theme={null}
DELETE /api/public/visitors/55
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

await httpClient.delete(endpoints.visitors.delete(55))
```


# List Visitors
Source: https://learn.nexudus.com/api/endpoints/visitors/list-visitors

GET /api/public/visitors/my
Returns the authenticated customer's registered visitors.

# List Visitors

Returns the list of visitors registered by the authenticated customer. Optionally filter to only upcoming visits.

## Authentication

Requires a valid customer bearer token.

## Query Parameters

<ParamField type="boolean">
  `true` — return only future visits. `false` or omitted — return all visitors.
</ParamField>

<ParamField type="string">
  Comma-separated list of field paths to include in the response. When provided, only the
  specified fields are returned — useful for reducing payload size. Supports nested paths
  using dot notation. Example: `_shape=Records.FullName,Records.ExpectedArrival,Records.Arrived`.
</ParamField>

## Response

Returns a `VisitorList` object containing an array of visitor records.

### Visitor Fields

#### Identity

| Field      | Type     | Description                               |
| ---------- | -------- | ----------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the visitor |
| `UniqueId` | `string` | Globally unique identifier                |

#### Core

| Field         | Type             | Description                    |
| ------------- | ---------------- | ------------------------------ |
| `FullName`    | `string`         | Visitor's full name            |
| `Email`       | `string`         | Visitor's email address        |
| `PhoneNumber` | `string`         | Visitor's phone number         |
| `Notes`       | `string \| null` | Customer notes about the visit |

#### Schedule

| Field                | Type             | Description                            |
| -------------------- | ---------------- | -------------------------------------- |
| `ExpectedArrival`    | `string \| null` | Expected arrival (business-local time) |
| `UtcExpectedArrival` | `string \| null` | Expected arrival (UTC)                 |
| `ArrivalDate`        | `string \| null` | Actual arrival date (business-local)   |
| `UtcArrivalDate`     | `string \| null` | Actual arrival date (UTC)              |
| `Arrived`            | `boolean`        | Whether the visitor has arrived        |

#### Media

| Field                 | Type             | Description                           |
| --------------------- | ---------------- | ------------------------------------- |
| `GravatarHashedEmail` | `string \| null` | MD5-hashed email for Gravatar lookups |
| `DefaultAvatarUrl`    | `string \| null` | Generated avatar URL from initials    |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch upcoming visitors

```http theme={null}
GET /api/public/visitors/my?showUpcoming=true
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: visitors } = useTypedData(httpClient, endpoints.visitors.list(true))
```


# Public API
Source: https://learn.nexudus.com/api/overview

A comprehensive guide to the Nexudus Members Portal API

The Nexudus Members Portal is a front-end only application that connects to the Nexudus API backend. This API provides comprehensive access to all the functionality available in the portal interface, enabling developers to integrate portal features into custom applications, mobile apps, or third-party systems.

<Note>
  This portal application does not have its own backend - it connects directly to the Nexudus API infrastructure for all data operations using a
  client-side architecture.
</Note>

## Base URL Structure

The API endpoints follow two primary URL patterns:

* **API Endpoints**: `https://[your-space].spaces.nexudus.com/api/public/...`
* **Localized Endpoints**: `https://[your-space].spaces.nexudus.com/{lang}/...`

### HTTP Methods

The API primarily uses these HTTP methods:

* `GET` - Retrieve data (most common)
* `POST` - Create resources and submit data
* `PUT` - Update existing resources
* `DELETE` - Remove resources
* `PATCH` - Update resources partially

### Response Format

API responses return JSON with consistent structures. List endpoints follow the `ApiListResult<T>` pattern:

```json theme={null}
{
  "Records": [
    /* array of items */
  ],
  "CurrentPageSize": 20,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": "ASC",
  "FirstItem": 1,
  "HasNextPage": true,
  "HasPreviousPage": false,
  "LastItem": 20,
  "PageNumber": 1,
  "PageSize": 20,
  "TotalItems": 150,
  "TotalPages": 8
}
```

### Single-record Responses

For single-record endpoints.

```json theme={null}
{
  "Resource": {
    ...
  }
}
```

### Error Handling

Error responses generally use HTTP 400 status code with and error code:

```json theme={null}
{
  "Invalid booking date - start date cannot be in the past"
}
```

When authentication fails or the user does not have permission to make a specific request, the API returns a 401 status code;

## API Client Implementation

The portal uses a custom HTTP client based on Axios with these characteristics:

* Bearer token authentication
* Timezone-aware requests (`X-Use-Timezone` header).
* JSON content type by default

## Request Shaping

The API supports request shaping to optimize response size:

```typescript theme={null}
// Example of request shaping
const shape = ['BlogPost.Id', 'BlogPost.Title', 'BlogPost.AllowComments', 'BlogPost.UpdatedOn', 'BlogPost.Comments.Id', 'BlogPost.Comments.Text']

// URL with shape parameter
const url = `${endpoint}?_shape=${shape.join(',')}`
```

```javascript theme={null}

GET /api/public/blogPosts?page=1&top=10&featured=true&_shape=BlogPosts.Records.Id,BlogPosts.Records.Business.Id,BlogPosts.Records.Business.WebAddress,BlogPosts.Records.Business.Name,BlogPosts.Records.Title,BlogPosts.Records.BlogCategories.Id,BlogPosts.Records.BlogCategories.Title,BlogPosts.Records.SummaryText,BlogPosts.Records.PublishDateUtc,BlogPosts.Records.UpdatedOn,BlogPosts.Records.PostedBy.FullName,BlogPosts.HasNextPage,Category.Id,Category.Title,Categories.Id,Categories.Title

```

## Multi-tenancy Support

The application supports multi-tenancy through dynamic domain resolution:

* Each location has its own subdomain (`your-space.spaces.nexudus.com`)

## API Throttling Limits

The API enforces throttling rules to prevent abuse and ensure fair usage.\
Limits apply per client (based on request signature) and vary depending on method, endpoint, and time window.

### General Limits

| Scope                    | Methods           | Limit            | Window   |
| ------------------------ | ----------------- | ---------------- | -------- |
| Per second               | Any               | 10 requests      | 1 sec    |
| Per minute               | Any               | 120 requests     | 1 min    |
| Per hour                 | Any               | 5000 requests    | 1 hour   |
| Per day                  | Any               | 200,000 requests | 24 hours |
| POST/PUT/DELETE (minute) | POST, PUT, DELETE | 60 requests      | 1 min    |
| POST/PUT/DELETE (day)    | POST, PUT, DELETE | 5000 requests    | 24 hours |

### Public API Limits

| Endpoint              | Methods | Limit       | Window |
| --------------------- | ------- | ----------- | ------ |
| `/api/public*`        | Any     | 10 requests | 5 sec  |
| `/api/public/checkin` | Any     | 60 requests | 1 min  |

### Endpoint-Specific Limits

| Endpoint                                    | Methods   | Limit       | Window |
| ------------------------------------------- | --------- | ----------- | ------ |
| `/api/Spaces/CoworkerPricePlanHistories`    | Any       | 1 request   | 10 sec |
| `/api/Sys/AuditTrailEntries`                | Any       | 1 request   | 60 sec |
| `/api/spaces/coworkerDataFiles`             | POST, PUT | 5 requests  | 1 min  |
| `/api/spaces/coworkerMessages`              | POST, PUT | 5 requests  | 1 min  |
| `/api/billing/proposals/runcommand`         | Any       | 10 requests | 1 min  |
| `/api/billing/coworkercontracts/runcommand` | Any       | 10 requests | 1 min  |
| `/api/billing/coworkerinvoices/runcommand`  | Any       | 10 requests | 1 min  |
| `/api/nexpos/validatepin`                   | Any       | 60 requests | 1 min  |
| `*/bigquery/pushall`                        | Any       | 1 request   | 12 min |
| `/api/integrations/textract`                | Any       | 12 requests | 1 min  |
| `/api/integrations/openai`                  | Any       | 12 requests | 1 min  |
| `/api/sys/users/sendmagiclink`              | Any       | 12 requests | 1 min  |

***


# Installing Agent Skills
Source: https://learn.nexudus.com/cli/agent-skills-installation

Step-by-step guide to installing the Nexudus Agent Skill for GitHub Copilot and Claude.

# Installing Agent Skills

The Nexudus Agent Skill is distributed as a public skills package. Installation takes one command and works for both GitHub Copilot and Claude.

## Prerequisites

* **Node.js** — required to run the `npx skills` installer.
* **Nexudus CLI** — the skill calls the CLI under the hood, so [install it first](/cli/installation).
* **GitHub Copilot** or **Claude** — the AI assistant you want to use.

## Install the skill

Install from the public GitHub repository:

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills
```

Or use the full repository URL:

```bash theme={null}
npx skills add https://github.com/Nexudus-Ltd/nexudus-coworking-skills.git
```

### Install for a specific agent

To install specifically for GitHub Copilot:

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills -a github-copilot
```

### Install globally

To install the skill globally (available across all your projects):

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills -g
```

Combine flags as needed:

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills -g -a github-copilot
```

## Verify the installation

```bash theme={null}
npx skills list
```

You should see the `nexudus` skill in the list. The skill provides:

* `skills/nexudus/SKILL.md` — the main skill file that teaches your AI assistant how to use the CLI.

## After installation

Once the skill is installed, your AI assistant can use the Nexudus CLI. To confirm everything is working end-to-end:

1. **Make sure the CLI is authenticated** — run `nexudus login` if you haven't already.
2. **Ask your assistant to run diagnostics** — say something like *"Run nexudus doctor and tell me the status"*.
3. **Try a query** — ask *"List my Nexudus businesses"*.

## Updating the skill

The Nexudus CLI and Agent Skills receive frequent updates with new entity coverage and improvements. To get the latest version:

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills
```

Running the install command again updates the skill to the latest published version.

<Note>
  The skill is synced from the private Nexudus CLI repository and only exposes the public skills payload. Updates are published every few days as new
  entity types and features are added.
</Note>

## Uninstalling

To remove the skill:

```bash theme={null}
npx skills remove nexudus
```

## Troubleshooting

| Issue                                        | Solution                                                                                       |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `npx skills` command not found               | Make sure Node.js is installed and in your PATH                                                |
| Skill installed but assistant doesn't use it | Restart your editor or AI assistant session to pick up the new skill                           |
| Assistant returns "Not logged in" errors     | Run `nexudus login` in your terminal to authenticate                                           |
| Assistant can't find the CLI                 | Make sure the Nexudus CLI is installed globally via `dotnet tool install --global Nexudus.Cli` |


# What are Agent Skills?
Source: https://learn.nexudus.com/cli/agent-skills-overview

How Agent Skills let AI assistants like GitHub Copilot and Claude manage your Nexudus coworking spaces through natural language.

# Agent Skills

**Agent Skills** teach AI assistants how to use the Nexudus CLI. Once installed, your AI assistant (GitHub Copilot or Claude) can manage your Nexudus coworking spaces through natural language instructions — no need to remember command syntax.

## How it works

The Agent Skill is a structured knowledge file (`SKILL.md`) that gets installed into your AI assistant's context. It contains:

* **Command reference** — every CLI command, its options, and expected output.
* **Decision trees** — step-by-step workflows for common tasks (finding a business, creating a product, updating an entity).
* **Output parsing rules** — how to interpret the JSON envelope returned by `--agent` mode.
* **Error handling** — how to diagnose and recover from common errors.
* **Entity index** — a catalogue of all 40+ entity types the CLI supports.

When you ask your AI assistant something like *"List all products in my London office"*, the skill teaches the assistant to:

1. Run `nexudus businesses list --query "London" --agent` to find the business ID.
2. Run `nexudus products list --business <id> --agent` to list products for that location.
3. Parse the JSON envelope and present the results.

## Supported AI assistants

| Assistant              | Support                                                       |
| ---------------------- | ------------------------------------------------------------- |
| **GitHub Copilot**     | Fully supported — install the skill globally or per-workspace |
| **Claude** (Anthropic) | Fully supported via the same skill file                       |

## What the AI assistant can do

Once the skill is installed, your AI assistant can:

* **Query data** — list, search, and filter any entity type (businesses, products, resources, bookings, coworkers, invoices, etc.).
* **Create entities** — set up new products, resources, bookings, and more using natural language.
* **Update entities** — modify properties, assign tariffs, change pricing, upload images.
* **Delete entities** — remove entities with proper confirmation handling.
* **Run entity commands** — execute special operations like archiving or activating.
* **Diagnose issues** — run `nexudus doctor` and interpret the results.

## Example conversations

**You:** *"Show me all the meeting rooms in my space"*

The assistant runs:

```bash theme={null}
nexudus resources list --agent
```

and presents the results.

***

**You:** *"Create a day pass product for £25"*

The assistant runs `nexudus whoami --agent` to get your default business and currency, then:

```bash theme={null}
nexudus products create --name "Day Pass" --price 25.00 --business <id> --agent
```

***

**You:** *"Delete product 12345678"*

The assistant confirms the entity exists, then:

```bash theme={null}
nexudus products delete 12345678 --yes --agent
```

## With great power comes great responsibility

<Warning>
  Agent Skills give your AI assistant the ability to **create, update, and delete real data** in your Nexudus account. Before using them, be aware of the following risks:

  * **Destructive actions are real** — deletions and updates are applied immediately to your live environment. There is no undo button.
  * **AI can misinterpret intent** — a vague instruction like *"clean up old bookings"* could lead to unintended bulk deletions. Be specific in your requests.
  * **Always review before confirming** — read the commands and parameters the assistant proposes before letting them run, especially for write operations.
  * **Start in a test environment** — if your plan supports it, try commands against a sandbox or test business first.
  * **Limit scope when possible** — only grant the assistant access to the workspaces and businesses it needs.
</Warning>

## Important: the `--agent` flag

The skill instructs the AI assistant to always append `--agent` to every CLI call. This flag returns a structured JSON envelope that the assistant can parse reliably, instead of human-formatted table output.

## Next steps

<Card title="Install Agent Skills" icon="download" href="/cli/agent-skills-installation">
  Step-by-step installation guide for GitHub Copilot and Claude.
</Card>


# Authentication
Source: https://learn.nexudus.com/cli/authentication

How to log in, log out, and manage credentials with the Nexudus CLI.

# Authentication

The Nexudus CLI authenticates against the Nexudus REST API using your Nexudus account email and password. Credentials are stored securely in your operating system's native credential store.

## Credential storage

| Operating system | Storage backend                        |
| ---------------- | -------------------------------------- |
| Windows          | Windows Credential Manager             |
| macOS            | macOS Keychain                         |
| Linux            | libsecret (GNOME Keyring / KDE Wallet) |

Credentials are never stored in plain text on disk.

## Log in

```bash theme={null}
nexudus login
```

The CLI prompts you for your Nexudus email and password. After entering them, the CLI validates your credentials by calling the Nexudus API and stores them securely if successful.

<Warning>The admin CLI currently uses Basic Authentication (username and password). OAuth/Bearer token support is planned for a future release.</Warning>

## Public API Authentication

In addition to admin authentication, the CLI supports the **Public API**, which lets you authenticate as a member of a coworking space. Public API tokens are stored separately from admin credentials, so you can use both contexts simultaneously.

### Log in as a member

```bash theme={null}
nexudus public login --web-address myspace --email you@example.com --password your-password
```

| Option          | Description                                        |
| --------------- | -------------------------------------------------- |
| `--web-address` | The subdomain of your location (e.g., `myspace`)   |
| `--email`       | Your member email address                          |
| `--password`    | Your member password                               |
| `--totp`        | Two-factor authentication code (if 2FA is enabled) |

### Verify your member session

```bash theme={null}
nexudus public whoami
```

### Log out as a member

```bash theme={null}
nexudus public logout
```

This only clears public API (member) credentials — your admin credentials remain unaffected.

For the full reference of public API commands, see [Public API Commands](/cli/public-api).

## Verify your session

```bash theme={null}
nexudus whoami
```

This displays your authenticated user information including your name, email, and default business. It also returns useful defaults that commands use automatically:

| Default                   | Description                           |
| ------------------------- | ------------------------------------- |
| `DefaultBusinessId`       | Your primary business (location) ID   |
| `DefaultCurrencyId`       | The default currency for your account |
| `DefaultCountryId`        | The default country for your account  |
| `DefaultSimpleTimeZoneId` | The default timezone for your account |

These defaults are used automatically when creating or updating entities so you don't have to specify them every time.

## Log out

```bash theme={null}
nexudus logout
```

This clears all stored credentials from your system's secure storage.

## Troubleshooting authentication

| Symptom                | Solution                                                                       |
| ---------------------- | ------------------------------------------------------------------------------ |
| "Not logged in" errors | Run `nexudus login` to authenticate                                            |
| "Unauthorized" errors  | Your credentials may have changed — run `nexudus login` again                  |
| "Forbidden" errors     | Your account may not have API permissions — contact your Nexudus administrator |

<Tip>Run `nexudus doctor` at any time to check whether you have stored credentials and whether the API is reachable.</Tip>


# CLI Commands
Source: https://learn.nexudus.com/cli/commands

Complete reference of all Nexudus CLI commands, global flags, and usage examples.

# CLI Commands

The Nexudus CLI follows a consistent `nexudus <entity> <action>` pattern. Every entity supports a standard set of operations where applicable.

## Command tree

```
nexudus
├── login                              # Authenticate and store credentials
├── logout                             # Clear stored credentials
├── whoami                             # Show current user info and defaults
├── doctor                             # Run environment diagnostics
├── config
│   ├── get <key>                      # Read a configuration value
│   └── set <key> <value>              # Set a configuration value
├── businesses
│   ├── list [--query] [--page]        # Search businesses
│   ├── get <id>                       # Get a single business
│   └── update <id> [--name] ...       # Update a business
├── products
│   ├── list [--query] [--business]    # Search products
│   ├── get <id>                       # Get a single product
│   ├── create [--name] [--price] ...  # Create a product
│   ├── update <id> [--name] ...       # Update a product
│   └── delete <id>                    # Delete a product
├── resources
│   ├── list / get / create / update / delete
├── bookings
│   ├── list / get / create / update / delete
├── coworkers
│   ├── list / get / create / update / delete / commands
├── public
│   ├── login                          # Authenticate as a member
│   ├── logout                         # Clear member credentials
│   ├── whoami                         # Show member session info
│   ├── plans list / get / cancel      # Manage your plans
│   ├── bookings list / get / delete   # Manage your bookings
│   ├── invoices list / get            # View your invoices
│   ├── visitors list / create         # Manage your visitors
│   ├── profile patch                  # Update your profile
│   ├── store list                     # Browse store products
│   ├── community threads list/start   # Community forum
│   └── ... (see Public API Commands)
└── ... (100+ entity types)

Global flags: --json | --md | --agent | --base-url <url>
```

<Note>
  New entity types are added regularly. Run `nexudus --help` to see all currently available commands, or run `nexudus doctor --agent` to get a
  machine-readable list.
</Note>

<Info>
  **Public API Commands:** The `nexudus public` branch lets you interact with your coworking space as a member. See [Public API Commands](/cli/public-api) for the full reference.
</Info>

## Global flags

These flags can be added to any command:

| Flag               | Description                                                    |
| ------------------ | -------------------------------------------------------------- |
| `--json`           | Output raw JSON envelope (for scripting)                       |
| `--md`             | Output as Markdown tables                                      |
| `--agent`          | Output JSON envelope with enhanced summary (for AI assistants) |
| `--base-url <url>` | Override the API base URL                                      |
| `--yes` or `-y`    | Skip confirmation prompts (e.g., on delete)                    |

## Common operations

### Listing entities

```bash theme={null}
nexudus products list
nexudus products list --name "Day Pass"
nexudus products list --business 12345678
nexudus products list --page 2 --size 50
nexudus products list --order-by Name --dir 0
```

* `--name` filters results by name or keyword. Different entities support different parameter names.
* `--business` scopes results to a specific business (location).
* `--page` and `--size` control pagination. Default page size is 25; use `--size 100` for larger pages.
* `--order-by` specifies the property to sort results by (e.g., `Name`, `CreatedOn`, `FromTime`).
* `--dir` sets the sort direction: `0` for ascending, `1` for descending.

<Info>
  Each entity type has a default sort order (e.g., Bookings sort by `FromTime` ascending). If you omit `--order-by`, the API applies this default. You can override it with any property that the entity exposes.
</Info>

### Getting a single entity

```bash theme={null}
nexudus products get 12345678
```

<Info>
  List responses return a simplified projection without collection properties (e.g., `Tariffs`, `Teams`, `LinkedResources`). To see all fields including lists, always fetch the individual entity by ID with `get <id>`.
</Info>

### Creating an entity

```bash theme={null}
nexudus products create --name "Day Pass" --price 25.00 --business 12345678
```

Required fields depend on the entity type. Run `nexudus <entity> create --help` to see all available options and which are required.

### Updating an entity

```bash theme={null}
nexudus products update 12345678 --name "Premium Day Pass" --price 35.00
```

Only the fields you specify are changed. All other fields remain untouched.

### Deleting an entity

```bash theme={null}
nexudus products delete 12345678
```

The CLI prompts for confirmation before deleting. Use `--yes` to skip the prompt in scripts:

```bash theme={null}
nexudus products delete 12345678 --yes
```

### Entity commands

Some entities support additional operations called "commands" (e.g., archiving, activating):

```bash theme={null}
# Discover available commands for an entity type
nexudus products commands

# Run a command on one or more entities
nexudus products run-command archive 123,456,789
```

## Working with list properties

Some entities have list properties (e.g., tariffs on a resource, teams on a coworker). To set these, repeat the flag for each value:

```bash theme={null}
nexudus resources update 123 --tariffs 101 --tariffs 202 --tariffs 303
```

Three variants are available:

| Flag pattern       | Behaviour                                                                   |
| ------------------ | --------------------------------------------------------------------------- |
| `--{list}`         | **Replaces** the entire list with the supplied values. Use this by default. |
| `--added-{list}`   | **Adds** values to the existing list without removing current entries.      |
| `--removed-{list}` | **Removes** specific values from the existing list.                         |

<Warning>Do not use comma-separated values or bracket syntax for lists. Each value needs its own flag occurrence.</Warning>

## Image uploads

Some entities have image properties (logo, banner, picture). To set an image, provide a publicly accessible URL:

```bash theme={null}
nexudus businesses update 123 --logo-url "https://example.com/logo.png"
nexudus resources update 456 --new-picture-url "https://example.com/room.jpg"
```

The Nexudus back-end downloads the image from the URL, so it must be reachable from the internet — local file paths will not work.

## Discovering options

You can always check available options for any command by appending `--help`:

```bash theme={null}
nexudus businesses update --help
nexudus products create --help
nexudus resources list --help
```


# Entity Reference
Source: https://learn.nexudus.com/cli/entity-reference

Complete index of all entity types available in the Nexudus CLI with their supported operations.

# Entity Reference

The Nexudus CLI supports 100+ entity types. Each entity follows the same consistent command pattern and maps to a Nexudus REST API endpoint.

<Note>
  This list grows with each release. Run `nexudus --help` to see all currently available entity commands, or run `nexudus doctor --agent` for the full
  list.
</Note>

## Supported entities

| Entity                             | CLI command                           | Operations                                  | API module    |
| ---------------------------------- | ------------------------------------- | ------------------------------------------- | ------------- |
| AccessToken                        | `accesstokens`                        | list, get, create, update, delete           | spaces        |
| Application                        | `applications`                        | list, get, create, update, delete           | apps          |
| AudioFile                          | `audiofiles`                          | list, get, create, update, delete           | content       |
| AuditTrailEntry                    | `audittrailentries`                   | list, get                                   | sys           |
| AutomationTile                     | `automationtiles`                     | list, get, create, update, delete           | sys           |
| AutomationTileAudit                | `automationtileaudits`                | list, get, create, update, delete           | sys           |
| BasketSession                      | `basketsessions`                      | list, get, create, update, delete           | billing       |
| BlogCategory                       | `blogcategories`                      | list, get, create, update, delete           | content       |
| BlogPost                           | `blogposts`                           | list, get, create, update, delete           | content       |
| BlogPostComment                    | `blogpostcomments`                    | list, get, create, update, delete           | content       |
| Booking                            | `bookings`                            | list, get, create, update, delete           | spaces        |
| BookingAvailabilityException       | `bookingavailabilityexceptions`       | list, get, create, update, delete           | spaces        |
| BookingNote                        | `bookingnotes`                        | list, get, create, update, delete           | spaces        |
| BookingProduct                     | `bookingproducts`                     | list, get, create, update, delete           | spaces        |
| BookingVisitor                     | `bookingvisitors`                     | list, get, create, update, delete           | spaces        |
| Business                           | `businesses`                          | list, get, update                           | sys           |
| BusinessAnnouncement               | `businessannouncements`               | list, get, create, update, delete           | content       |
| BusinessBackgroundJob              | `businessbackgroundjobs`              | list, get                                   | sys           |
| BusinessCharge                     | `businesscharges`                     | list, get, create, update, delete           | billing       |
| BusinessDomain                     | `businessdomains`                     | list, get, create, update, delete           | sys           |
| BusinessRedirection                | `businessredirections`                | list, get, create, update, delete           | sys           |
| BusinessSetting                    | `businesssettings`                    | list, get, create, update, delete           | sys           |
| BusinessTimeSlot                   | `businesstimeslots`                   | list, get, create, update, delete           | sys           |
| CalendarEvent                      | `calendarevents`                      | list, get, create, update, delete           | content       |
| CalendarEventCategory              | `calendareventcategories`             | list, get, create, update, delete           | content       |
| CancelledBooking                   | `cancelledbookings`                   | list, get, create, update, delete           | spaces        |
| CannedResponse                     | `cannedresponses`                     | list, get, create, update, delete           | crm           |
| Charge                             | `charges`                             | list, get, create, update, delete           | billing       |
| ChatRoom                           | `chatrooms`                           | list, get, create, update, delete           | support       |
| ChatUserMessage                    | `chatusermessages`                    | list, get, create, update, delete           | sys           |
| Checkin                            | `checkins`                            | list, get, create, update, delete           | spaces        |
| CommunityGroup                     | `communitygroups`                     | list, get, create, update, delete           | community     |
| CommunityMessage                   | `communitymessages`                   | list, get, create, update, delete           | community     |
| CommunityMessageLike               | `communitymessagelikes`               | list, get, create, update, delete           | community     |
| CommunityPerk                      | `communityperks`                      | list, get, create, update, delete           | content       |
| CommunityThread                    | `communitythreads`                    | list, get, create, update, delete           | community     |
| CommunityThreadFile                | `communitythreadfiles`                | list, get, create, update, delete           | community     |
| CommunityThreadFollow              | `communitythreadfollows`              | list, get, create, update, delete           | community     |
| CommunityThreadLike                | `communitythreadlikes`                | list, get, create, update, delete           | community     |
| CommunityThreadMute                | `communitythreadmutes`                | list, get, create, update, delete           | community     |
| ContractContact                    | `contractcontacts`                    | list, get, create, update, delete           | billing       |
| ContractDeposit                    | `contractdeposits`                    | list, get, create, update, delete           | billing       |
| ContractPausedPeriod               | `contractpausedperiods`               | list, get, create, update, delete           | billing       |
| ContractProduct                    | `contractproducts`                    | list, get, create, update, delete           | billing       |
| ContractSchedule                   | `contractschedules`                   | list, get, create, update, delete           | billing       |
| Country                            | `countries`                           | list, get                                   | sys           |
| Course                             | `courses`                             | list, get, create, update, delete           | content       |
| CourseCompletedLesson              | `coursecompletedlessons`              | list, get, create, update, delete           | content       |
| CourseLesson                       | `courselessons`                       | list, get, create, update, delete           | content       |
| CourseMember                       | `coursemembers`                       | list, get, create, update, delete           | content       |
| CourseSection                      | `coursesections`                      | list, get, create, update, delete           | content       |
| Coworker                           | `coworkers`                           | list, get, create, update, commands         | spaces        |
| CoworkerAccessControlAudit         | `coworkeraccesscontrolaudits`         | list, get, create, update, delete           | sys           |
| CoworkerBookingCredit              | `coworkerbookingcredits`              | list, get, create, update, delete           | billing       |
| CoworkerBookingCreditUseHistory    | `coworkerbookingcreditusehistories`   | list, get, create, update                   | billing       |
| CoworkerContract                   | `coworkercontracts`                   | list, get, create, update, delete           | billing       |
| CoworkerDataFile                   | `coworkerdatafiles`                   | list, get, create, update, delete           | spaces        |
| CoworkerDelivery                   | `coworkerdeliveries`                  | list, get, create, update, delete           | spaces        |
| CoworkerDiscountCode               | `coworkerdiscountcodes`               | list, get, create, update, delete           | billing       |
| CoworkerExtraService               | `coworkerextraservices`               | list, get, create, update, delete           | billing       |
| CoworkerExtraServiceUseHistory     | `coworkerextraserviceusehistories`    | list, get, create, update, delete           | billing       |
| CoworkerGoogleCalendar             | `coworkergooglecalendars`             | list, get, create, update, delete           | spaces        |
| CoworkerIdentityCheck              | `coworkeridentitychecks`              | list, get, create, update, delete           | spaces        |
| CoworkerIdentityCheckDocument      | `coworkeridentitycheckdocuments`      | list, get, create, update, delete           | spaces        |
| CoworkerInventoryAsset             | `coworkerinventoryassets`             | list, get, create, update, delete           | spaces        |
| CoworkerInvoice                    | `coworkerinvoices`                    | list, get, update                           | billing       |
| CoworkerInvoiceHistory             | `coworkerinvoicehistories`            | list, get, create, update, delete           | billing       |
| CoworkerInvoiceLine                | `coworkerinvoicelines`                | list, get, update                           | billing       |
| CoworkerInvoicePaymentToken        | `coworkerinvoicepaymenttokens`        | list, get, create, update, delete           | billing       |
| CoworkerLedgerEntry                | `coworkerledgerentries`               | list, get, create, update, delete           | billing       |
| CoworkerLegalContentAudit          | `coworkerlegalcontentaudits`          | list, get, create, update, delete           | sys           |
| CoworkerMessage                    | `coworkermessages`                    | list, get                                   | spaces        |
| CoworkerMsOfficeCalendar           | `coworkermsoffecalendars`             | list, get, create, update, delete           | spaces        |
| CoworkerMsOfficeCalendar           | `coworkermsofficecalendars`           | list, get, create, update, delete           | spaces        |
| CoworkerNote                       | `coworkernotes`                       | list, get, create, update, delete           | spaces        |
| CoworkerNotification               | `coworkernotifications`               | list, get, create, update, delete           | spaces        |
| CoworkerPaymentMethod              | `coworkerpaymentmethods`              | list, get, create, update, delete           | billing       |
| CoworkerPricePlanHistory           | `coworkerpriceplanhistories`          | list, get                                   | spaces        |
| CoworkerProduct                    | `coworkerproducts`                    | list, get, create, update, delete           | billing       |
| CoworkerReminderAudit              | `coworkerreminderaudits`              | list, get, create, update, delete           | crm           |
| CoworkerSetting                    | `coworkersettings`                    | list, get, create, update, delete           | spaces        |
| CoworkerTask                       | `coworkertasks`                       | list, get, create, update, delete           | crm           |
| CoworkerTimePass                   | `coworkertimepasses`                  | list, get, create, update, delete           | billing       |
| CrmBoard                           | `crmboards`                           | list, get, create, update, delete           | crm           |
| CrmBoardColumn                     | `crmboardcolumns`                     | list, get, create, update, delete           | crm           |
| CrmOpportunity                     | `crmopportunities`                    | list, get, create, update, delete           | crm           |
| CrmOpportunityHistory              | `crmopportunityhistories`             | list, get, create, update, delete           | crm           |
| CrmOpportunityImportFile           | `crmopportunityimportfiles`           | list, get, create, update, delete           | crm           |
| Currency                           | `currencies`                          | list, get                                   | sys           |
| CustomField                        | `customfields`                        | list, get, create, update, delete           | crm           |
| DataFile                           | `datafiles`                           | list, get, create, update, delete           | content       |
| DiscountCode                       | `discountcodes`                       | list, get, create, update, delete           | billing       |
| DocumentTemplate                   | `documenttemplates`                   | list, get, create, update, delete           | crm           |
| EloxxLockersAudit                  | `eloxxlockersaudits`                  | list, get, create, update, delete           | sys           |
| EmailAccount                       | `emailaccounts`                       | list, get, create, update, delete           | crm           |
| EmailQueueItem                     | `emailqueueitems`                     | list, get                                   | sys           |
| EmailQueueItemAttachment           | `emailqueueitemattachments`           | list, get, update                           | sys           |
| EmailTemplateFile                  | `emailtemplatefiles`                  | list, get, create, update, delete           | sys           |
| EventAttendee                      | `eventattendees`                      | list, get, create, update, delete           | content       |
| EventComment                       | `eventcomments`                       | list, get, create, update, delete           | content       |
| EventProduct                       | `eventproducts`                       | list, get, create, update, delete           | content       |
| EventWaitingAttendee               | `eventwaitingattendees`               | list, get, create, update, delete           | content       |
| ExtraService                       | `extraservices`                       | list, get, create, update, delete           | billing       |
| ExtraServicePrice                  | `extraserviceprices`                  | list, get, create, update, delete           | billing       |
| ExtraServiceTimeSlot               | `extraservicetimeslots`               | list, get, create, update, delete           | billing       |
| FailedCheckin                      | `failedcheckins`                      | list, get, create, update, delete           | spaces        |
| FaqArticle                         | `faqarticles`                         | list, get, create, update, delete           | content       |
| FinancialAccount                   | `financialaccounts`                   | list, get, create, update, delete           | billing       |
| FloorPlan                          | `floorplans`                          | list, get, create, update, delete           | sys           |
| FloorPlanAsset                     | `floorplanassets`                     | list, get                                   | sys           |
| FloorPlanDesk                      | `floorplandesks`                      | list, get, create, update, delete           | sys           |
| FloorPlanDeskVariant               | `floorplandeskvariants`               | list, get, create, update, delete           | sys           |
| FloorPlanLayout                    | `floorplanlayouts`                    | list, get, create, update, delete           | sys           |
| FloorPlanLayoutArea                | `floorplanlayoutareas`                | list, get, create, update, delete           | sys           |
| FloorPlanLayoutAsset               | `floorplanlayoutassets`               | list, get, create, update, delete           | sys           |
| FloorPlanLayoutEdge                | `floorplanlayoutedges`                | list, get, create, update, delete           | sys           |
| FloorPlanLayoutNode                | `floorplanlayoutnodes`                | list, get, create, update, delete           | sys           |
| FloorPlanLayoutOpening             | `floorplanlayoutopenings`             | list, get, create, update, delete           | sys           |
| FloorplanLayoutTransition          | `floorplanlayouttransitions`          | list, get, create, update, delete           | sys           |
| FormPage                           | `formpages`                           | list, get, create, update, delete           | content       |
| FormPageAnswer                     | `formpageanswers`                     | list, get, create, update                   | content       |
| FormPageQuestion                   | `formpagequestions`                   | list, get, create, update, delete           | content       |
| FormPageRequest                    | `formpagerequests`                    | list, get, create, update, delete           | content       |
| GlobalChatMessage                  | `globalchatmessages`                  | list, get, create, update, delete           | support       |
| HelpDeskComment                    | `helpdeskcomments`                    | list, get, create, update, delete           | support       |
| HelpDeskDepartment                 | `helpdeskdepartments`                 | list, get, create, update, delete           | support       |
| HelpDeskMessage                    | `helpdeskmessages`                    | list, get, create, update, delete           | support       |
| ImageFile                          | `imagefiles`                          | list, get, create, update, delete           | content       |
| InstalledApplication               | `installedapplications`               | list, get, create, update, delete           | apps          |
| InstalledMarketPlaceApplication    | `installedmarketplaceapplications`    | list, get, create, update, delete           | apps          |
| InventoryAsset                     | `inventoryassets`                     | list, get, create, update, delete           | spaces        |
| Invoice                            | `invoices`                            | list, get, update                           | billing       |
| Language                           | `languages`                           | list, get, create, update, delete           | sys           |
| LanguageToken                      | `languagetokens`                      | list, get, create, update, delete           | sys           |
| LedgerEntry                        | `ledgerentries`                       | list, get                                   | billing       |
| LegalContentAudit                  | `legalcontentaudits`                  | list, get, create, update, delete           | sys           |
| LogEntry                           | `logentries`                          | list, get                                   | sys           |
| MarketPlaceApplication             | `marketplaceapplications`             | list, get, create, update, delete           | apps          |
| MsOfficeAdminCalendar              | `msofficeadmincalendars`              | list, get, create, update, delete           | spaces        |
| NewsLetter                         | `newsletters`                         | list, get, create, update, delete           | content       |
| NewsLetterSubscriber               | `newslettersubscribers`               | list, get, create, update, delete           | content       |
| OpenAiChatMessage                  | `openaichatmessages`                  | list, get, create, update, delete           | sys           |
| OpportunityType                    | `opportunitytypes`                    | list, get, create, update, delete           | crm           |
| PassportCard                       | `passportcards`                       | list, get, create, update, delete           | sys           |
| PaymentGateway                     | `paymentgateways`                     | list, get, create, update, delete           | billing       |
| PayoutInvoice                      | `payoutinvoices`                      | list, get, create, update, delete           | sys           |
| PlatformChangeMessage              | `platformchangemessages`              | list, get, create, update, delete           | sys           |
| Product                            | `products`                            | list, get, create, update, delete, commands | billing       |
| ProductBookingCredit               | `productbookingcredits`               | list, get, create, update, delete           | billing       |
| ProductExtraService                | `productextraservices`                | list, get, create, update, delete           | billing       |
| ProductTimePass                    | `producttimepasses`                   | list, get, create, update, delete           | billing       |
| Proposal                           | `proposals`                           | list, get, create, update, delete           | billing       |
| ProposalContract                   | `proposalcontracts`                   | list, get, create, update, delete           | billing       |
| ProposalContractSchedule           | `proposalcontractschedules`           | list, get, create, update, delete           | billing       |
| ProposalProduct                    | `proposalproducts`                    | list, get, create, update, delete           | billing       |
| ProposalSchedule                   | `proposalschedules`                   | list, get, create, update, delete           | billing       |
| RadiusServer                       | `radiusservers`                       | list, get, create, update, delete           | sys           |
| RefreshToken                       | `refreshtokens`                       | list, get, create, update, delete           | sys           |
| RegisteredDevice                   | `registereddevices`                   | list, get, update                           | sys           |
| Reminder                           | `reminders`                           | list, get, create, update, delete           | crm           |
| Report                             | `reports`                             | list, get, create, update, delete           | sys           |
| Reseller                           | `resellers`                           | list, get, create, update, delete           | sys           |
| ResellerAccount                    | `reselleraccounts`                    | list, get, create, update, delete           | sys           |
| ResellerPayout                     | `resellerpayouts`                     | list, get, create, update, delete           | sys           |
| Resource                           | `resources`                           | list, get, create, update, delete           | spaces        |
| ResourceAccessRule                 | `resourceaccessrules`                 | list, get, create, update, delete           | spaces        |
| ResourceAccessRuleEligibleTimeSlot | `resourceaccessruleeligibletimeslots` | list, get, create, update, delete           | spaces        |
| ResourceAccessRuleTimeSlot         | `resourceaccessruletimeslots`         | list, get, create, update, delete           | spaces        |
| ResourceProduct                    | `resourceproducts`                    | list, get, create, update, delete           | billing       |
| ResourceTimeSlot                   | `resourcetimeslots`                   | list, get, create, update, delete           | spaces        |
| ResourceType                       | `resourcetypes`                       | list, get, create, update, delete           | spaces        |
| Role                               | `roles`                               | list, get                                   | security      |
| Sensor                             | `sensors`                             | list, get, create, update, delete           | sys           |
| SensorHistory                      | `sensorhistories`                     | list, get, create, update, delete           | sys           |
| SimpleTimeZone                     | `simpletimezones`                     | list, get, update                           | sys           |
| SubscriberActivity                 | `subscriberactivities`                | list, get                                   | content       |
| SubscriberGroup                    | `subscribergroups`                    | list, get, create, update, delete           | content       |
| Survey                             | `surveys`                             | list, get, create, update, delete           | content       |
| SurveyAnswer                       | `surveyanswers`                       | list, get, create, update, delete           | content       |
| SurveyQuestion                     | `surveyquestions`                     | list, get, create, update, delete           | content       |
| SurveyRun                          | `surveyruns`                          | list, get, create, update, delete           | content       |
| SystemNotification                 | `systemnotifications`                 | list, get, create, update, delete           | sys           |
| Tariff                             | `tariffs`                             | list, get, create, update, delete           | billing       |
| TariffBookingCredit                | `tariffbookingcredits`                | list, get, create, update, delete           | billing       |
| TariffDefaultDueDate               | `tariffdefaultduedates`               | list, get, create, update, delete           | billing       |
| TariffExtraService                 | `tariffextraservices`                 | list, get, create, update, delete           | billing       |
| TariffProduct                      | `tariffproducts`                      | list, get, create, update, delete           | billing       |
| TariffSignupProduct                | `tariffsignupproducts`                | list, get, create, update, delete           | billing       |
| TariffTimePass                     | `tarifftimepasses`                    | list, get, create, update, delete           | billing       |
| TaskItem                           | `taskitems`                           | list, get, create, update, delete           | crm           |
| TaskList                           | `tasklists`                           | list, get, create, update, delete           | crm           |
| TaxRate                            | `taxrates`                            | list, get, create, update, delete           | sys           |
| Team                               | `teams`                               | list, get, create, update, delete           | spaces        |
| TemplateFile                       | `templatefiles`                       | list, get, create, update, delete           | sys           |
| TemplateVersion                    | `templateversions`                    | list, get, create, update, delete           | sys           |
| TimePass                           | `timepasses`                          | list, get, create, update, delete           | billing       |
| TimePassPrice                      | `timepassprices`                      | list, get, create, update, delete           | billing       |
| TimePassTimeSlot                   | `timepasstimeslots`                   | list, get, create, update, delete           | billing       |
| UiModule                           | `uimodules`                           | list, get, create, update, delete           | sys           |
| User                               | `users`                               | list, get, create, update, delete           | sys           |
| UserBookmark                       | `userbookmarks`                       | list, get, create, update, delete           | sys           |
| UserMessage                        | `usermessages`                        | list, get                                   | sys           |
| UserRole                           | `userroles`                           | list, get, create, update, delete           | security      |
| ValidationRule                     | `validationrules`                     | list, get, create, update, delete           | sys           |
| VideoFile                          | `videofiles`                          | list, get, create, update, delete           | content       |
| VideoRoom                          | `videorooms`                          | list, get, create, update, delete           | community     |
| Visitor                            | `visitors`                            | list, get, create, update, delete           | spaces        |
| WebHook                            | `webhooks`                            | list, get, create, update, delete           | sys           |
| Workspace                          | `workspaces`                          | list, get, create, update, delete           | collaboration |

## Operation details

### `list`

Searches and returns a paginated list of entities. Supports `--query`, `--page`, `--size`, and `--business` filters.

### `get <id>`

Returns full details for a single entity, including collection properties (tariffs, teams, linked resources) that are omitted from list results.

### `create`

Creates a new entity. Required fields vary by entity type — use `--help` to see them.

### `update <id>`

Updates specific fields on an existing entity. Only the fields you supply are changed.

### `delete <id>`

Deletes an entity. Prompts for confirmation unless `--yes` is passed.

### `commands`

Lists available special commands for the entity type (e.g., archive, activate).

### `run-command <command> <id>`

Executes a special command on one or more entities. Supports comma-separated IDs for batch operations.

## API pattern

Every entity maps to a Nexudus REST API endpoint following this pattern:

| Operation   | HTTP Method | URL                                       |
| ----------- | ----------- | ----------------------------------------- |
| Search      | `GET`       | `/api/{module}/{entities}?page=1&size=25` |
| Get one     | `GET`       | `/api/{module}/{entities}/{id}`           |
| Create      | `POST`      | `/api/{module}/{entities}`                |
| Update      | `PUT`       | `/api/{module}/{entities}`                |
| Delete      | `DELETE`    | `/api/{module}/{entities}/{id}`           |
| Commands    | `GET`       | `/api/{module}/{entities}/commands`       |
| Run command | `POST`      | `/api/{module}/{entities}/runCommand`     |

<Info>
  **Business** entities cannot be created or deleted via the API — only listed, viewed, and updated. **Country** and **Currency** entities are
  read-only (list and get only).
</Info>


# Error Handling
Source: https://learn.nexudus.com/cli/error-handling

Common errors returned by the Nexudus CLI and how to resolve them.

# Error Handling

When a command fails, the CLI returns a non-zero exit code. If you're using `--json` or `--agent` output mode, the envelope's `ok` field is `false` and the `summary` field contains the error message.

## Error envelope

```json theme={null}
{
  "ok": false,
  "data": null,
  "summary": "Not logged in. Run 'nexudus login' first.",
  "breadcrumbs": ["businesses", "list"]
}
```

## Common errors

| Error summary      | Cause                              | Resolution                                                               |
| ------------------ | ---------------------------------- | ------------------------------------------------------------------------ |
| "Not logged in"    | No stored credentials found        | Run `nexudus login` to authenticate                                      |
| "Unauthorized"     | Invalid or expired credentials     | Run `nexudus login` again with correct credentials                       |
| "Forbidden"        | Your account lacks API permissions | Contact your Nexudus administrator to grant API access                   |
| "not found"        | The entity ID does not exist       | Double-check the ID — use `list` to find valid IDs                       |
| "Failed to create" | Validation error on create         | Check required fields — run `nexudus <entity> create --help` for details |
| Non-zero exit code | General command failure            | Read `stderr` or the JSON envelope for details                           |

## Checking for errors in scripts

When scripting, always check the exit code or parse the envelope:

```bash theme={null}
# Check exit code
nexudus products get 12345678 --json
if [ $? -ne 0 ]; then
  echo "Command failed"
fi
```

```bash theme={null}
# Parse the envelope with jq
result=$(nexudus products list --json)
ok=$(echo "$result" | jq -r '.ok')
if [ "$ok" != "true" ]; then
  echo "Error: $(echo "$result" | jq -r '.summary')"
fi
```

## Diagnostics

If you're unsure why commands are failing, run diagnostics:

```bash theme={null}
nexudus doctor
```

This checks:

* Whether credentials are stored and valid.
* Whether the API is reachable.
* Whether the CLI is up to date.


# Installing the Nexudus CLI
Source: https://learn.nexudus.com/cli/installation

How to install the Nexudus CLI tool and verify that it's working correctly.

# Installing the Nexudus CLI

The Nexudus CLI is a .NET global tool. You need the .NET SDK installed on your machine before installing the CLI.

## Prerequisites

* **.NET 10 SDK** or later — [Download .NET](https://dotnet.microsoft.com/download)
* A **Nexudus account** with API access

## Install the CLI

Install the CLI as a .NET global tool:

```bash theme={null}
dotnet tool install --global Nexudus.Cli
```

To update to the latest version:

```bash theme={null}
dotnet tool update --global Nexudus.Cli
```

### macOS (zsh)

If you use zsh (the default shell on macOS), you may need to add the .NET tools directory to your `PATH`:

```bash theme={null}
echo 'export PATH="$PATH:$HOME/.dotnet/tools"' >> ~/.zshrc
source ~/.zshrc
```

## Verify the installation

Run the help command to confirm the CLI is available:

```bash theme={null}
nexudus --help
```

You should see the top-level command tree listing available commands such as `login`, `logout`, `whoami`, `doctor`, `businesses`, `products`, and more.

## Run diagnostics

The `doctor` command checks your environment and confirms everything is set up correctly:

```bash theme={null}
nexudus doctor
```

This reports:

| Check                  | What it verifies                         |
| ---------------------- | ---------------------------------------- |
| **CLI version**        | The installed version of the Nexudus CLI |
| **.NET runtime**       | The .NET runtime version on your machine |
| **OS**                 | Your operating system                    |
| **Credentials stored** | Whether you have saved login credentials |
| **Config file**        | Location of the CLI configuration file   |
| **API connectivity**   | Whether the Nexudus API is reachable     |
| **Available commands** | All registered CLI commands              |

<Tip>
  If `doctor` reports that credentials are missing, run `nexudus login` to authenticate. See [Authentication](/cli/authentication) for details.
</Tip>

## Configuration

The CLI stores its configuration in `~/.nexudus/config.json`. You can view and change settings with:

```bash theme={null}
# View a setting
nexudus config get base-url

# Change the API base URL (useful for testing)
nexudus config set base-url https://spaces.nexudus.com
```

The default base URL is `https://spaces.nexudus.com`.

## Uninstall

To remove the CLI:

```bash theme={null}
dotnet tool uninstall --global Nexudus.Cli
```

## Next steps

<CardGroup>
  <Card title="Authentication" icon="key" href="/cli/authentication">
    Log in and manage your credentials.
  </Card>

  <Card title="CLI Commands" icon="list" href="/cli/commands">
    Explore the full command reference.
  </Card>
</CardGroup>


# Output Modes
Source: https://learn.nexudus.com/cli/output-modes

How to control the output format of the Nexudus CLI for human use, scripting, and AI assistant integration.

# Output Modes

Every CLI command supports four output modes, selected via global flags. The default mode produces human-friendly terminal tables.

## Available modes

| Flag      | Mode         | Best for                                              |
| --------- | ------------ | ----------------------------------------------------- |
| *(none)*  | **Table**    | Interactive terminal use — rich, formatted tables     |
| `--json`  | **JSON**     | Scripting and automation — raw JSON envelope          |
| `--md`    | **Markdown** | Documentation and reports — Markdown-formatted tables |
| `--agent` | **Agent**    | AI assistants — JSON envelope with enhanced summary   |

## The output envelope

When using `--json` or `--agent`, every command returns a standardised JSON envelope:

```json theme={null}
{
  "ok": true,
  "data": [ ... ],
  "summary": "Found 3 businesses (page 1/1)",
  "breadcrumbs": ["businesses", "list"],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 25,
    "totalPages": 1
  }
}
```

| Field         | Description                                                                                                             |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `ok`          | `true` on success, `false` on failure                                                                                   |
| `data`        | The response payload — an array for list operations, an object for single-entity operations, or `null` on some failures |
| `summary`     | A human-readable description of the result                                                                              |
| `breadcrumbs` | The command path that produced the output (e.g., `["products", "create"]`)                                              |
| `meta`        | Pagination metadata (present only on list commands)                                                                     |

### Error envelope

When a command fails, the envelope looks like:

```json theme={null}
{
  "ok": false,
  "data": null,
  "summary": "Not logged in. Run 'nexudus login' first.",
  "breadcrumbs": ["businesses", "list"]
}
```

Always check `ok` first before processing `data`.

## Examples

### Table mode (default)

```bash theme={null}
nexudus businesses list
```

Produces a formatted table in your terminal using rich formatting (colours, borders, alignment).

### JSON mode

```bash theme={null}
nexudus businesses list --json
```

Returns the raw JSON envelope — ideal for piping into `jq`, processing in scripts, or integrating with other tools:

```bash theme={null}
nexudus products list --json | jq '.data[] | .Name'
```

### Markdown mode

```bash theme={null}
nexudus businesses list --md
```

Produces Markdown-formatted tables suitable for pasting into documentation, tickets, or chat messages.

### Agent mode

```bash theme={null}
nexudus businesses list --agent
```

Returns the JSON envelope with an enhanced `summary` field optimised for AI assistant consumption. This is the mode that [Agent Skills](/cli/agent-skills-overview) use to communicate with the CLI.


# Nexudus CLI & Skills
Source: https://learn.nexudus.com/cli/overview

An overview of the Nexudus command-line interface and AI Agent Skills for managing coworking spaces from your terminal or AI assistant.

# Nexudus CLI & Agent Skills

The **Nexudus CLI** is a command-line tool that lets you manage your Nexudus coworking spaces directly from your terminal. Combined with **Agent Skills**, it also enables AI assistants like GitHub Copilot and Claude to perform Nexudus operations on your behalf.

<Note>
  The Nexudus CLI and Agent Skills are under active development. New entity types, commands, and improvements are released regularly. Check the
  [GitHub repository](https://github.com/Nexudus-Ltd/nexudus-coworking-skills) for the latest updates.
</Note>

## What can you do with it?

<CardGroup>
  <Card title="Manage from the terminal" icon="terminal">
    List, create, update, and delete entities like businesses, products, resources, bookings, coworkers, and many more — all from the command line.
  </Card>

  <Card title="Member self-service" icon="user">
    Use the Public API to manage your own plans, bookings, invoices, visitors, and more as a member of a coworking space — no admin access required.
  </Card>

  <Card title="AI-powered workflows" icon="robot">
    Install the Agent Skill so GitHub Copilot or Claude can manage your Nexudus data using natural language instructions.
  </Card>

  <Card title="Scriptable output" icon="code">
    Choose between human-friendly tables, raw JSON, Markdown, or a structured agent envelope — ideal for automation and scripting.
  </Card>

  <Card title="Secure authentication" icon="lock">
    Credentials are stored in your operating system's native secure storage (Windows Credential Manager, macOS Keychain, or Linux libsecret).
  </Card>
</CardGroup>

## Who is this for?

| Audience                | Use case                                                                                                        |
| ----------------------- | --------------------------------------------------------------------------------------------------------------- |
| **Coworking operators** | Automate repetitive management tasks, bulk-update entities, and query data without leaving the terminal.        |
| **Space members**       | Manage your plans, bookings, invoices, and visitors from the terminal using the Public API commands.            |
| **Developers**          | Script against the Nexudus API, integrate with CI/CD pipelines, and build custom workflows.                     |
| **AI assistant users**  | Let GitHub Copilot or Claude manage your Nexudus spaces through natural language by installing the Agent Skill. |

## How it works

The CLI communicates with the [Nexudus REST API](/rest-api/overview) using the same endpoints available to all integrations. Every entity in Nexudus (businesses, products, resources, bookings, coworkers, etc.) follows a consistent CRUD pattern, and the CLI wraps each one into a simple command structure:

```
nexudus <entity> <action> [options] [--json | --md | --agent]
```

For example:

```bash theme={null}
# List all businesses
nexudus businesses list

# Get a specific product as JSON
nexudus products get 12345678 --json

# Create a new resource
nexudus resources create --name "Meeting Room A" --business 98765432
```

When used with the `--agent` flag, every command returns a structured JSON envelope that AI assistants can parse and act on automatically.

## Privacy & telemetry

The Nexudus CLI collects anonymous usage data to help us improve the tool. **Telemetry is enabled by default but can be disabled with a single command:**

```bash theme={null}
nexudus config set telemetry off
```

No sensitive data (credentials, API responses, or business information) is collected. Learn more about what data is collected, where it's sent, and how to disable telemetry in the [Telemetry](/cli/telemetry) documentation.

## Next steps

<CardGroup>
  <Card title="Install the CLI" icon="download" href="/cli/installation">
    Download and set up the Nexudus CLI on your machine.
  </Card>

  <Card title="Public API Commands" icon="user" href="/cli/public-api">
    Manage plans, bookings, invoices, and more as a space member.
  </Card>
</CardGroup>


# PII Redaction
Source: https://learn.nexudus.com/cli/pii-redaction

How the CLI automatically redacts personal identifiable information for security and data protection.

# PII Redaction

The Nexudus CLI automatically redacts personally identifiable information (PII) when it detects non-interactive execution, such as when output is piped to another tool or script. This is a security feature that prevents sensitive data (names, emails, phone numbers, addresses, dates of birth) from flowing into AI agent contexts or logs.

<Info>**Available since CLI v5.0.16**. PII redaction is enabled by default and cannot be disabled by flags.</Info>

## What is PII?

PII includes any information that can identify a real person:

| Category      | Examples                                                 |
| ------------- | -------------------------------------------------------- |
| **NAME**      | FullName, NickName, Salutation, company names in context |
| **EMAIL**     | Email addresses, contact emails, welcome emails          |
| **PHONE**     | Mobile phones, landlines, fax numbers                    |
| **ADDRESS**   | Street address, postal code, city, state, country        |
| **DOB**       | Date of birth                                            |
| **SOCIAL**    | Twitter, Facebook, Google, Telegram handles              |
| **FINANCIAL** | Bank accounts, tax IDs, VAT numbers                      |
| **ID\_DOC**   | Passport numbers, national IDs                           |
| **BIO**       | Free-text profiles or notes that may contain PII         |

## When is PII redacted?

PII redaction is **automatic and structural** — it depends on your execution context, not on flags you can omit:

| Context                                       | Status | Reason                                             |
| --------------------------------------------- | ------ | -------------------------------------------------- |
| **Interactive terminal** (typing commands)    | ❌ OFF  | You're a human — trusted context                   |
| **Piped/redirected output** (e.g., `\| jq`)   | ✅ ON   | Data may enter scripts or logs — untrusted         |
| **Non-TTY execution** (no terminal attached)  | ✅ ON   | Likely automated — assume untrusted                |
| **With unlock token** (time-limited override) | ❌ OFF  | Human confirmed via browser 2FA — checked & logged |

### How to detect redaction status

Every CLI command response includes two fields that tell you whether PII is redacted:

```json theme={null}
{
  "piiRedaction": "on",
  "piiRedactionReason": "non-interactive",
  "ok": true,
  "data": { ... }
}
```

| Field                | Values                                                                             |
| -------------------- | ---------------------------------------------------------------------------------- |
| `piiRedaction`       | `"on"` = PII is redacted; `"off"` = PII is visible                                 |
| `piiRedactionReason` | `"interactive terminal"`, `"non-interactive"`, or `"unlocked (expires TIMESTAMP)"` |

## How PII looks when redacted

When PII is redacted, sensitive fields are replaced with **deterministic tokens**:

```
«PII:EMAIL:a3f2b1c9»
«PII:NAME:7e4d2f8a»
«PII:PHONE:1b3c5d7e»
«PII:ADDR:f5e2c1b4»
```

### Token anatomy

```
«PII:{CATEGORY}:{HASH}»
```

| Part       | Example    | Meaning                                               |
| ---------- | ---------- | ----------------------------------------------------- |
| `PII`      | constant   | Identifies this as a PII token                        |
| `CATEGORY` | `EMAIL`    | The type of PII (EMAIL, NAME, PHONE, ADDR, DOB, etc.) |
| `HASH`     | `a3f2b1c9` | First 8 chars of SHA256(value + per-install salt)     |

### Why tokens?

* **Stable**: The same real value always produces the same token. You can reference entities by token across multiple commands.
* **Opaque**: Tokens cannot be reversed into real values. An LLM cannot derive personal data from a token.
* **Obvious**: Tokens are visually distinct from real data — not easily confused with actual emails or names.
* **Resolvable**: When you pass a token back to the CLI as an argument, it resolves to the real value before sending to the API.

## Using tokens in commands

You can pass tokens back to the CLI as arguments — the CLI transparently resolves them to real values before sending to the API:

```bash theme={null}
# List coworkers — get tokenized output
$ nexudus coworkers list --json
{
  "piiRedaction": "on",
  "data": [
    {
      "id": 123456,
      "fullName": "«PII:NAME:7e4d2f8a»",
      "email": "«PII:EMAIL:a3f2b1c9»"
    }
  ]
}

# Update that coworker using the token
$ nexudus coworkers update 123456 --email "«PII:EMAIL:a3f2b1c9»"

# The CLI resolves the token → real value before the API call
✓ Coworker 123456 updated
```

This is particularly useful for AI agents: they can read tokenized entity data, build command arguments using tokens, and pass them back without ever seeing real PII.

## Unlocking PII (browser-based 2FA override)

If you're a human operator and genuinely need to see full PII in a non-interactive context (e.g., piping output to `jq`), you can temporarily unlock PII via a **browser-based 2FA flow**. This is a true second-factor mechanism — an LLM agent with terminal access cannot complete the flow because it cannot drive a browser session.

```bash theme={null}
nexudus config set pii-mode unlocked --ttl 30m
```

### Unlock requirements

1. **Browser-based confirmation** — the CLI opens your browser to the Nexudus admin panel where you must authenticate and confirm the unlock. There is no terminal prompt to confirm — agents cannot type "y" to bypass.
2. **Authenticated via admin panel** — the confirmation POST is same-origin from the admin panel, protected by your Bearer token and CORS policy.
3. **Time-limited** — defaults to 30 minutes. Maximum allowed: 8 hours. TTL clamped to 1–480 minutes.
4. **Challenge expiry** — the unlock challenge expires in 120 seconds if not confirmed in the browser.
5. **Rate-limited** — maximum 5 unlock challenges per user per hour.
6. **Auditable** — unlock events are logged to telemetry (the fact that an unlock occurred, plus the TTL; no PII is logged).

### How the 2FA unlock flow works

<Frame>
  <img alt="Sequence diagram showing CLI to Browser to API flow for PII unlock" />
</Frame>

### Why agents cannot bypass the 2FA unlock

| Barrier                   | Why agents cannot bypass                                            |
| ------------------------- | ------------------------------------------------------------------- |
| **Browser launch**        | Agent has terminal access, not browser control                      |
| **Admin panel login**     | Requires Bearer token from authenticated admin panel session        |
| **Same-origin policy**    | Confirm POST is same-origin from admin panel — CORS blocks external |
| **Nonce is server-side**  | Cannot be forged — tied to authenticated user + TTL                 |
| **Poll-based (no stdin)** | Nothing to "type" — the CLI just waits for server confirmation      |
| **Challenge expiry**      | Challenge expires in 120s if not confirmed — no replay              |

### Example unlock workflow

```bash theme={null}
# Terminal: You need to export full PII for a report
$ nexudus config set pii-mode unlocked --ttl 2h

Opening browser for confirmation...
Waiting for browser confirmation... (timeout: 120s)
```

The CLI creates a challenge and opens your browser to the admin panel:

<Frame>
  <img alt="CLI waiting for browser-based PII unlock confirmation" />
</Frame>

In the admin panel, you'll see the confirmation page showing the requested TTL and your identity. Click **Confirm Unlock** to approve:

<Frame>
  <img alt="Nexudus admin panel PII unlock confirmation page" />
</Frame>

Once confirmed, the CLI detects the approval and saves the session:

```bash theme={null}
✓ PII unlocked until 2026-05-14T13:30:00Z

# Now redaction is temporarily OFF for 2 hours
$ nexudus coworkers list --json
{
  "piiRedaction": "off",
  "piiRedactionReason": "unlocked (expires 2026-05-14T13:30:00Z)",
  "ok": true,
  "data": [
    {
      "id": 123456,
      "fullName": "Jane Doe",           # ← Real name visible
      "email": "j.doe@acme.com"         # ← Real email visible
    }
  ]
}

# After 2 hours (or you manually lock), redaction is back ON
$ nexudus config set pii-mode locked

✓ PII redaction locked
```

## Locking PII manually

To immediately stop allowing PII in non-interactive mode:

```bash theme={null}
nexudus config set pii-mode locked
```

This deletes the unlock session — no waiting for expiry.

## PII redaction banner

Every CLI command displays a status banner that clearly states whether PII redaction is ON or OFF:

### Interactive terminal (PII visible)

```
🔓 PII redaction: OFF (interactive terminal)

┌─────────┬──────────┬──────────────────┬─────────────────┐
│ Id      │ FullName │ Email            │ TariffId        │
├─────────┼──────────┼──────────────────┼─────────────────┤
│ 1234567 │ Jane Doe │ j.doe@acme.com   │ 9876543         │
└─────────┴──────────┴──────────────────┴─────────────────┘
```

### Piped/redirected (PII redacted)

```
🔒 PII redaction: ON (non-interactive)

[JSON/Markdown table with tokenized PII fields]
```

### With unlock (PII visible + warning)

```
⚠️  PII redaction: OFF (unlocked until 2026-05-14T13:30:00Z)

[Full data with real PII values]
```

The banner is always printed **before** the main output, so you can quickly see the current state.

## Threat model: What redaction protects against

| Threat                       | Mitigation                                                                               |
| ---------------------------- | ---------------------------------------------------------------------------------------- |
| **PII flows to LLM**         | Tokens are sent instead of real values; LLM sees only opaque references                  |
| **Agent bypasses redaction** | No `--no-redact` flag exists. Redaction is structural based on TTY detection.            |
| **Agent unlocks PII**        | Unlock requires browser-based 2FA via admin panel — agents cannot drive browser sessions |
| **Prompt bypass (stdin)**    | No terminal prompt to confirm — unlock is poll-based, waiting for browser confirmation   |
| **New field leaks**          | Schema annotations ensure new fields are redacted by default (fail-closed)               |
| **Summary text leaks**       | Summary fields containing PII are automatically redacted                                 |
| **Token reversal**           | Tokens are salted and stored locally; cannot derive real values without the local file   |
| **Challenge replay**         | Nonce expires in 120s, is tied to authenticated user, rate-limited to 5/hour             |

## PII token storage

The CLI stores a local mapping of tokens to real values in `~/.nexudus/pii-tokens.json`:

```json theme={null}
{
  "version": 1,
  "tokens": {
    "«PII:EMAIL:a3f2b1c9»": "j.doe@acme.com",
    "«PII:NAME:7e4d2f8a»": "Jane Doe",
    "«PII:PHONE:1b3c5d7e»": "+44 7700 900123"
  }
}
```

### Important notes about token storage

* **Local only**: Token mappings are stored only on your machine. They are never sent to the API or stored in logs.
* **Resolvable by CLI**: When you pass a token as a command argument, the CLI looks it up in this file to recover the real value.
* **Per-installation**: Each machine has its own salt and token store. Tokens from one machine won't match another.
* **Human-readable for debugging**: You can examine the file to understand which values have been tokenized.

### Clearing tokens

To clear the local token store:

```bash theme={null}
nexudus config set pii-clear-tokens
```

This deletes the token mapping file. Tokens in your command history will no longer resolve — be careful if you need to use them again.

## Best practices for agents

### ✅ Do

* **Use tokens**: Read tokenized output from list/get commands and pass tokens back to update/create commands.
* **Check redaction status**: Always read `piiRedaction` and `piiRedactionReason` to know the current mode.
* **Cache tokens**: Store tokens in your agent state if you need to reference the same entity across multiple commands.
* **Plan for token loss**: Keep records of what you're doing so you can re-fetch entities if needed.

### ❌ Don't

* **Do not attempt to reverse-engineer tokens** — they're salted and hashed, not reversible.
* **Do not display tokens to end users** as if they were real data — explain that they're security redactions.
* **Do not request PII unlock** — it requires browser-based 2FA confirmation that agents cannot complete.
* **Do not omit the `--agent` flag** to bypass redaction — redaction is structural, not flag-based.
* **Do not attempt to drive the browser 2FA flow** — the confirmation requires an authenticated admin panel session with same-origin CORS protection.
* **Do not store or log token mappings** — the CLI handles storage locally.

## Troubleshooting

### I see tokens but want real data

**Problem**: Output is redacted when you need to see real values.

**Solution 1**: Use an interactive terminal if possible — run the command directly in your shell.

**Solution 2**: Unlock PII temporarily:

```bash theme={null}
nexudus config set pii-mode unlocked --ttl 30m
```

### I see "PII redaction: OFF" but expected tokens

**Problem**: You expected redaction but it's not active.

**Reasons**:

* You're in an interactive terminal — redaction is OFF by default for humans.
* A previous unlock is still valid — check `piiRedactionReason`.
* Your output is not being piped — TTY detection shows it's interactive.

**Solution**: Check `piiRedactionReason` in the JSON envelope to understand why:

```bash theme={null}
nexudus coworkers list --json | jq '.piiRedactionReason'
```

### Tokens don't resolve when I pass them back

**Problem**: Command fails with "invalid email" or similar when I use a token as an argument.

**Reasons**:

* Token was from a different machine/installation (different salt).
* Token store was cleared (`nexudus config set pii-clear-tokens`).
* Token format is incorrect or corrupted.

**Solution**: Re-fetch the entity fresh to get current tokens:

```bash theme={null}
nexudus coworkers list --json | jq '.data[] | select(.id == 12345) | .email'
```

### Unlock isn't working

**Problem**: `nexudus config set pii-mode unlocked` fails or times out.

**Possible reasons**:

* Browser didn't open — check your default browser configuration.
* You didn't confirm in time — the challenge expires in 120 seconds.
* You're not logged into the admin panel — you'll be redirected to login first.
* Rate limit hit — maximum 5 challenges per user per hour.

**Solution**: Run the unlock command again and confirm in your browser within 120 seconds:

```bash theme={null}
# Run the unlock command
$ nexudus config set pii-mode unlocked --ttl 30m

# Browser opens automatically to the admin panel
# Log in if needed, then click "Confirm Unlock"
# CLI will detect the confirmation and save the session

✓ PII unlocked (expires 2026-05-14T11:00:00Z)
```

If your browser doesn't open automatically, copy the URL from the CLI output and open it manually.

## FAQ

<Accordion title="Can I disable PII redaction?">
  No. Redaction is structural and based on TTY detection — it cannot be disabled by flags. However, you can unlock it temporarily via the browser-based 2FA flow if you genuinely need full PII in a non-interactive context. The unlock requires authenticating in the Nexudus admin panel and cannot be automated by agents.
</Accordion>

<Accordion title="Why are tokens not reversed when I pass them to a script?">
  Tokens are salted per installation and stored in `~/.nexudus/pii-tokens.json`. If your script runs on a different machine or in a Docker container without that file, tokens won't resolve. The CLI will reject invalid tokens with an error.
</Accordion>

<Accordion title="Can I extract all tokens from the token store?">
  Yes — the file is in plaintext JSON at `~/.nexudus/pii-tokens.json`. You can read and parse it for debugging. Never share this file or its contents with others — it exposes real PII.
</Accordion>

<Accordion title="Is PII redaction available in all CLI commands?">
  Yes. Every entity query (list, get, search) respects the PII redaction mode. Create/update commands also resolve tokens transparently. If a command doesn't show PII fields, it's not related to redaction.
</Accordion>

<Accordion title="What happens if an agent passes an unknown token?">
  The CLI tries to resolve it from the token store. If not found, it passes the token literal to the API. The API validation will reject it (e.g., "invalid email format"), and the command fails with that error. This is intentional — prevents accidentally using stale tokens.
</Accordion>

<Accordion title="Can I share token mappings with colleagues?">
  Not recommended. Tokens are salted per machine — mappings from your machine won't work on someone else's. Each person should generate their own tokens on their own machine by running queries with redaction enabled.
</Accordion>

<Accordion title="Is PII redaction the same as encryption?">
  No. Redaction is a **display-time transformation**. PII is not encrypted in transit or at rest — the CLI and API use HTTPS. Redaction is an **additional** layer that hides PII from agent contexts and logs, using local tokenization and salting.
</Accordion>

## Related documentation

* [Output Modes](/cli/output-modes) — Understanding JSON, Markdown, and Agent output formats
* [Authentication](/cli/authentication) — Credential storage and login
* [Agent Skills](/cli/agent-skills-overview) — Using the CLI with AI assistants


# Public API Commands
Source: https://learn.nexudus.com/cli/public-api

Use the Nexudus CLI to access your coworking space as a member — manage plans, bookings, invoices, visitors, and more via the public API.

# Public API Commands

The Nexudus CLI supports the **Public API**, which allows you to interact with your coworking space as a member rather than an administrator. This is the same API that powers the members portal, and it lets you manage your plans, bookings, invoices, visitors, and more from the command line.

All public API commands use the `nexudus public` prefix and authenticate against a specific location's subdomain at `{webaddress}.spaces.nexudus.com`.

## How it works

The Public API targets a single location (determined by its web address/subdomain) and authenticates using member credentials (email + password). Tokens are stored separately from admin credentials, so you can switch between admin and member contexts independently.

```
nexudus public <domain> <action> [options] [--json | --md | --agent]
```

For example:

```bash theme={null}
# Authenticate as a member
nexudus public login --web-address myspace --email you@example.com --password xxx

# List your active plans
nexudus public plans list

# View your upcoming bookings
nexudus public bookings list

# Check your invoices
nexudus public invoices list
```

## Authentication

### Log in as a member

```bash theme={null}
nexudus public login --web-address myspace --email you@example.com --password your-password
```

| Option          | Description                                                                       |
| --------------- | --------------------------------------------------------------------------------- |
| `--web-address` | The subdomain of your location (e.g., `myspace` for `myspace.spaces.nexudus.com`) |
| `--email`       | Your member email address                                                         |
| `--password`    | Your member password                                                              |
| `--totp`        | Two-factor authentication code (if 2FA is enabled)                                |

If any option is omitted, the CLI will prompt you interactively.

<Info>
  Public API tokens are stored separately from admin credentials. You can be logged in as both an admin and a member simultaneously.
</Info>

### Verify your session

```bash theme={null}
nexudus public whoami
```

This displays your authenticated member information, including your email, web address, token expiry, and associated profiles.

### Log out

```bash theme={null}
nexudus public logout
```

This clears stored public API (member) credentials only — your admin credentials remain unaffected.

## Command Reference

### Business & Location

| Command                                  | Description                        |
| ---------------------------------------- | ---------------------------------- |
| `nexudus public businesses current`      | Get current location details       |
| `nexudus public businesses networks`     | Get all network locations          |
| `nexudus public businesses all`          | Get all businesses in the network  |
| `nexudus public businesses withVisitors` | Get locations accepting visitors   |
| `nexudus public businesses withTour`     | Get locations with available tours |
| `nexudus public configuration get`       | Get mobile app configuration       |
| `nexudus public countries list`          | Get all countries                  |

Most business commands support the `--shape` option to request only specific fields:

```bash theme={null}
nexudus public businesses current --shape "Name,WebAddress,Country.Name"
```

### Plans & Contracts

| Command                                   | Description                           |
| ----------------------------------------- | ------------------------------------- |
| `nexudus public plans list [--cancelled]` | List your active or cancelled plans   |
| `nexudus public plans get <id>`           | Get details of a specific plan        |
| `nexudus public plans published`          | Browse all published plans            |
| `nexudus public plans cancel <id>`        | Cancel a plan contract                |
| `nexudus public contracts list`           | List your contracts                   |
| `nexudus public contracts get <id>`       | Get contract details                  |
| `nexudus public contracts pause <id>`     | Pause a contract for N billing cycles |
| `nexudus public contracts resume <id>`    | Resume a paused contract              |

**Examples:**

```bash theme={null}
# List active plans
nexudus public plans list

# List cancelled plans
nexudus public plans list --cancelled

# Cancel a plan with reason
nexudus public plans cancel 12345 --reason 1 --notes "Moving to another location"

# Pause a contract for 2 billing cycles
nexudus public contracts pause 12345 --cycles 2
```

### Invoices & Billing

| Command                                                  | Description                      |
| -------------------------------------------------------- | -------------------------------- |
| `nexudus public invoices list [--paid] [--credit-notes]` | List your invoices               |
| `nexudus public invoices get <id>`                       | Get invoice details              |
| `nexudus public products list`                           | List your products               |
| `nexudus public discounts list`                          | List your discount codes         |
| `nexudus public discounts referral`                      | Get your referral discount codes |
| `nexudus public discounts refer <code_id> <email>`       | Send a referral invite           |

**Examples:**

```bash theme={null}
# List unpaid invoices
nexudus public invoices list --paid false

# List credit notes
nexudus public invoices list --credit-notes

# Send a referral invite
nexudus public discounts refer 98765 friend@example.com
```

### Bookings & Resources

| Command                                    | Description                          |
| ------------------------------------------ | ------------------------------------ |
| `nexudus public bookings list [--past]`    | List your upcoming or past bookings  |
| `nexudus public bookings get <id-or-guid>` | Get booking details                  |
| `nexudus public bookings delete <id>`      | Cancel a booking                     |
| `nexudus public bookings suggestions`      | Get booking suggestions              |
| `nexudus public bookings team`             | Get team bookings                    |
| `nexudus public bookings teamCancelled`    | Get cancelled team bookings          |
| `nexudus public bookings cancellationFee`  | Get cancellation fee for a booking   |
| `nexudus public resources summary`         | Get published resources summary      |
| `nexudus public resources details`         | Get published resources with details |
| `nexudus public resources get <id>`        | Get specific resource details        |
| `nexudus public resources products <id>`   | Get products for a resource          |
| `nexudus public resources fields <id>`     | Get custom fields for a resource     |

**Examples:**

```bash theme={null}
# List upcoming bookings
nexudus public bookings list

# List past bookings
nexudus public bookings list --past

# Cancel a booking
nexudus public bookings delete 12345 --reason "NoLongerNeeded" --details "Meeting was rescheduled"

# Browse available resources
nexudus public resources summary
```

### Visitors

| Command                                 | Description                         |
| --------------------------------------- | ----------------------------------- |
| `nexudus public visitors list [--past]` | List your upcoming or past visitors |
| `nexudus public visitors get <id>`      | Get visitor details                 |
| `nexudus public visitors create`        | Create a new visitor                |
| `nexudus public visitors delete <id>`   | Delete a visitor                    |
| `nexudus public visitors approve <id>`  | Approve or reject a visitor         |

**Examples:**

```bash theme={null}
# List upcoming visitors
nexudus public visitors list

# Create a visitor
nexudus public visitors create --business-id 12345 --full-name "John Doe" --email "john@example.com" --expected-arrival "2026-07-10T10:00:00"

# Create visitors from a JSON file
nexudus public visitors create --json-file visitors.json

# Approve a visitor
nexudus public visitors approve 12345
```

### Profile & Settings

| Command                                       | Description                            |
| --------------------------------------------- | -------------------------------------- |
| `nexudus public profile patch`                | Update your profile                    |
| `nexudus public coworkers profiles`           | Get all your profiles across locations |
| `nexudus public coworkers benefits`           | Get your benefits (credits, passes)    |
| `nexudus public coworkers setCurrent`         | Set your active profile                |
| `nexudus public settings get <name>`          | Get a specific setting value           |
| `nexudus public settings getMultiple <names>` | Get multiple setting values            |
| `nexudus public settings search <query>`      | Search settings                        |
| `nexudus public settings set <name> <value>`  | Set a setting value                    |
| `nexudus public settings setMultiple`         | Set multiple settings at once          |

**Examples:**

```bash theme={null}
# Update your profile
nexudus public profile patch --json-request '{"User":{"FirstName":"John"},"Coworker":{"Phone":"555-0100"}}'

# Check your benefits
nexudus public coworkers benefits

# Get a specific setting
nexudus public settings get "maxBookingDays"
```

### Store & Checkout

| Command                           | Description                        |
| --------------------------------- | ---------------------------------- |
| `nexudus public store list`       | Browse store products              |
| `nexudus public store get <id>`   | Get store product details          |
| `nexudus public checkout preview` | Preview checkout with basket items |
| `nexudus public signup contact`   | Send a contact form message        |

**Examples:**

```bash theme={null}
# Browse store products
nexudus public store list

# Filter to time passes only
nexudus public store list --only-time-passes

# Filter by tag
nexudus public store list --tag "printing"

# Preview checkout
nexudus public checkout preview --basket '[{"ProductId":123,"Quantity":1}]' --agreed-terms
```

### Community

| Command                                               | Description            |
| ----------------------------------------------------- | ---------------------- |
| `nexudus public community threads list`               | List community threads |
| `nexudus public community threads get <id>`           | Get thread details     |
| `nexudus public community threads start`              | Start a new thread     |
| `nexudus public community threads delete <id>`        | Delete a thread        |
| `nexudus public community threads like <id>`          | Like a thread          |
| `nexudus public community threads follow <id>`        | Follow a thread        |
| `nexudus public community threads messages list <id>` | List thread messages   |
| `nexudus public community threads messages reply`     | Reply to a thread      |
| `nexudus public community threads messages like`      | Like a message         |
| `nexudus public community groups list`                | List community groups  |
| `nexudus public community tags list`                  | List thread tags       |

**Examples:**

```bash theme={null}
# List community threads
nexudus public community threads list

# Start a new thread
nexudus public community threads start --subject "Welcome event this Friday" --message "Join us for drinks and networking!" --tags "events,community"

# Like a thread
nexudus public community threads like 12345
```

### Perks

| Command                                | Description          |
| -------------------------------------- | -------------------- |
| `nexudus public perks list`            | List available perks |
| `nexudus public perks claim <perk-id>` | Claim a perk         |

### Blog & Content

| Command                                                            | Description             |
| ------------------------------------------------------------------ | ----------------------- |
| `nexudus public blog list [--category-id] [--search] [--featured]` | List blog posts         |
| `nexudus public blog get <id>`                                     | Get a blog post         |
| `nexudus public blog categories`                                   | List blog categories    |
| `nexudus public events list [--past] [--category-id] [--featured]` | List events             |
| `nexudus public events get <id>`                                   | Get event details       |
| `nexudus public faq list [--search]`                               | List FAQ articles       |
| `nexudus public newsletter subscribe <email>`                      | Subscribe to newsletter |

**Examples:**

```bash theme={null}
# Browse blog posts
nexudus public blog list

# Search blog posts
nexudus public blog list --search "workshop"

# List upcoming events
nexudus public events list

# Subscribe to newsletter
nexudus public newsletter subscribe you@example.com --name "John Doe"
```

### Courses

| Command                                            | Description                |
| -------------------------------------------------- | -------------------------- |
| `nexudus public courses list [--group] [--search]` | List available courses     |
| `nexudus public courses get <id>`                  | Get course details         |
| `nexudus public courses my`                        | List your enrolled courses |
| `nexudus public courses signup <id>`               | Sign up for a course       |
| `nexudus public courses accept <id>`               | Accept a course invitation |
| `nexudus public courses lessons <id>`              | List course lessons        |
| `nexudus public courses lesson get <id>`           | Get lesson details         |
| `nexudus public courses lesson complete <id>`      | Mark a lesson as complete  |

### Help Desk

| Command                                       | Description                    |
| --------------------------------------------- | ------------------------------ |
| `nexudus public helpdesk messages list`       | List your help desk messages   |
| `nexudus public helpdesk messages get <id>`   | Get message details            |
| `nexudus public helpdesk messages create`     | Create a new help desk message |
| `nexudus public helpdesk messages close <id>` | Close a message                |
| `nexudus public helpdesk comments list <id>`  | List comments on a message     |
| `nexudus public helpdesk comments create`     | Add a comment                  |
| `nexudus public helpdesk departments list`    | List help desk departments     |

### Teams

| Command                                  | Description                 |
| ---------------------------------------- | --------------------------- |
| `nexudus public teams my`                | List your teams             |
| `nexudus public teams profile <id>`      | Get team profile            |
| `nexudus public teams published`         | Browse published teams      |
| `nexudus public teams publishedGet <id>` | Get published team details  |
| `nexudus public teams addMembers <id>`   | Add members to a team       |
| `nexudus public teams removeMember <id>` | Remove a member from a team |
| `nexudus public teams attendance <id>`   | Get team attendance         |
| `nexudus public teams kpi <id>`          | Get team KPIs               |
| `nexudus public teams metrics <id>`      | Get team metrics            |
| `nexudus public teams directoryMeta`     | Get team directory metadata |

### Deliveries & Mail

| Command                                           | Description                  |
| ------------------------------------------------- | ---------------------------- |
| `nexudus public deliveries list [--show-pending]` | List your deliveries         |
| `nexudus public delivery get <id>`                | Get delivery details         |
| `nexudus public delivery update <id>`             | Update delivery info         |
| `nexudus public delivery markCollected <id>`      | Mark a delivery as collected |

### Virtual Offices

| Command                                  | Description                    |
| ---------------------------------------- | ------------------------------ |
| `nexudus public vo meta`                 | Get virtual office metadata    |
| `nexudus public vo form get`             | Get the virtual office form    |
| `nexudus public vo form submit`          | Submit the virtual office form |
| `nexudus public vo amlChecks list`       | List AML checks                |
| `nexudus public vo amlChecks start`      | Start an AML check             |
| `nexudus public vo identityChecks list`  | List identity checks           |
| `nexudus public vo identityChecks start` | Start an identity check        |
| `nexudus public vo directors list`       | List company directors         |
| `nexudus public vo directors add`        | Add a company director         |
| `nexudus public vo recipients list`      | List mail recipients           |
| `nexudus public vo recipients add`       | Add a mail recipient           |
| `nexudus public vo companyAliases list`  | List company aliases           |
| `nexudus public vo companyAliases add`   | Add a company alias            |

### Identity & Legal

| Command                                     | Description                   |
| ------------------------------------------- | ----------------------------- |
| `nexudus public identityChecks list`        | List your identity checks     |
| `nexudus public identityChecks get <id>`    | Get identity check details    |
| `nexudus public identityChecks upload <id>` | Upload identity documents     |
| `nexudus public legal status`               | Check terms acceptance status |
| `nexudus public legal accept`               | Accept terms and conditions   |

**Examples:**

```bash theme={null}
# Check if you've accepted terms
nexudus public legal status

# Accept general terms
nexudus public legal accept --general

# Accept both general and contract terms
nexudus public legal accept --all
```

### Forms & Surveys

| Command                                    | Description                |
| ------------------------------------------ | -------------------------- |
| `nexudus public form get <id>`             | Get a form page            |
| `nexudus public form preview <id>`         | Preview a form             |
| `nexudus public form submit <id>`          | Submit a form              |
| `nexudus public survey questionnaire <id>` | Get a survey questionnaire |
| `nexudus public survey preview <id>`       | Preview a survey           |
| `nexudus public survey submit <id>`        | Submit survey answers      |

### Onboarding & Data Files

| Command                                      | Description               |
| -------------------------------------------- | ------------------------- |
| `nexudus public onboarding get`              | Get onboarding actions    |
| `nexudus public dataFiles list`              | List your data files      |
| `nexudus public dataFiles getFileUrl <id>`   | Get file download URL     |
| `nexudus public dataFiles getSignedUrl <id>` | Get signed URL for a file |
| `nexudus public dataFiles eSignStatus <id>`  | Get e-signature status    |

### Payments

| Command                                                  | Description                      |
| -------------------------------------------------------- | -------------------------------- |
| `nexudus public payments stripe createCustomerSession`   | Create a Stripe payment session  |
| `nexudus public payments stripe createSetupSession`      | Create a Stripe setup session    |
| `nexudus public payments paypal createCustomerSession`   | Create a PayPal customer session |
| `nexudus public payments paypal createGuestSession`      | Create a PayPal guest session    |
| `nexudus public payments spreedly createCustomerSession` | Create a Spreedly session        |
| `nexudus public payments spreedly storePaymentMethod`    | Store a Spreedly payment method  |

## Response Shaping

Many public API endpoints support **response shaping** via the `--shape` option. This lets you request only the fields you need, reducing response size and improving performance.

```bash theme={null}
# Full response
nexudus public plans list

# Only specific fields
nexudus public plans list --shape "Name,Price,FromTime"

# Nested fields using dot notation
nexudus public businesses current --shape "Name,WebAddress,Country.Name,Currency.Code"
```

<Tip>
  Not all commands support `--shape`. It's available on commands that wrap endpoints with response shaping support (most list and get operations).
</Tip>

## Global Flags

All public API commands support the same global flags as admin commands:

| Flag                   | Description                                         |
| ---------------------- | --------------------------------------------------- |
| `--json`               | Output raw JSON (for scripting)                     |
| `--md`                 | Output as Markdown tables                           |
| `--agent`              | Output structured JSON envelope (for AI assistants) |
| `--web-address <addr>` | Override the location subdomain                     |

## Error Handling

### Common Errors

| Error                                | Cause                          | Solution                                    |
| ------------------------------------ | ------------------------------ | ------------------------------------------- |
| "Not logged in (public)"             | No public API token stored     | Run `nexudus public login`                  |
| "Unauthorized"                       | Token expired or invalid       | Run `nexudus public login` again            |
| "Two-factor authentication required" | 2FA is enabled on your account | Use `--totp` to provide your code           |
| "Account locked"                     | Too many failed login attempts | Wait and retry, or reset your password      |
| "Account disabled"                   | Account has been disabled      | Contact your space administrator            |
| "Must reset password"                | Password reset required        | Use "Forgot password" on the members portal |

## Next steps

<CardGroup>
  <Card title="Install the CLI" icon="download" href="/cli/installation">
    Download and set up the Nexudus CLI on your machine.
  </Card>

  <Card title="Admin Commands" icon="shield" href="/cli/commands">
    Browse the full reference of admin CLI commands.
  </Card>
</CardGroup>


# Troubleshooting
Source: https://learn.nexudus.com/cli/troubleshooting

Solutions to common issues when using the Nexudus CLI and Agent Skills.

# Troubleshooting

## CLI issues

### `nexudus` command not found

The CLI is installed as a .NET global tool. Make sure:

1. You have the [.NET SDK](https://dotnet.microsoft.com/download) installed (version 8 or later).
2. You ran `dotnet tool install --global Nexudus.Cli`.
3. The .NET tools directory is in your system `PATH`:
   * **Windows:** `%USERPROFILE%\.dotnet\tools`
   * **macOS/Linux:** `~/.dotnet/tools`

### API connection failures

If `nexudus doctor` reports that the API is unreachable:

* Check your internet connection.
* Verify the base URL is correct: `nexudus config get base-url` (default: `https://spaces.nexudus.com`).
* Check whether a proxy or firewall is blocking outbound HTTPS connections.

### Credential storage errors on Linux

The CLI uses `libsecret` for credential storage on Linux. If you get errors:

```bash theme={null}
# Install libsecret (Ubuntu/Debian)
sudo apt-get install libsecret-1-0 libsecret-1-dev

# Install libsecret (Fedora/RHEL)
sudo dnf install libsecret libsecret-devel
```

Make sure a keyring service (GNOME Keyring or KDE Wallet) is running.

### Commands return empty results

* Confirm you are authenticated: `nexudus whoami`.
* Check that your account has permissions for the entity type you're querying.
* Try broadening your search: remove `--query` filters or increase `--size`.

## Agent Skill issues

### AI assistant doesn't recognise the Nexudus skill

1. Verify the skill is installed: `npx skills list` should show `nexudus`.
2. Restart your editor or AI assistant session — skills are loaded at startup.
3. If using VS Code with GitHub Copilot, try reloading the window (`Ctrl+Shift+P` → "Reload Window").

### AI assistant returns "Not logged in" errors

The AI assistant calls the CLI, which needs active credentials:

```bash theme={null}
nexudus login
```

After logging in, retry your request.

### AI assistant constructs incorrect commands

The skill file may be outdated. Update to the latest version:

```bash theme={null}
npx skills add Nexudus-Ltd/nexudus-coworking-skills
```

You can also ask your assistant to run `nexudus <entity> <command> --help` to discover the correct options.

### Pagination issues

By default, list commands return 25 results per page. If you're not seeing all your data:

* Ask for a larger page: *"List all products with page size 100"*
* Or paginate: *"Show page 2 of products"*

## Telemetry issues

### Commands are slow or timing out

Telemetry is sent to a remote service and has a 3-second timeout. If telemetry is slow:

1. Verify the timeout isn't blocking your commands — the CLI continues even if telemetry fails.
2. Disable telemetry if you prefer: `nexudus config set telemetry off`
3. Check your network connection — poor connectivity may cause timeouts.

### Can't disable telemetry

To disable telemetry:

```bash theme={null}
nexudus config set telemetry off
```

To verify it's disabled:

```bash theme={null}
nexudus config get telemetry
```

If telemetry key doesn't exist, telemetry is enabled by default. Explicitly set it to `off` to disable.

### Want to verify telemetry is disabled

You can verify by:

1. Checking your config: `nexudus config get telemetry` should return `off`
2. Checking the config file at `~/.nexudus/config.json` — it should contain `"telemetry": "off"`
3. Enabling debug mode to check local logs: `nexudus config set telemetry-debug on` and checking `~/.nexudus/telemetry.jsonl`

For detailed telemetry information and privacy details, see the [Telemetry](/cli/telemetry) documentation.

## Getting help

* **CLI help:** `nexudus --help` or `nexudus <command> --help`
* **Diagnostics:** `nexudus doctor`
* **GitHub Issues:** [nexudus-coworking-skills](https://github.com/Nexudus-Ltd/nexudus-coworking-skills/issues)
* **Nexudus Help Center:** [help.nexudus.com](https://help.nexudus.com)


# Editor Components & Mock Data
Source: https://learn.nexudus.com/customisation/editor-components-and-mock-data



This guide explains how the page editor is wired in the Members Portal and how mock data is injected so you can design and test components without a live API.

## Key concepts

* Editor configuration lives in `src/views/admin/editor/components/useEditorConfiguration.tsx` and uses Puck (`@measured/puck`) to declare components, fields, categories and render functions.
* Components that need data typically accept a `mockData` prop and delegate fetching to a `use*Data` hook which supports an optional `mockData` override.
* Mock payloads are colocated in `src/views/admin/editor/mockData/mocks/*.ts` and are lazy-loaded via a small helper hook.

## How mock data works

1. Opt-in at the editor field level

   * Most components include a `withMockData` field and default it to `true` in the editor only.
   * `useEditorConfiguration` provides `withMockDataFields` which you can spread into a component's `fields`.

2. Load the data

   * Editor render functions call `useMockedData(Name, inEditor && props.withMockData)` and pass the result to the presentational component as `mockData`.
   * The hook is defined in `src/views/admin/editor/mockData/mockedData.ts`.

3. Provide a mock module
   * Place a file named exactly like the editor component key in `src/views/admin/editor/mockData/mocks/`.
   * Export `getMockData(business?: any)` which returns the mocked payload. `business` is provided by the current route context and helps match currency, branding, etc.

### The `useMockedData` hook

Source: `src/views/admin/editor/mockData/mockedData.ts`

* Uses `import.meta.glob('./mocks/*.ts')` to lazily import `{Name}.ts`.
* Calls `getMockData(business)` if present and returns its result.
* When `loadData` is false, returns `undefined` so live fetching occurs.

## The data hooks contract

Data hooks (for example `useFaqData`, `useBlogData`, `useProductsData`, `usePredictiveBookingsData`) call `useData`/`useTypedData` from `src/api/fetchData.ts`.

* They accept an optional `mockData` parameter.
* `useData` short-circuits and returns `{ resource: mockData, isLoading: false }` if `mockData` is provided, otherwise it performs the real HTTP call.
* Hooks also declare response shapes via `createShape(...)` to limit fields and enable server-side shaping.

## Adding a new editor component

1. Create the UI component

   * Add a presentational component under `src/views/admin/editor/components/editorComponents/v1/YourComponentEC.tsx`.
   * The component should accept an optional `mockData` prop (typed to the shape your data hook expects) and pass it to the relevant `use*Data` hook, or consume it directly if it doesn't fetch.

2. Add mock data (optional but recommended)

   * Create `src/views/admin/editor/mockData/mocks/YourComponent.ts` exporting `getMockData(business?: any)`.
   * Return a payload that matches what your UI expects. You can import and reuse other mocks to keep parity across variants.

3. Register the component in the editor

   * Open `src/views/admin/editor/components/useEditorConfiguration.tsx`.
   * Add a lazy import for your `YourComponentEC`.
   * Extend the `Components` type with a `YourComponent: {}` entry.
   * Add a config entry under `components` with:
     * `label`
     * `fields` (include `...withMockDataFields` if you support it)
     * `defaultProps` (often `{ withMockData: true }`)
     * `render: (props) => { const mockData = useMockedData('YourComponent', props.editMode && props.withMockData); return <YourComponentEC {...props} mockData={mockData} /> }`
   * Optionally, add it to a `categories` group so it appears in the editor palette.

4. Wire a data hook (if needed)
   * In your `YourComponentEC`, call the relevant `use*Data(mockData)` hook and pass its return to the presentational child.
   * Example pattern:
     ```tsx theme={null}
     import { useXData } from '@/views/x/useXData'
     export default function YourComponentEC(props: { mockData?: typeof shape.type } & any) {
       const data = useXData(props.mockData)
       return <YourComponent data={data} {...props} />
     }
     ```

## Naming rules and gotchas

* File naming must match the editor key exactly. If your key is `UpcomingEventsDashboardSection`, the mock file must be `UpcomingEventsDashboardSection.ts`.
* `getMockData` can accept the `business` object to tailor outputs (currency, business name, web address).
* When outside the editor (live runtime), `withMockData` has no effect—mock hook returns `undefined` and real requests run.
* Keep mock payloads small and representative. Prefer a handful of items and realistic field names so the UI matches production.

## Example: FAQ section

* Editor config:
  * In `useEditorConfiguration`, the `FaqPageSection` entry sets `defaultProps: { withMockData: true }` and passes `mockData` to `<FaqPageSectionEC/>`.
* Mock file:
  * `src/views/admin/editor/mockData/mocks/FaqPageSection.ts` exports several FAQ articles.
* Data hook:
  * `src/views/faq/useFaqData.tsx` accepts `mockData` and passes it into `useTypedData(..., { mockData })`.

## Troubleshooting

* "No mock module found" error: ensure the mock filename matches the editor component name and lives under `mockData/mocks/`.
* Mock renders but shape mismatch: align the mock payload with the `shape` your data hook requests.
* Not seeing mock vs live toggle: make sure the component spreads `...withMockDataFields` and uses `props.editMode` to guard loading.

## Checklists

When adding a component:

* [ ] UI component under `editorComponents/v1`
* [ ] Mock under `mockData/mocks` with `getMockData`
* [ ] Editor registration in `useEditorConfiguration`
* [ ] Category placement
* [ ] Optional data hook integration that respects `mockData`


# Register and authenticate add-ons
Source: https://learn.nexudus.com/developers/add-ons

Learn how to register an add-on application in Nexudus, configure its settings, and authenticate API requests using the application key and secret.

# Register and authenticate add-ons

This guide explains how to register a new add-on application in Nexudus, configure its installation URL and required roles, and authenticate API requests using your application credentials.

> 💡 **Before you start**
>
> Add-ons (also called published add-ons) are third-party integrations that can be installed by Nexudus customers. If you're building a custom integration for your own space only, you may not need this flow — consider using a standard API access token instead.

## Overview

Every add-on in Nexudus has two key credentials:

| Credential          | Description                                                                                                     |
| ------------------- | --------------------------------------------------------------------------------------------------------------- |
| **Application Key** | A unique identifier for your add-on. This is generated when you register the application and cannot be changed. |
| **Secret Key**      | A shared secret used to sign and validate installation requests. **Never share this key.**                      |

When a customer installs your add-on, Nexudus redirects them to your **Installation URL** with a set of parameters that your application uses to generate an authentication token. This token then allows your add-on to make API calls on behalf of the customer's account.

## Step 1: Register your add-on

You can register a new add-on application in two ways:

<Tabs>
  <Tab title="Nexudus Dashboard">
    1. Sign in to your Nexudus account as an **Admin**.
    2. Navigate to **Settings** > **Add-ons** > **Manage add-ons**.
    3. The management page is available at: `https://dashboard.nexudus.com/apps/applications/manage`
    4. Click **Create** to add a new application.
    5. Fill in the required fields:

    | Field                 | Description                                                                                                                       |
    | --------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
    | **Name**              | A display name for your add-on (required).                                                                                        |
    | **Short Description** | A brief description of what your add-on does (required).                                                                          |
    | **Description**       | A full HTML description shown during installation.                                                                                |
    | **Installation URL**  | The URL where Nexudus will redirect users after they approve the installation. This must be a publicly accessible HTTPS endpoint. |
    | **Published**         | Set to `true` if you want this add-on available in the Nexudus marketplace.                                                       |
    | **Required Roles**    | Select the roles that a user must have to install and use this add-on.                                                            |
  </Tab>

  <Tab title="REST API">
    You can also create an application using the REST API. You'll need admin-level API access.

    **Create an application:**

    ```
    POST /api/apps/applications
    Content-Type: application/json
    Authorization: Basic <credentials>
    ```

    ```json theme={null}
    {
      "Name": "My Add-on",
      "ShortDescription": "A brief description",
      "Description": "<p>Full HTML description</p>",
      "InstallUrl": "https://myapp.com/install",
      "Published": false,
      "RequiredRoles": [1, 2]
    }
    ```

    For the full API reference, see [Create Application](/rest-api/apps/post-applications).
  </Tab>
</Tabs>

## Step 2: Retrieve your application credentials

After creating the application, you need to retrieve the **Application Key** and **Secret Key**. You can find these in the Dashboard or via the REST API.

<Tabs>
  <Tab title="Nexudus Dashboard">
    After creating the application in the Dashboard, your credentials are displayed on the application's detail page. Navigate to **Settings** > **Add-ons** > **Manage add-ons**, click on your application, and you will see the Application Key and Secret Key listed.

    > 🚨 **Important**
    >
    > **Never share your Secret Key.** If someone obtains your Secret Key, they can impersonate your add-on and access customer data. Store it securely in your application configuration.
  </Tab>

  <Tab title="REST API">
    You can also retrieve your application credentials using the REST API.

    **Get all applications:**

    ```
    GET /api/apps/applications/my
    Content-Type: application/json
    Authorization: Basic <credentials>
    ```

    **Response:**

    ```json theme={null}
    [
      {
        "Name": "My Add-on",
        "ApplicationKey": "f36292c02d9c438d98d8c9eb34897c90",
        "SecretKey": "b5d83da7a...7febc62d8dc",
        "InstallUrl": "https://myapp.com/install",
        "Published": false,
        "RequiredRoles": [1, 2]
      }
    ]
    ```

    > 🚨 **Important**
    >
    > **Never share your Secret Key.** If someone obtains your Secret Key, they can impersonate your add-on and access customer data. Store it securely in your application configuration.

    For the full API reference, see [Get Applications](/rest-api/apps/get-applications).
  </Tab>
</Tabs>

## Step 3: Handle the installation callback

When a user installs your add-on, Nexudus redirects them to the **Installation URL** you configured. The redirect includes several query parameters:

| Parameter | Description                                                |
| --------- | ---------------------------------------------------------- |
| `a`       | Your Application Key (unique identifier)                   |
| `t`       | A unique token to generate the authentication token        |
| `d`       | A timestamp (DateTime ticks) representing the current time |
| `h`       | An MD5 hash for request validation                         |
| `b`       | The Nexudus subdomain of the account installing the add-on |
| `e`       | The email of the user installing the add-on                |

**Example redirect URL:**

```
https://myapp.com/install?
a=f36292c02d9c438d98d8c9eb34897c90&
t=c90e30fca71a4c37810a292b99d4d4f2&
d=634963729314011098&
h=785a10afef749b1c26cc3c5eb3989082&
b=subdomain&
e=user@example.com
```

### Validating the request

Before proceeding, verify the request is genuinely from Nexudus by recalculating the hash:

1. Take the parameters `token` (`t`), `applicationKey` (`a`), and `timespan` (`d`).
2. Sort them alphabetically.
3. Join them with a pipe (`|`) separator.
4. Append your **Secret Key** to the end.
5. Calculate the MD5 hash of the resulting string.
6. Compare your calculated hash with the `h` parameter.

<CodeGroup>
  ```csharp C# theme={null}
  // Extract parameters from the request
  var token   = Request.QueryString["t"];
  var appKey  = Request.QueryString["a"];
  var timespan = Request.QueryString["d"];
  var hash    = Request.QueryString["h"];
  var secret  = ConfigurationManager.AppSettings["SecretKey"];

  // Calculate expected hash
  var param = new[] { token, appKey, timespan };
  Array.Sort(param);  // Sort alphabetically
  var joined = string.Join("|", param);
  var input  = joined + secret;
  var expectedHash = MD5Hash(input);

  // Validate
  if (expectedHash != hash)
  {
      // Request is not from Nexudus — reject it
      return HttpUnauthorized();
  }
  ```

  ```javascript Node.js theme={null}
  const crypto = require('crypto');

  // Extract parameters from the request (Express.js example)
  function installHandler(req, res) {
    const { t: token, a: appKey, d: timespan, h: hash } = req.query;
    const secret = process.env.NEXUDUS_SECRET_KEY;

    // Calculate expected hash
    const params = [token, appKey, timespan].sort();  // Sort alphabetically
    const joined = params.join('|');
    const input = joined + secret;
    const expectedHash = crypto.createHash('md5').update(input).digest('hex');

    // Validate
    if (expectedHash !== hash) {
      return res.status(403).send('Invalid request');
    }

    // Generate authentication token
    const authToken = crypto.createHash('md5')
      .update(token + secret)
      .digest('hex');

    // Store authToken securely for subsequent API calls
    // ...
  }
  ```
</CodeGroup>

### Generating the authentication token

Once the request is validated, generate the authentication token:

<CodeGroup>
  ```csharp C# theme={null}
  var authToken = MD5Hash(token + secret);
  ```

  ```javascript Node.js theme={null}
  const authToken = crypto.createHash('md5')
    .update(token + secret)
    .digest('hex');
  ```
</CodeGroup>

This `authToken` is used as the password in Basic Authentication when making API calls.

## Step 4: Make authenticated API requests

After installation, your add-on can make API requests using **Basic Authentication**:

| Field        | Value                                                                    |
| ------------ | ------------------------------------------------------------------------ |
| **Username** | Your **Application Key**                                                 |
| **Password** | The generated **authentication token** (MD5 hash of `token + secretKey`) |

**Example request:**

```
GET /api/businesses
Authorization: Basic QWxhZGRp...lc2FtZQ==
```

> 💡 **Note**
>
> The authentication token is generated once during installation and is tied to the specific customer account that installed your add-on. You should store this token securely for subsequent API calls.

## What happens during installation

When a user approves the installation of your add-on, Nexudus performs the following actions behind the scenes:

1. **Creates an API access user** — A new system user is created with the email format `{applicationKey}_{businessId}_api@nexudus.com` and `APIAccess = true`. This user is linked to your add-on.
2. **Records the installation** — An `InstalledApplication` record is created, linking your application to the customer's business.
3. **Generates credentials** — The authentication token is computed and passed to your installation URL.
4. **Redirects to your app** — The user is redirected to your Installation URL with the generated parameters.

## Related entities

The following Nexudus entities are involved in the add-on system:

| Entity                               | Description                                                                                                            |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| **Applications**                     | Defines the add-on application, including its key, secret, install URL, and required roles.                            |
| **InstalledApplications**            | Records when an application is installed in a specific business account, including whether admin approval is required. |
| **MarketPlaceApplications**          | Tracks applications published to the Nexudus marketplace.                                                              |
| **InstalledMarketPlaceApplications** | Records installations of marketplace applications.                                                                     |

For the full API reference, see the [Apps & Marketplace](/rest-api/apps/) section.

## Submit your application for approval

Once your add-on is ready, follow these steps to submit it for approval to the Nexudus team:

1. **Update your application details** — Make sure the following fields are meaningful and accurate:

   | Field           | Guidance                                                                            |
   | --------------- | ----------------------------------------------------------------------------------- |
   | **Logo**        | Upload a clear, professional logo that represents your brand.                       |
   | **Name**        | Use a descriptive name that clearly communicates what your add-on does.             |
   | **Description** | Provide a detailed and accurate description of your add-on's features and benefits. |

2. **Send an approval request** — Email **[support@nexudus.com](mailto:support@nexudus.com)** with the following information:

   * Your **add-on URL** (the public URL where your add-on is hosted)
   * Your **Privacy Policy** URL
   * Your **Terms of Service** URL

   The Nexudus team will review your submission and get back to you once the approval process is complete.

## Best practices

* **Store your Secret Key securely** — Never commit it to source control or expose it in client-side code.
* **Validate every installation request** — Always recalculate the hash before trusting any parameters from the installation callback.
* **Use HTTPS** — Your Installation URL should always use HTTPS to protect the credentials in transit.
* **Check required roles** — Ensure the installing user has the roles your add-on requires before proceeding.
* **Handle re-installation** — If a user already has your add-on installed, Nexudus may redirect directly without showing the installation prompt.


# createShape
Source: https://learn.nexudus.com/developers/data/create-shape

Type-safe field selection for server-side shaping with compile-time validation.

# createShape

`createShape<T>()` builds a compile-time checked list of fields to request from the server. It validates dot-paths against `T` and produces a phantom `type` that represents the shaped response. Pair it with `useData` or `useTypedData` to append `_shape=...` to requests.

Source: `src/helpers/shape-helper.ts`

## Why

* Keep responses small by requesting only what you need
* Maintain end-to-end type safety: invalid paths fail at compile time
* Works with nested objects and arrays (e.g. `Records.Items.Name` or `Posts.Title`)

## Usage

```ts theme={null}
const shape = createShape<ResponseType>()(['Records.Id', 'Records.Name'])

// shape.fields → ['Records.Id', 'Records.Name']
// shape.type   → { Records: { Id: number; Name: string }[] } (phantom type)
```

Then pass `shape.fields` through `useData` or directly pass the shape object to `useTypedData`:

```tsx theme={null}
const { resource } = useTypedData(httpClient, endpoint, shape)
```

## Arrays and nesting

If `Posts` is an array, `'Posts.Title'` yields `{ Posts: { Title: string }[] }` in `shape.type`.

## Compile-time validation

Invalid paths produce a TypeScript error via `ValidatePaths<T, Paths>`.

```ts theme={null}
// Error: Invalid path: "profiles.fullName" if fullName doesn’t exist
const shape = createShape<User>()(['id', 'profiles.fullName'])
```

## End-to-end example

```tsx theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'
import { createShape } from '@/helpers/shape-helper'

const endpoint = endpoints.teams.list(true)
const shape = createShape<typeof endpoint.type>()(['Records.Id', 'Records.Name'])
const { resource } = useTypedData(httpClient, endpoint, shape)
```

## Best practices

* Define shapes next to the data hook or at top-level when reused across components
* Name exported shapes descriptively, e.g. `teamListShape`
* Keep shapes minimal; add fields only when needed by the UI

## See also

* [useData](/developers/data/use-data)
* [useTypedData](/developers/data/use-typed-data)


# useData
Source: https://learn.nexudus.com/developers/data/use-data

React Query-based data fetching hook with shape, pagination, method, and mock support.

# useData

`useData` is a lightweight wrapper around React Query that standardizes HTTP calls, adds first-class support for server-side shaping, pagination, and an optional `mockData` override for editor scenarios.

Source: `src/api/fetchData.ts`

## Signature

```ts theme={null}
function useData<T>(
  apiClient: HttpClient,
  url: string | null,
  requestConfig?: {
    method?: 'get' | 'post' | 'put' | 'delete'
    data?: any
    queryConfig?: Partial<QueryObserverOptions<T>>
    shape?: string[]
    page?: number
    size?: number
    mockData?: T
  },
): {
  resource: T | undefined
  hasError: boolean
  isLoading: boolean
  query?: Omit<UseQueryResult<T>, 'data' | 'isError' | 'isLoading'>
}
```

## Behavior

* Adds `_shape=...` to the URL when `shape` is provided (comma-separated fields)
* Adds `page` and `size` if provided
* Uses React Query to fetch with a stable key that includes:
  * `finalUrl`, `method`, `data`, `apiClient.defaults.baseURL`, and `apiClient.defaults.headers`
* Disables retry for HTTP 401 errors; otherwise retries up to 3 times
* If `mockData` is provided, short-circuits and returns it immediately with `isLoading: false`

Note on caching: headers are part of the query key; token/header changes will revalidate. If you need header-agnostic caching, use `useSuspenseFetch` with `includeHeaders: false`.

## Examples

### GET with shaping and pagination

```tsx theme={null}
import { useData } from '@/api/fetchData'
import { useLocationByRouteContext } from '@/states/useLocationByRouteContext'

export function UseDataExample() {
  const { httpClient } = useLocationByRouteContext()
  const { resource, isLoading, hasError } = useData<{ Records: Array<{ Id: number; Name: string }> }>(httpClient, '/api/public/teams/my', {
    shape: ['Records.Id', 'Records.Name'],
    page: 1,
    size: 20,
    queryConfig: { staleTime: 60_000 },
  })

  if (isLoading) return <div>Loading…</div>
  if (hasError) return <div>Failed to load</div>
  return <pre>{JSON.stringify(resource, null, 2)}</pre>
}
```

### POST with payload

```tsx theme={null}
const { resource } = useData<{ Success: boolean }>(httpClient, '/api/public/helpdesk/messages', {
  method: 'post',
  data: { subject: 'Printer', message: 'Paper jam on Floor 2' },
})
```

### Editor/mock data

```tsx theme={null}
const { resource } = useData(httpClient, '/api/public/faqs', {
  mockData: { FaqArticles: [{ Question: 'Q?', Answer: 'A!' }], OpenAiEnabled: false },
})
```

## Return values

* `resource` – The typed response or `undefined` while loading
* `isLoading` – React Query loading flag
* `hasError` – React Query error flag (boolean)
* `query` – The rest of the React Query result (methods, status) minus the basic fields

## Edge cases

* `url` is `null`/falsy → hook is disabled (`enabled: false`) and no request is made
* 401 Unauthorized → no retries (fast-fail to let auth state respond)

## See also

* [useTypedData](/developers/data/use-typed-data) – Strongly-typed wrapper around `useData`
* [createShape](/developers/data/create-shape) – Type-safe shape builder for `_shape` query
* [LocationContext](/developers/state/location-context) – Ensure you call with the correct `httpClient`


# usePageParams
Source: https://learn.nexudus.com/developers/data/use-page-params

Derive page and size from the URL query string with optional namespacing/prefix and share pagination field shapes.

# usePageParams

`usePageParams` reads `page` and `size` from the current URL (via React Router’s `useSearchParams`) and returns a small object you can pass directly into `useData`/`useTypedData` to populate `page` and `size` query parameters.

Source: `src/api/usePageParams.ts`

## Signature

```ts theme={null}
export const usePageParams: (props?: { prefix?: string; defaultSize?: number }) => {
  paging: { page: number; size: number }
  prefix?: string
  paginationProperties: readonly (keyof ApiListResult<any>)[]
}
```

## Behavior

* Reads `page` and `size` from the URL.
* Supports namespacing multiple paginators on a page via `prefix`:
  * With `prefix: 'comments'` it reads `page_comments` and `size_comments`.
* Defaults:
  * `page` defaults to 1
  * `size` defaults to `defaultSize` (if provided) or 25
* Exposes `paginationProperties`, a readonly list of field names to include in shapes when working with `ApiListResult<T>` responses.

## Examples

### Basic list with paging

```tsx theme={null}
import { useData } from '@/api/fetchData'
import { usePageParams } from '@/api/usePageParams'

const { paging } = usePageParams()
const { resource } = useData<MyList>(httpClient, '/api/public/items', {
  ...paging, // adds page & size to the URL
})
```

### With shapes for paginated responses

```tsx theme={null}
import { createShape } from '@/helpers/shape-helper'
import { paginationProperties, usePageParams } from '@/api/usePageParams'

const shape = createShape<ApiListResult<Item>>()([
  'Records.Id',
  'Records.Name',
  ...paginationProperties, // PageNumber, PageSize, TotalItems, etc.
])

const { paging } = usePageParams({ defaultSize: 10 })
const { resource } = useData<ApiListResult<Item>>(httpClient, '/api/public/items', {
  shape: shape.fields,
  ...paging,
})
```

### Multiple independent paginators

```tsx theme={null}
// Parent page
const files = usePageParams({ prefix: 'files', defaultSize: 25 })
const comments = usePageParams({ prefix: 'comments', defaultSize: 5 })

// URLs managed independently: page_files/size_files and page_comments/size_comments
```

## Notes

* `usePageParams` only reads params; updating page/size is done via `useSearchParams` or Link navigation.
* The hook is UI-agnostic and doesn’t render anything; it’s safe to use anywhere.

## See also

* [useData](/developers/data/use-data)
* [useTypedData](/developers/data/use-typed-data)
* [createShape](/developers/data/create-shape)


# useTypedData
Source: https://learn.nexudus.com/developers/data/use-typed-data

Typed data fetching helper that pairs endpoint.type with a compile-time shape.

# useTypedData

`useTypedData<T, TShaped>` builds on top of `useData` and the typed endpoint definitions found in `src/api/endpoints.ts`. It takes an endpoint object `{ url, type }`, an optional `createShape<TShaped>()([...])`, and returns the shaped, typed resource.

Source: `src/api/fetchData.ts`

## Signature

```ts theme={null}
function useTypedData<T, TShaped>(
  apiClient: HttpClient,
  endpoint?: { url: string | null; type: T } | null,
  shape?: { type: TShaped; fields: string[] },
  requestConfig?: {
    mockData?: any
    method?: 'get' | 'post' | 'put' | 'delete'
    data?: any
    queryConfig?: Partial<QueryObserverOptions<TShaped>>
    page?: number
    size?: number
  },
): ReturnType<typeof useData<TShaped>>
```

`useTypedData` simply calls `useData<TShaped>(apiClient, endpoint?.url, { ...requestConfig, shape: shape?.fields })`.

## Pattern

1. Pick an endpoint from `src/api/endpoints.ts` (these expose `type` with the expected response)
2. Build a shape for the response using `createShape<typeof endpoint.type>()([...])`
3. Call `useTypedData(httpClient, endpoint, shape, { ...options })`

## Example – FAQ list

```tsx theme={null}
import endpoints from '@/api/endpoints'
import { useTypedData } from '@/api/fetchData'
import { createShape } from '@/helpers/shape-helper'
import { useLocationByRouteContext } from '@/states/useLocationByRouteContext'

export const useFaqData = (mockData?: any) => {
  const { httpClient } = useLocationByRouteContext()
  const endpoint = endpoints.faqs.list()
  const shape = createShape<typeof endpoint.type>()(['FaqArticles', 'OpenAiEnabled'])

  const { resource: data, isLoading, hasError } = useTypedData(httpClient, endpoint, shape, { mockData })

  return { data, isLoading, hasError }
}
```

## Example – Teams list with paging

```tsx theme={null}
const endpoint = endpoints.teams.list(true)
const shape = createShape<typeof endpoint.type>()(['Records.Id', 'Records.Name'])
const { resource } = useTypedData(httpClient, endpoint, shape, { page: 1, size: 10 })
```

## Notes

* You can still pass `method`, `data`, and `queryConfig` – these flow through to `useData`.
* `mockData` short-circuits fetching – great for the editor and tests.

## See also

* [useData](/developers/data/use-data) – Base hook with full config
* [createShape](/developers/data/create-shape) – Build type-safe field lists
* [useLocationByRouteContext](/developers/state/use-location-by-route-context) – To get the correct `httpClient`


# Project Folder Structure
Source: https://learn.nexudus.com/developers/folder-structure

Developer guide to the repository layout, key folders, and how the pieces fit together.

# Project Folder Structure

This page gives you a quick tour of the repository so you can find things fast.

## Top-level layout

```text theme={null}
.
├─ api/                     # Utility/serverless scripts (e.g., SCSS pre-processing)
├─ dist-widget/             # Production build of the embeddable widget (static assets)
├─ dist-widget-debug/       # Debug build of the embeddable widget (+ maps & demo assets)
├─ docs/                    # Documentation site (Mintlify) content
├─ public/                  # Static assets served by Vite at the site root
├─ scripts/                 # Maintenance utilities (e.g., i18n tooling)
├─ src/                     # Application source (React + TypeScript)
├─ widget/                  # Standalone widget demo/host page and locales
├─ dev.mjs                  # Local dev helpers
├─ i18next-parser.config.cjs# i18n extraction config
├─ index.html               # Vite root HTML (app entry in dev/prod)
├─ jest.config.js           # Jest configuration (if/when used)
├─ vite.config.ts           # Vite configuration for builds and dev server
├─ vitest.config.ts         # Vitest configuration for unit tests
├─ vitest.setup.ts          # Test setup (jsdom, mocks, etc.)
├─ tsconfig*.json           # TypeScript configuration(s)
├─ bun.lockb                # Bun lockfile
├─ package.json             # Scripts and dependencies
└─ vercel.json              # Vercel deployment config (for docs or widget hosting)
```

## Source code (`src/`)

* `api/` – Client-side API helpers (endpoints, fetch wrappers, param parsing, suspense wrappers)
* `assets/` – Static assets used by the app (images, data, SCSS sources)
* `components/` – Reusable UI components
* `errorBoundries/` – Error boundary components and fallbacks
* `helpers/` – Pure helper utilities and formatting helpers
* `hooks/` – Reusable React hooks
* `layouts/` – Layout wrappers (shared chrome)
* `routes/` – Route-level components and loaders
* `states/` – Global or module-level state containers
* `transitions/` – Animation/transition helpers
* `types/` – TypeScript type definitions
* `utils/` – Generic utilities not tied to React
* `views/` – Page-level or feature-complete views
* Root files
  * `App.tsx` – App root
  * `main.tsx` – Vite entry
  * `i18n.ts` – i18next initialization
  * `widget.tsx` – Widget bootstrapping/entry

## Builds and distributions

* `dist-widget/` – Production bundle of the widget and its assets. This is what you deploy/embed.
* `dist-widget-debug/` – Debug build (includes source maps and demo assets for easier testing).

## Static assets (`public/`)

Files in `public/` are served as-is at the site root by Vite. Use this for icons, manifest, and images that should not pass through the bundler.

## Documentation (`docs/`)

Mintlify-powered documentation lives here. MDX pages are organized by topic (e.g., `api/`, `overview/`, `customisation/`). The navigation is defined in `docs/docs.json`.

## Scripts and utilities

* `api/scss-to-css.ts` – SCSS-to-CSS processing script (used in build/deploy pipelines)
* `scripts/` – i18n and maintenance utilities; for example `translate-missing.mjs` and ignored translations lists.

## Widget demo (`widget/`)

Contains a minimal host page (`index.htm`) and locales for trying the widget in isolation.

## Testing

* `vitest.config.ts`, `vitest.setup.ts` – Unit test configuration (Vitest)
* `jest.config.js` – Jest config (kept for compatibility in some environments)

## Notes

* Build and dev flows are handled by Vite. Check `package.json` scripts for standard commands.
* Internationalization is i18next-based; see `src/i18n.ts` and `public/locales/*`.


# Developer Resources
Source: https://learn.nexudus.com/developers/overview

APIs, tools, and integrations for building on the Nexudus Platform

Everything you need to integrate with, extend, and automate the Nexudus Platform.

<CardGroup>
  <Card title="REST API Reference" icon="book-open" href="/rest-api/overview">
    Complete reference for every endpoint in the Nexudus REST API. Manage locations, customers, bookings, billing, and more programmatically.
  </Card>

  <Card title="Public API Reference" icon="plug" href="/api/overview">
    The API that powers the Members Portal. Use it to build custom front-ends, mobile apps, or third-party integrations for your members.
  </Card>

  <Card title="Marketplaces API" icon="store" href="/rest-api/marketplaces/overview">
    API for marketplace providers aggregating inventory data across Nexudus customers. Register your marketplace and sync resources, bookings, and availability.
  </Card>

  <Card title="Environment API" icon="temperature-half" href="/rest-api/environment/overview">
    Pull and receive sensor data to trigger actions and display measurements. Connect IoT devices and environmental sensors to your spaces.
  </Card>

  <Card title="Access Control" icon="lock" href="/integrations/access-control/overview">
    Connect your access control systems to Nexudus. Build custom integrations for door locks, turnstiles, and other entry systems.
  </Card>

  <Card title="Network Bridge" icon="bridge" href="/integrations/network-bridge">
    Connect with systems and services installed on your Location's local network - without requiring VPNs, static IP addresses, or firewall port forwarding.
  </Card>

  <Card title="Nexudus CLI" icon="terminal" href="/cli/overview">
    Command-line tool and AI Agent Skills for managing Nexudus coworking spaces. Automate tasks, manage entities, and integrate with AI assistants.
  </Card>

  <Card title="Nexudus SDK" icon="cube" href="/sdk/overview">
    The official .NET SDK for interacting with the Nexudus REST API programmatically. Typed models, CRUD operations, and filtering built in.
  </Card>

  <Card title="Register and authenticate add-ons" icon="puzzle" href="/developers/add-ons">
    Learn how to register a new add-on application, configure its settings, and authenticate API requests using application credentials.
  </Card>
</CardGroup>


# LocationContext (provider composition)
Source: https://learn.nexudus.com/developers/state/location-context

How the application composes location providers, Suspense, auth, and settings to deliver scoped context to your components.

# LocationContext

`LocationContext` is a thin component that composes the app’s providers in the correct order so your components can rely on a fully-initialized environment: location resolution, auth, settings, and UI scaffolding. It also provides a Suspense fallback for data-driven providers.

Source: `src/states/LocationContext.tsx`

## Composition order

```tsx theme={null}
export const LocationContext = (props: { children: ReactElement }) => {
  return (
    <Suspense fallback={<Preloader />}>
      <LocationByRouteProvider>
        <AuthProvider>
          <LocationSettingsProvider>
            <CSSLoaderComponent url="/api/styles/styles.css">
              <ModalProvider>{props.children}</ModalProvider>
            </CSSLoaderComponent>
          </LocationSettingsProvider>
        </AuthProvider>
      </LocationByRouteProvider>
    </Suspense>
  )
}
```

At the app root (`src/App.tsx`), the entire tree is wrapped by `LocationByHostProvider` before `LocationContext` is rendered. This guarantees host-level location is available before route-level overrides:

```tsx theme={null}
// src/App.tsx
<LocationByHostProvider>
  {/* boundaries, query, notifications, router */}
  <HomeRouter>
    <LocationContext>{/* app pages */}</LocationContext>
  </HomeRouter>
</LocationByHostProvider>
```

## Responsibilities

* Provide a Suspense boundary (`<Preloader />`) for data-loading providers.
* Scope business context either by route param (via `LocationByRouteProvider`) or fallback to host (via `LocationByHostProvider` at the app root).
* Ensure authentication, location settings, and modal system are available to children.

## When to use

Use `LocationContext` to wrap your routed application. If you’re building a standalone view or micro-frontend, replicate the same provider order to guarantee consistent behavior.

## Related hooks and providers

* [useLocationByHostContext](/developers/state/use-location-by-host-context) – Resolve business by host/domain
* [useLocationByRouteContext](/developers/state/use-location-by-route-context) – Override business by `:webAddress`


# useLocationByHostContext
Source: https://learn.nexudus.com/developers/state/use-location-by-host-context

Resolve and access the current business context from the host/domain and bootstrap scoped HTTP clients.

# useLocationByHostContext

`useLocationByHostContext` resolves the current Business based on the configured host (domain) and exposes a business-scoped `httpClient`, a root `apiClient`, and the `business` record. It bootstraps the location context used across the app and is intended to wrap the whole application.

Typical flow: the app loads using the current host (e.g. `acme.spaces.nWexudus.com`), `LocationByHostProvider` finds the matching Business, and makes that available to all children. Route-level overrides can later switch business via `useLocationByRouteContext`.

## What you get

* `Id: number` – Current business ID
* `WebAddress: string` – Current business web address
* `httpClient: HttpClient` – Axios-like client scoped to `https://{WebAddress}.spaces.nexudus.com`
* `apiClient: HttpClient` – API root client using `apiBaseUrl` from app config
* `business: Business` – Business details from `endpoints.system.business`

## Provider and placement

You must render the provider at the app root, before anything that consumes location state. The repository already does this in `src/App.tsx`:

```tsx theme={null}
// src/App.tsx
<HelmetProvider>
  <ErrorBoundary FallbackComponent={AppErrorFallback}>
    <LocationByHostProvider>
      {/* ... */}
      <HomeRouter>
        <LocationContext>{/* app content */}</LocationContext>
      </HomeRouter>
      {/* ... */}
    </LocationByHostProvider>
  </ErrorBoundary>
</HelmetProvider>
```

This ensures every consumer of `useLocationByHostContext` or `useLocationByRouteContext` is safely wrapped.

## How it works

* Reads `config.host` from `useAppConfig()`.
* Fetches `GET /api/sys/businesses/getByHost?host={config.host}` using the root `apiClient(config.apiBaseUrl)`.
* Builds `httpClient = ApiHttpClient(WebAddress)` and `apiClient = ApiHttpClient(config.apiBaseUrl)`.
* Fetches `business` via `endpoints.system.business` with `includeHeaders: false` to avoid cache invalidation on auth changes.
* Throws `NO_BUSINESS_FOR_HOST` if no matching business is found.

Source: `src/states/useLocationDomainContext.tsx`.

## Usage example

```tsx theme={null}
import { useLocationByHostContext } from '@/states/useLocationDomainContext'

export function HostBusinessBadge() {
  const { business } = useLocationByHostContext()
  return <span>{business.Name}</span>
}
```

`useLocationByRouteContext` will override the `httpClient` and `business` when a `:webAddress` is present in the route; otherwise, consumers see this host-level context.

## Edge cases and errors

* Usage outside the provider throws: `useLocationByHostContext must be used within an LocationByHostContext`.
* Suspense: data loading is Suspense-based, so ensure a `<Suspense>` boundary above the provider tree (the app already has one in `LocationContext`).
* `NO_BUSINESS_FOR_HOST` indicates misconfiguration of the domain/host.

## See also

* [useLocationByRouteContext](/developers/state/use-location-by-route-context) – Route param override for business context
* [LocationContext](/developers/state/location-context) – Provider composition used by the app


# useLocationByRouteContext
Source: https://learn.nexudus.com/developers/state/use-location-by-route-context

How to scope API calls and business context by the :webAddress route parameter.

# useLocationByRouteContext

`useLocationByRouteContext` is a React hook that exposes the current Business context and scoped HTTP clients based on the `:webAddress` route parameter. If the parameter is present, the hook resolves the matching business and returns an `httpClient` bound to that business. If it’s absent, it falls back to the host-level location context.

It’s designed for multi-location portals where you can deep-link to a specific business (e.g. `/london/bookings`, `/new-york/events`).

## What you get

The hook returns the following shape:

* `Id: number` – The current business ID
* `WebAddress: string` – The current business web address
* `httpClient: HttpClient` – An Axios-like client scoped to the current business (`https://{WebAddress}.spaces.nexudus.com`)
* `apiClient: HttpClient` – An API root client (base `apiBaseUrl` from app config)
* `business: Business` – The full business record fetched from `endpoints.system.business`

## Provider and placement

This hook must be used inside `LocationByRouteProvider` (and within a `<Suspense>` boundary, because data loading uses Suspense):

```tsx theme={null}
// src/states/LocationContext.tsx
export const LocationContext = (props: { children: ReactElement }) => {
  return (
    <Suspense fallback={<Preloader />}>
      <LocationByRouteProvider>
        <AuthProvider>
          <LocationSettingsProvider>
            <CSSLoaderComponent url="/api/styles/styles.css">
              <ModalProvider>{props.children}</ModalProvider>
            </CSSLoaderComponent>
          </LocationSettingsProvider>
        </AuthProvider>
      </LocationByRouteProvider>
    </Suspense>
  )
}
```

If you use the app’s default `LocationContext` wrapper, you’re already covered.

## How it works

* Reads `:webAddress` from React Router (`useParams()`). Routes define it as `/:webAddress` or nested via `:webAddress/*`.
* If present, fetches `GET /api/sys/businesses/getByHost?host={webAddress}` using the root `apiClient`.
* Builds a business-scoped `httpClient = ApiHttpClient(WebAddress)` and copies auth headers from the host context (`httpClient.defaults.headers = hostContext.httpClient.defaults.headers`) to keep the user session.
* Fetches the full `business` via `endpoints.system.business` using the scoped `httpClient`.
* Uses `useSuspenseFetch(..., { includeHeaders: false })` so auth header changes don’t bust the cache.
* If `:webAddress` is missing, it falls back to the host-level location from `useLocationByHostContext`.

Source: `src/states/useLocationByRouteContext.tsx` (provider and hook) and `src/states/LocationContext.tsx` (composition).

## Usage examples

### Make business-scoped API calls

```tsx theme={null}
import { useLocationByRouteContext } from '@/states/useLocationByRouteContext'

export function TeamProfile() {
  const { httpClient, business } = useLocationByRouteContext()

  // Call an endpoint scoped to the current business
  // e.g. httpClient.get('/api/teams')
  // ... render using `business` fields as needed

  return <div>Current business: {business.Name}</div>
}
```

### Deep-link between businesses

Ensure your routes include `:webAddress` and build links with it. When a user navigates, the hook will re-resolve the business and swap the scoped `httpClient` for you.

```tsx theme={null}
import { Link, useParams } from 'react-router-dom'

export function SwitchBusinessLink({ toWebAddress }: { toWebAddress: string }) {
  const params = useParams()
  return (
    <Link to={`/${toWebAddress}/bookings`} state={{ from: params.webAddress }}>
      Go to {toWebAddress}
    </Link>
  )
}
```

## Routing contract

* Define routes with `:webAddress`, for example:
  * `path: '/:webAddress'`
  * or nested: `<Route path=":webAddress/*" element={<App />} />`
* When the param is present, the context will re-scope to that business; otherwise it uses the host context.

Related code: `src/routes/index.tsx` and `src/routes/HomeRouter.tsx`.

## Edge cases and errors

* Hook usage outside its provider throws: `useLocationByRouteContext must be used within an LocationByRouteContext`.
* Data loading is Suspense-based; components must render under a `<Suspense>` boundary.
* If a `:webAddress` does not resolve to any business, the underlying fetch may trigger your Suspense fallback or error boundary depending on the response. Consider wrapping route segments with an error boundary where appropriate.
* Authentication headers are mirrored from the host context each render so sessions persist across business switches.

## See also

* [useLocationByHostContext](/developers/state/use-location-by-host-context) – Host-level location resolution and bootstrapping (`src/states/useLocationDomainContext.tsx`).
* [LocationContext](/developers/state/location-context) – The app wrapper that composes all providers (`src/states/LocationContext.tsx`).


# Styling System
Source: https://learn.nexudus.com/developers/styling-system

How the Members Portal styling architecture works, and how to extend or adjust existing components.

The Members Portal uses **Bootstrap 5.3** with SCSS customisation, **CSS Modules** for component-scoped styles, and **CSS custom properties** for runtime theming. This page explains how these layers work together and how to make changes at each level.

## Architecture overview

```
┌──────────────────────────────────────────────────────┐
│  Runtime branding colours (per-location)             │  ← Highest priority
│  Injected via /api/scss-to-css endpoint              │
├──────────────────────────────────────────────────────┤
│  _user.scss                                          │  ← Project-level overrides
├──────────────────────────────────────────────────────┤
│  Component styles (.module.scss + global SCSS)       │
├──────────────────────────────────────────────────────┤
│  custom/ — Bootstrap component extensions            │
├──────────────────────────────────────────────────────┤
│  _variables.scss — Theme colour palette              │
├──────────────────────────────────────────────────────┤
│  _defaults.scss — Base colour defaults               │
├──────────────────────────────────────────────────────┤
│  Bootstrap 5.3 core                                  │  ← Lowest priority
└──────────────────────────────────────────────────────┘
```

Styles are compiled into a single CSS bundle. The compilation order in `style.scss` determines which layer can override which.

## Folder structure

All SCSS source files live under `src/assets/scss/`:

```text theme={null}
src/assets/scss/
├── style.scss              # Main entry – imports everything in order
├── _defaults.scss          # Default colour palette ($primary, $secondary, …)
├── _variables.scss         # Derived theme colours, contrast values, CSS vars
├── _variables-dark.scss    # Dark-mode variable overrides
├── _dark-mode.scss         # Dark-theme component rules
├── _mobile.scss            # Mobile-only responsive overrides
├── _user.scss              # Project-level custom rules (safe to edit)
├── icon.css                # Icon font definitions
├── custom/                 # Bootstrap component extensions
│   ├── _utilities.scss     # Extra utility classes
│   ├── _buttons.scss
│   ├── _card.scss
│   ├── _navbar.scss
│   ├── forms/
│   │   ├── _form-check.scss
│   │   └── _form-control.scss
│   └── …
└── components/             # Global component styles
    ├── _general.scss
    ├── _avatar.scss
    ├── _navbar-mobile.scss
    ├── _sidebar-admin.scss
    ├── _utilities.scss
    ├── _stepper.scss
    └── vendor/             # Third-party library overrides
        ├── dayPicker.scss
        ├── flatpickr.scss
        └── …
```

## Default colour palette

Default colours are defined in `_defaults.scss` using the `!default` flag, which means they can be overridden by any value set before the import:

```scss theme={null}
// _defaults.scss
$primary:   #ff5b13 !default;
$secondary: #0f0d76 !default;
$success:   #008d42 !default;
$danger:    #dc2626 !default;
$warning:   #da7500 !default;
```

`_variables.scss` then derives contrast colours, subtle variants, and border colours from these base values and exports them as a `$theme-colors` map. Bootstrap uses this map to generate CSS custom properties like `--bs-primary`, `--bs-primary-bg-subtle`, etc.

## How components are styled

Components use one of three patterns (often combined):

### CSS Modules (scoped styles)

Component-specific styles live in a `.module.scss` file next to the component. Class names are locally scoped at build time so they never leak.

```tsx theme={null}
// ArkSmallCard.tsx
import styles from './ArkSmallCard.module.scss'

export default function ArkSmallCard({ image }: Props) {
  return <img className={styles.fullImage} src={image} />
}
```

```scss theme={null}
// ArkSmallCard.module.scss
.fullImage {
  height: calc(100% - 100px);
  object-fit: cover;
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
}
```

<Tip>
  Use CSS custom properties inside `.module.scss` files to reference theme colours:
  `color: var(--bs-primary);`
</Tip>

### Bootstrap utility classes

Most layout and spacing is handled with Bootstrap 5 utility classes directly in JSX:

```tsx theme={null}
<div className="d-flex justify-content-between align-items-center mt-3 px-4">
  <h5 className="text-truncate fs-5 fw-bold text-body">{title}</h5>
</div>
```

The project extends Bootstrap's utility API in `custom/_utilities.scss` with additional helpers such as fixed-pixel heights (`h-40px`), viewport heights (`vh-100`), and more.

### Global SCSS (unscoped)

Some components import a plain `.scss` file for global styles. These affect the entire page and are typically used for animation keyframes or third-party library overrides:

```tsx theme={null}
import './Typewriter.scss'
```

<Warning>
  Prefer CSS Modules over global imports for new components. Global styles can cause unintended side-effects.
</Warning>

## Runtime branding (per-location colours)

Each location can set its own brand colours in the Nexudus dashboard. The portal loads these at runtime through a two-step process:

1. The client fetches `/api/scss-to-css?businessId=<id>&hash=<colorHash>`.
2. The endpoint compiles a virtual SCSS file that overrides `$primary`, `$secondary`, etc. before importing the full `style.scss`.
3. The compiled CSS is cached in Vercel Blob storage with a hash-based filename.
4. An edge function serves the cached file with CDN headers for fast delivery.

The virtual SCSS that gets compiled looks like this:

```scss theme={null}
$runtime: production;
$primary: #<locationColor>;
$secondary: #<locationColor>;
// … other overrides from the location's colour settings

@import 'style.scss';
```

Because `_defaults.scss` uses `!default`, the runtime values take precedence.

## Dark mode

Dark mode is controlled via the `data-bs-theme` attribute on the `<html>` element. The `_dark-mode.scss` file redefines CSS custom properties when this attribute is set:

```scss theme={null}
[data-bs-theme='dark'] {
  --bs-body-bg: #222529;
  --bs-body-color: #b0b0b8;
  --bs-border-color: rgba(255, 255, 255, 0.07);
  // … full dark palette
}
```

Theme switching is managed by the `useLayoutContext` hook:

```tsx theme={null}
const { updateTheme } = useLayoutContext()
updateTheme('dark')  // 'light' | 'dark' | 'auto'
```

The preference is saved to `localStorage` and restored on load.

<Info>
  When writing component styles, always use CSS custom properties (`var(--bs-body-bg)`) instead of hard-coded colour values. This ensures your styles work in both light and dark modes.
</Info>

## Extending Bootstrap utilities

Custom utility classes are registered in `custom/_utilities.scss` using Bootstrap's utility API. To add a new utility:

```scss theme={null}
// custom/_utilities.scss
$utilities: map-merge(
  $utilities,
  (
    "my-custom-util": (
      property: opacity,
      class: custom-opacity,
      values: (
        25: .25,
        50: .5,
        75: .75,
      )
    ),
  )
);
```

This generates classes like `.custom-opacity-25`, `.custom-opacity-50`, etc. with responsive variants if you add `responsive: true`.

## Overriding Bootstrap component styles

Bootstrap component customisations live in `custom/` as partial SCSS files (e.g., `_buttons.scss`, `_card.scss`). These are imported after Bootstrap core, so they can override default styles.

To adjust a Bootstrap component:

<Steps>
  <Step title="Find the right partial">
    Look in `src/assets/scss/custom/` for an existing file that matches the component (e.g., `_buttons.scss` for buttons).
  </Step>

  <Step title="Add your overrides">
    Write your SCSS rules in that file. You can use Bootstrap variables and mixins:

    ```scss theme={null}
    // custom/_buttons.scss
    .btn {
      border-radius: 0.5rem;
      font-weight: 600;
    }
    ```
  </Step>

  <Step title="Verify the import">
    Make sure the file is imported in `style.scss`. All existing partials are already imported.
  </Step>
</Steps>

## Adding styles to a new component

<Steps>
  <Step title="Create a CSS Module file">
    Add a `.module.scss` file next to your component:

    ```text theme={null}
    src/components/MyComponent/
    ├── MyComponent.tsx
    └── MyComponent.module.scss
    ```
  </Step>

  <Step title="Write scoped styles">
    ```scss theme={null}
    // MyComponent.module.scss
    .wrapper {
      padding: 1rem;
      border: 1px solid var(--bs-border-color);
      border-radius: var(--bs-border-radius);
      background: var(--bs-body-bg);
    }
    ```
  </Step>

  <Step title="Import and use in the component">
    ```tsx theme={null}
    import styles from './MyComponent.module.scss'

    export default function MyComponent() {
      return (
        <div className={styles.wrapper}>
          <p className="text-body fs-6 mb-0">Content</p>
        </div>
      )
    }
    ```
  </Step>
</Steps>

<Tip>
  Combine CSS Modules for component-specific layout with Bootstrap utilities for spacing and typography. This keeps styles scoped while reusing the design system.
</Tip>

## The `_user.scss` file

`_user.scss` is imported last in `style.scss` and is intended for project-level custom rules that don't belong to a specific component or Bootstrap override. It currently contains helpers like `.sticky-top-20`, `.no-select`, and `.disabled-component`.

Add rules here when you need a global utility that doesn't fit into Bootstrap's utility API or a component module.

## Key conventions

| Practice                                             | Rationale                                          |
| ---------------------------------------------------- | -------------------------------------------------- |
| Use CSS Modules for new components                   | Prevents style leaking between components          |
| Use `var(--bs-*)` for colours                        | Ensures light/dark mode and branding compatibility |
| Never hard-code colour values in components          | Runtime branding would not apply                   |
| Put Bootstrap overrides in `custom/`                 | Keeps overrides organized and discoverable         |
| Put vendor/library overrides in `components/vendor/` | Separates third-party concerns from project styles |
| Use `!default` for new SCSS variables                | Allows runtime and theme-level overrides           |


# useModal
Source: https://learn.nexudus.com/developers/ui/use-modal

Global modal system with promise-based API and a controller for fully controlled modals.

# useModal

`useModal` provides a global, promise-based modal API and a controller for building controlled modals. It is backed by a `ModalProvider` that renders two Bootstrap modals: a regular modal and a confirm modal.

Source: `src/states/useModalContext.tsx`

## Provider

Wrap your app with `ModalProvider`. The default `LocationContext` already includes it, so you usually don’t need to add it yourself.

```tsx theme={null}
// src/states/LocationContext.tsx
<LocationByRouteProvider>
  <AuthProvider>
    <LocationSettingsProvider>
      <CSSLoaderComponent url="/api/styles/styles.css">
        <ModalProvider>{children}</ModalProvider>
      </CSSLoaderComponent>
    </LocationSettingsProvider>
  </AuthProvider>
</LocationByRouteProvider>
```

## API

```ts theme={null}
type ModalContent = ReactNode | { render: (controller: ModalController) => ReactNode }

type ModalOptions = Partial<{
  title: string
  confirmText: string
  cancelText: string
  size: 'sm' | 'lg' | 'xl'
  bodyClassName: string
  confirmButtonClass: string // e.g. 'primary', 'danger'
  confirmHandler: () => () => Promise<void>
}>

type ModalContext = {
  showModal: (content: ModalContent, options?: ModalOptions) => Promise<void>
  hideModal: () => void
  confirm: (message: ModalContent, options?: ModalOptions) => Promise<boolean>
  hideAllModals: () => void
  setModalsVisible: (visible: boolean) => void
}

type ModalController = {
  setTitle(text: string): void
  setConfirmButtonText(text: string): void
  setCancelButtonText(text: string): void
  setConfirmButtonLoading(loading: boolean): void
  setCancelButtonLoading(loading: boolean): void
  setConfirmButtonDisabled(disabled: boolean): void
  setCancelButtonDisabled(disabled: boolean): void
  setOnConfirm(fn: () => Promise<void>): void
  close(): void
}
```

## Quick use

```tsx theme={null}
import { useModal } from '@/states/useModalContext'

const Example = () => {
  const { showModal, confirm } = useModal()

  const openInfo = async () => {
    await showModal(<div>Hello world</div>, { title: 'Info' })
  }

  const ask = async () => {
    const ok = await confirm('Delete this item?', { title: 'Confirm', confirmText: 'Delete', confirmButtonClass: 'danger' })
    if (ok) {
      // proceed
    }
  }

  return (
    <>
      <button onClick={openInfo}>Open modal</button>
      <button onClick={ask}>Confirm</button>
    </>
  )
}
```

## Controlled modals (advanced)

Controlled modals let the modal content drive button text, loading state, and confirm behavior using the `ModalController`. To opt in, pass a content object with a `render(controller)` function. Inside, call controller setters to update button state or register an async confirm handler.

```tsx theme={null}
const { showModal } = useModal()

const openControlled = async () => {
  await showModal(
    {
      render: (controller) => (
        <form
          onSubmit={(e) => {
            e.preventDefault()
            controller.setOnConfirm(async () => {
              controller.setConfirmButtonLoading(true)
              try {
                // await API call
              } finally {
                controller.setConfirmButtonLoading(false)
              }
            })
          }}>
          <input placeholder="Name" />
        </form>
      ),
    },
    { title: 'Create', confirmText: 'Save' },
  )
}
```

How it works:

* When you call `showModal`, the provider renders the regular modal.
* If your content is `{ render(controller) }`, the provider calls your render function and injects a `ModalController`.
* You then call `controller.setOnConfirm(fn)` to register the confirm handler; when the user clicks the confirm button (or closes), the provider executes it with error handling:
  * Shows a LoadingSpinner while the promise is pending (`setConfirmButtonLoading(true)`)
  * Displays an error `Alert` inside the modal if your handler throws
  * Closes the modal and resolves the promise when the handler completes successfully

Notes:

* You can dynamically change title and button labels using `setTitle`, `setConfirmButtonText`, and `setCancelButtonText`.
* Disable or enable buttons via `setConfirmButtonDisabled` and `setCancelButtonDisabled`.
* Call `controller.close()` to programmatically close the active modal.

## Confirm modals with custom content

`confirm(content, options)` behaves similarly, but displays a Cancel + Confirm footer. You can also control it via the same controller pattern:

```tsx theme={null}
const ok = await confirm(
  {
    render: (controller) => (
      <div>
        Are you absolutely sure?
        {/* Example: attach extra async work to the confirm action */}
        {controller.setOnConfirm(async () => {
          /* async side-effects */
        })}
      </div>
    ),
  },
  { title: 'Danger zone', confirmText: 'Yes, do it', confirmButtonClass: 'danger' },
)
```

## Error handling and loading

* The provider wraps your confirm handler in a try/catch and surfaces errors via a danger `Alert` in the modal body.
* `LoadingSpinner` is shown automatically on the confirm button while your handler is pending.

## Accessibility and visibility

* `setModalsVisible(false)` hides the modal UI but keeps state. Useful for embedded flows where the host temporarily forbids overlays.
* Modals are React-Bootstrap `Modal` components; ensure surrounding UI remains keyboard navigable.

## See also

* [LocationContext](/developers/state/location-context) – Includes the `ModalProvider` in the app provider stack


# Advanced: Iframes, Scripts, CustomerType & ResourcesProvider
Source: https://learn.nexudus.com/editor/advanced-components

Embed external content, load third-party scripts, conditionally show content by audience type, and provide resources context to child components.

The editor includes advanced components for embedding external content, targeting specific audiences, and providing data context to child components. They are found in the **Layout** category of the Blocks panel.

***

## Iframe

Embeds an external web page inside your portal page using a standard HTML `<iframe>`.

### Properties

| Property    | Type | Default | Description                             |
| ----------- | ---- | ------- | --------------------------------------- |
| `src`       | text | —       | The URL of the page to embed            |
| `title`     | text | —       | Accessible title for screen readers     |
| `width`     | text | —       | Width in px or % (e.g. `100%`, `600px`) |
| `height`    | text | —       | Height in px or % (e.g. `400px`)        |
| `className` | text | —       | Additional CSS classes                  |

### Usage

1. Drag the **Iframe** component onto the canvas.
2. Set the **Source URL** to the page you want to embed.
3. Set **Width** and **Height** to control the visible area.
4. Add a **Title** for accessibility.

The iframe renders with `border: none` by default. Use the `className` field to add Bootstrap utility classes for additional styling.

<Warning>
  Some websites block embedding via `X-Frame-Options` or `Content-Security-Policy` headers. If the embedded page shows a blank area or an error, the
  external site may be preventing iframe embedding.
</Warning>

***

## Script

Loads an external JavaScript file into the page. The script tag is appended to `<head>` when the component mounts and removed when it unmounts.

### Properties

| Property | Type   | Default | Description                        |
| -------- | ------ | ------- | ---------------------------------- |
| `src`    | text   | —       | URL of the JavaScript file to load |
| `async`  | select | No      | Load asynchronously: No, Yes       |

### Usage

1. Drag the **Script** component onto the canvas.
2. Set the **Script Source URL** to the URL of the JavaScript file.
3. Choose whether to load it asynchronously.

The Script component has **no visual output** — it is invisible on the canvas but functional at runtime. Use it to load third-party widgets, analytics, chat tools, or any external script.

### Behaviour details

* The component checks if a `<script>` tag with the same `src` already exists before adding a new one, preventing duplicate loads.
* When the component is removed from the page (or the page navigates away), the script tag is cleaned up from `<head>`.
* In the editor, the script is **not executed** to prevent interference with the editing experience.

<Warning>Only load scripts from trusted sources. Malicious scripts can compromise your portal and your members' data.</Warning>

***

## CustomerType

A wrapper component that conditionally shows or hides its children based on the current viewer's customer type. Use it to create audience-targeted content — for example, showing a special offer only to members or a sign-up prompt only to anonymous visitors.

### Properties

| Property     | Type   | Default  | Description                                                                              |
| ------------ | ------ | -------- | ---------------------------------------------------------------------------------------- |
| `items`      | slot   | —        | Drop zone for child components that will be conditionally displayed                      |
| `visibility` | select | everyone | Who can see this content: Everyone, Logged in users, Only for members, Only for contacts |

### Visibility options

| Value                 | Who sees the content                                                                           |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| **Everyone**          | All visitors, whether signed in or not                                                         |
| **Logged in users**   | Any authenticated user (members and contacts alike)                                            |
| **Only for members**  | Authenticated customers whose account type is **Member** (i.e. they have an active contract)   |
| **Only for contacts** | Authenticated customers whose account type is **Contact** (i.e. they have no active contracts) |

### Usage

1. Drag the **CustomerType** component onto the canvas.
2. Set the desired **visibility** option.
3. Drag one or more child components into the `items` slot.
4. At runtime, the content only renders if the current viewer matches the selected audience.

### Editor behaviour

In the editor, the CustomerType component always renders its children so you can edit them regardless of the visibility setting. When the content would be hidden for the current user type, the editor shows a **semi-transparent dashed border** with the text *"Hidden for current user type"* to indicate the content is conditionally hidden.

### Examples

**Show a welcome banner only to members:**

1. Add a CustomerType component.
2. Set visibility to **Only for members**.
3. Drop an Alert component inside with a welcome message.

**Show a sign-up CTA only to anonymous visitors:**

1. Add a CustomerType component with visibility **Everyone**.
2. Inside it, add a Container, Heading and Button linking to sign-up.
3. Add a second CustomerType component with visibility **Logged in users**.
4. Leave it empty or add different content.

Since there is no "anonymous only" option, use the **Everyone** visibility for the sign-up prompt and then place a separate CustomerType with **Logged in users** visibility below (or above) to show alternative content to authenticated users.

***

## Resources Provider

A wrapper component that provides **resources context** (bookable resources and floor plans) to its child components. Certain booking-related components require this context to function — if they are placed on a page that does not already include it, they will fail to render.

### When do you need it?

The following pages **already include** resources context automatically:

* Booking pages (resource list, resource calendar, checkout)
* Admin / editor pages

The following pages do **not** include resources context:

* **Home page**
* Dashboard and personal pages
* Events, courses and articles pages
* Settings and team pages
* Directory and community pages

### Which components require it?

| Component            | What it does                                     |
| -------------------- | ------------------------------------------------ |
| **ResourceList**     | Browsable list of bookable resources             |
| **ResourceCalendar** | Calendar view for browsing and booking resources |
| **BookingEdit**      | Booking creation and editing form                |

If you want to place any of these components on a page that does not have resources context (for example, adding a resource list to the Home page), you **must** wrap them inside a **Resources Provider** component.

### Usage

1. Drag the **Resources Provider** from the **Layout** category onto the canvas.
2. Drop one or more booking components (ResourceList, ResourceCalendar, or BookingEdit) into its slot.
3. The child components will now have access to the resources data they need.

<Frame>
  <img alt="Resources Provider wrapping a ResourceList component" />
</Frame>

### Properties

| Property   | Type | Description                                                |
| ---------- | ---- | ---------------------------------------------------------- |
| `children` | slot | Drop zone for child components that need resources context |

### Editor behaviour

In the editor, the Resources Provider renders as a plain container — no API calls are made. Child components display their own mock data as usual. At runtime, the provider fetches resources and floor plans so that nested components can access them.

<Warning>
  If you place a ResourceList, ResourceCalendar, or BookingEdit component on a page without wrapping it in a Resources Provider (and the page does not already have one), the page will show an error. Always check whether the target page already provides resources context before adding booking components.
</Warning>

<Tip>
  You do **not** need this wrapper on booking pages or checkout pages — those already have resources context built in. Adding an extra Resources Provider there is harmless but unnecessary.
</Tip>

***

## Using Bootstrap classes

All editor components support an **Advanced** group with a `className` (or `classNames`) field. You can enter any valid [Bootstrap 5](https://getbootstrap.com/docs/5.3/utilities/api/) utility class here to fine-tune spacing, colours, borders, visibility and more.

### Common examples

| Class               | Effect                                           |
| ------------------- | ------------------------------------------------ |
| `mt-3`              | Top margin of 1 rem                              |
| `mb-5`              | Bottom margin of 3 rem                           |
| `p-4`               | Padding of 1.5 rem on all sides                  |
| `text-center`       | Centre-align text                                |
| `text-white`        | White text colour                                |
| `bg-primary`        | Primary background colour                        |
| `bg-light`          | Light grey background                            |
| `rounded-3`         | Medium border radius                             |
| `shadow-sm`         | Small drop shadow                                |
| `d-none d-md-block` | Hidden on mobile, visible from medium breakpoint |
| `w-100`             | Full width                                       |
| `mx-auto`           | Centre horizontally                              |

### Spacing scale

Bootstrap spacing utilities follow the pattern `{property}{side}-{size}`:

* **Property:** `m` (margin) or `p` (padding)
* **Side:** `t` (top), `b` (bottom), `s` (start/left), `e` (end/right), `x` (horizontal), `y` (vertical), or blank (all)
* **Size:** `0` through `5`, or `auto`

For example, `px-3 py-5` gives horizontal padding of 1 rem and vertical padding of 3 rem.

### Responsive prefixes

Add a breakpoint prefix to apply a class only from a certain screen width:

| Prefix | Breakpoint |
| ------ | ---------- |
| (none) | All sizes  |
| `sm-`  | ≥ 576 px   |
| `md-`  | ≥ 768 px   |
| `lg-`  | ≥ 992 px   |
| `xl-`  | ≥ 1200 px  |

Example: `d-none d-lg-block` hides content on small screens and shows it on large screens.

<Tip>
  The `className` field accepts multiple classes separated by spaces. Combine utilities freely — for example: `mt-4 mb-2 text-center bg-light
      rounded-3 shadow-sm`.
</Tip>


# Bootstrap CSS Classes
Source: https://learn.nexudus.com/editor/bootstrap-classes

How to use Bootstrap utility classes in the portal editor to customise spacing, colours, layout and responsiveness.

Every editor component exposes an **Advanced** section with a `className` (or `classNames`) field. This field accepts any valid [Bootstrap 5 utility class](https://getbootstrap.com/docs/5.3/utilities/api/), giving you fine-grained control over appearance without custom CSS.

## Spacing utilities

The most commonly used utilities control **margin** and **padding**.

### Syntax

```
{property}{side}-{breakpoint}-{size}
```

| Token        | Values                                 | Meaning                                                                    |
| ------------ | -------------------------------------- | -------------------------------------------------------------------------- |
| `property`   | `m` or `p`                             | Margin or padding                                                          |
| `side`       | `t`, `b`, `s`, `e`, `x`, `y`, or blank | Top, bottom, start (left), end (right), horizontal, vertical, or all sides |
| `breakpoint` | `sm`, `md`, `lg`, `xl`, `xxl`          | Optional — applies from this breakpoint up                                 |
| `size`       | `0`–`5`, `auto`                        | 0 = none, 1 = 0.25 rem, 2 = 0.5 rem, 3 = 1 rem, 4 = 1.5 rem, 5 = 3 rem     |

### Examples

| Class       | Effect                                        |
| ----------- | --------------------------------------------- |
| `mt-3`      | Top margin of 1 rem                           |
| `mb-5`      | Bottom margin of 3 rem                        |
| `p-4`       | 1.5 rem padding on all sides                  |
| `px-3 py-5` | 1 rem horizontal + 3 rem vertical padding     |
| `ms-auto`   | Push element to the right                     |
| `mx-auto`   | Centre horizontally                           |
| `pt-md-4`   | 1.5 rem top padding from medium breakpoint up |

## Text utilities

| Class                 | Effect                                    |
| --------------------- | ----------------------------------------- |
| `text-start`          | Left-align text                           |
| `text-center`         | Centre-align text                         |
| `text-end`            | Right-align text                          |
| `text-white`          | White text                                |
| `text-muted`          | Muted (grey) text                         |
| `text-primary`        | Primary colour text                       |
| `fw-bold`             | Bold font weight                          |
| `fs-1` through `fs-6` | Font sizes matching `<h1>` through `<h6>` |
| `text-uppercase`      | Uppercase text                            |
| `text-truncate`       | Ellipsis-truncate overflowing text        |

## Background colours

| Class            | Effect               |
| ---------------- | -------------------- |
| `bg-primary`     | Primary brand colour |
| `bg-secondary`   | Secondary colour     |
| `bg-success`     | Green success        |
| `bg-danger`      | Red danger           |
| `bg-warning`     | Yellow warning       |
| `bg-info`        | Cyan info            |
| `bg-light`       | Light grey           |
| `bg-dark`        | Dark/black           |
| `bg-white`       | White                |
| `bg-transparent` | Transparent          |

## Borders

| Class            | Effect                      |
| ---------------- | --------------------------- |
| `border`         | Default border on all sides |
| `border-0`       | Remove all borders          |
| `border-top`     | Border on top only          |
| `rounded`        | Rounded corners             |
| `rounded-3`      | Medium radius               |
| `rounded-circle` | Full circle crop            |
| `rounded-pill`   | Pill shape                  |
| `border-primary` | Primary colour border       |
| `border-2`       | 2 px border width           |

## Display and visibility

| Class               | Effect                                      |
| ------------------- | ------------------------------------------- |
| `d-none`            | Hide element                                |
| `d-block`           | Show as block                               |
| `d-flex`            | Flexbox container                           |
| `d-inline-flex`     | Inline flexbox                              |
| `d-none d-md-block` | Hidden below medium, visible from medium up |
| `d-md-none`         | Hidden from medium up                       |

### Responsive visibility pattern

Combine `d-none` with a breakpoint display class to show content only at certain screen sizes:

```
d-none d-lg-block     → visible only on large screens and up
d-block d-md-none     → visible only below medium
d-none d-sm-block d-xl-none → visible between small and large
```

## Flexbox utilities

| Class                     | Effect                            |
| ------------------------- | --------------------------------- |
| `d-flex`                  | Enable flexbox                    |
| `flex-row`                | Horizontal direction              |
| `flex-column`             | Vertical direction                |
| `justify-content-center`  | Centre items horizontally         |
| `justify-content-between` | Space items evenly                |
| `align-items-center`      | Centre items vertically           |
| `gap-2`                   | Gap of 0.5 rem between flex items |
| `gap-3`                   | Gap of 1 rem                      |
| `flex-wrap`               | Allow wrapping to next line       |

## Sizing

| Class                           | Effect                          |
| ------------------------------- | ------------------------------- |
| `w-25`, `w-50`, `w-75`, `w-100` | Width as percentage             |
| `h-100`                         | Full height                     |
| `mw-100`                        | Max width 100%                  |
| `min-vh-100`                    | Minimum height of full viewport |

## Shadows

| Class         | Effect        |
| ------------- | ------------- |
| `shadow-none` | No shadow     |
| `shadow-sm`   | Small shadow  |
| `shadow`      | Medium shadow |
| `shadow-lg`   | Large shadow  |

## Combining classes

The `className` field accepts multiple classes separated by spaces. Combine them freely:

```
mt-4 mb-2 text-center bg-light rounded-3 shadow-sm p-4
```

This gives a 1.5 rem top margin, 0.5 rem bottom margin, centred text, light background, rounded corners, a small shadow, and 1.5 rem padding.

<Tip>
  Responsive prefixes work on most utilities. For example, `text-center text-md-start` centres text on mobile but left-aligns it from medium
  breakpoint up.
</Tip>


# Editor Components
Source: https://learn.nexudus.com/editor/components

Reference for every visual component available in the portal editor — Cards, Alerts, Buttons, Images, Image Carousels, Headings and more.

When you select a component on the canvas, its configurable properties appear in the **Properties bar** on the right-hand side. Properties are organised into collapsible groups so you can find what you need quickly.

This page documents the general-purpose **editor components**. For layout primitives (Container, Grid, Stack, etc.) see [Layout Components](/editor/layout-components). For advanced embedding (Iframe, Script, CustomerType) see [Advanced Components](/editor/advanced-components).

***

## Card

A Bootstrap-based card with rich content options including images, lists and nested slot areas.

### Properties

<AccordionGroup>
  <Accordion title="Content">
    | Property        | Type     | Default                    | Description                                              |
    | --------------- | -------- | -------------------------- | -------------------------------------------------------- |
    | `header`        | text     | —                          | Optional card header text                                |
    | `title`         | text     | "Card Title"               | Main card title                                          |
    | `subtitle`      | text     | —                          | Subtitle below the title                                 |
    | `bodyText`      | textarea | "Some quick example text…" | Body paragraph                                           |
    | `footer`        | text     | —                          | Optional card footer text                                |
    | `bodySlotItems` | slot     | —                          | Drop zone for additional components inside the card body |
    | `extraSlot`     | slot     | —                          | Drop zone rendered after the body slot                   |
  </Accordion>

  <Accordion title="Appearance">
    | Property      | Type   | Default | Description                                                                                          |
    | ------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------- |
    | `bg`          | select | None    | Background colour: None, Primary, Secondary, Success, Danger, Warning, Info, Light, Dark, White      |
    | `textVariant` | select | Default | Text colour: Default, White, Dark, Body, Muted                                                       |
    | `border`      | select | None    | Border colour: None, Default, Primary, Secondary, Success, Danger, Warning, Info, Light, Dark, White |
    | `align`       | select | Default | Text alignment: Default, Start, Center, End                                                          |
  </Accordion>

  <Accordion title="Image">
    | Property        | Type     | Default | Description                           |
    | --------------- | -------- | ------- | ------------------------------------- |
    | `imageSrc`      | text     | —       | Image URL                             |
    | `imageAlt`      | text     | —       | Image alt text                        |
    | `imagePosition` | select   | None    | Placement: None, Top, Bottom, Overlay |
    | `overlayTitle`  | text     | —       | Title displayed on overlay images     |
    | `overlayText`   | textarea | —       | Text displayed on overlay images      |
  </Accordion>

  <Accordion title="List">
    | Property         | Type     | Default | Description                            |
    | ---------------- | -------- | ------- | -------------------------------------- |
    | `listGroupFlush` | select   | No      | Flush list (no outer borders): No, Yes |
    | `listItems`      | textarea | —       | One list item per line                 |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description                                            |
    | ----------- | ---- | ------- | ------------------------------------------------------ |
    | `className` | text | —       | Additional CSS classes (Bootstrap utilities supported) |
  </Accordion>
</AccordionGroup>

***

## Alert

A dismissible callout box for notices, warnings and informational messages.

### Properties

<AccordionGroup>
  <Accordion title="Content">
    | Property  | Type     | Default                | Description     |
    | --------- | -------- | ---------------------- | --------------- |
    | `heading` | text     | —                      | Alert heading   |
    | `text`    | textarea | "Sample alert message" | Alert body text |
  </Accordion>

  <Accordion title="Appearance">
    | Property  | Type   | Default | Description                                                                     |
    | --------- | ------ | ------- | ------------------------------------------------------------------------------- |
    | `variant` | select | primary | Colour variant: Primary, Secondary, Success, Danger, Warning, Info, Light, Dark |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

The Alert also has an `items` **slot** where you can drop additional components inside the alert body.

***

## Button

A styled button (or link) with full control over appearance, sizing and navigation.

### Properties

<AccordionGroup>
  <Accordion title="Content">
    | Property | Type | Default    | Description  |
    | -------- | ---- | ---------- | ------------ |
    | `text`   | text | "Click me" | Button label |
  </Accordion>

  <Accordion title="Appearance">
    | Property  | Type    | Default | Description                                                             |
    | --------- | ------- | ------- | ----------------------------------------------------------------------- |
    | `variant` | select  | primary | Colour: Primary, Secondary, Success, Danger, Warning, Info, Light, Dark |
    | `outline` | boolean | false   | Use outline (border-only) style                                         |
    | `size`    | select  | —       | Size modifier: default, Small (`btn-sm`), Large (`btn-lg`)              |
    | `block`   | boolean | false   | Full-width button                                                       |
  </Accordion>

  <Accordion title="Link">
    | Property | Type   | Default | Description                                                     |
    | -------- | ------ | ------- | --------------------------------------------------------------- |
    | `href`   | text   | —       | URL to navigate to. If set, the button renders as an `<a>` tag. |
    | `target` | select | —       | Open in: same tab (default), new tab (`_blank`)                 |
  </Accordion>

  <Accordion title="Spacing">
    | Property       | Type   | Default | Description                 |
    | -------------- | ------ | ------- | --------------------------- |
    | `marginTop`    | select | —       | Top margin utility class    |
    | `marginBottom` | select | —       | Bottom margin utility class |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

***

## Image

Displays an image with Bootstrap responsive utilities.

### Properties

<AccordionGroup>
  <Accordion title="Image">
    | Property | Type | Default         | Description                |
    | -------- | ---- | --------------- | -------------------------- |
    | `src`    | text | placeholder SVG | Image source URL           |
    | `alt`    | text | —               | Alt text for accessibility |
  </Accordion>

  <Accordion title="Display">
    | Property        | Type   | Default | Description                                   |
    | --------------- | ------ | ------- | --------------------------------------------- |
    | `fluid`         | select | Yes     | Responsive scaling (max-width: 100%): No, Yes |
    | `rounded`       | select | No      | Rounded corners: No, Yes                      |
    | `roundedCircle` | select | No      | Circular crop: No, Yes                        |
    | `thumbnail`     | select | No      | Thumbnail border: No, Yes                     |
  </Accordion>

  <Accordion title="Size">
    | Property | Type | Default | Description       |
    | -------- | ---- | ------- | ----------------- |
    | `width`  | text | —       | Width in px or %  |
    | `height` | text | —       | Height in px or % |
  </Accordion>

  <Accordion title="Loading">
    | Property  | Type   | Default | Description                         |
    | --------- | ------ | ------- | ----------------------------------- |
    | `loading` | select | Auto    | Loading strategy: Auto, Lazy, Eager |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

***

## Image Carousel

A responsive image gallery where each thumbnail opens a full-screen lightbox (powered by [GLightbox](https://biati-digital.github.io/glightbox/)). Visitors can navigate through all images inside the lightbox without leaving the page.

### Properties

<AccordionGroup>
  <Accordion title="Images">
    The **Images** field is a dynamic list. Use the **+ Add** button to add images and the drag handle to reorder them.

    | Property  | Type | Default | Description                                                                                                  |
    | --------- | ---- | ------- | ------------------------------------------------------------------------------------------------------------ |
    | `src`     | text | —       | Image URL. Use the **Manage image files ↗** link below the field to upload images via the Nexudus dashboard. |
    | `alt`     | text | —       | Alt text for accessibility and SEO                                                                           |
    | `caption` | text | —       | Optional caption shown below the thumbnail (when captions are enabled) and inside the lightbox               |
  </Accordion>

  <Accordion title="Display">
    | Property       | Type   | Default | Description                                        |
    | -------------- | ------ | ------- | -------------------------------------------------- |
    | `columns`      | select | 3       | Number of columns: 1, 2, 3, 4                      |
    | `imageHeight`  | text   | 200     | Thumbnail height in pixels                         |
    | `gap`          | select | Medium  | Gap between thumbnails: None, Small, Medium, Large |
    | `rounded`      | radio  | Yes     | Rounded corners on thumbnails: Yes, No             |
    | `showCaptions` | radio  | No      | Show caption text below each thumbnail: No, Yes    |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description                                              |
    | ----------- | ---- | ------- | -------------------------------------------------------- |
    | `className` | text | —       | Additional CSS classes applied to the outer grid wrapper |
  </Accordion>
</AccordionGroup>

<Tip>
  For a masonry-style layout, combine multiple **Image Carousel** components inside a [Responsive Grid](/editor/layout-components#responsive-grid) and set each carousel to 1 column with a different image height.
</Tip>

***

## Heading

A heading element (`<h1>` through `<h6>`) with optional display sizing.

### Properties

<AccordionGroup>
  <Accordion title="Content">
    | Property      | Type   | Default          | Description                                |
    | ------------- | ------ | ---------------- | ------------------------------------------ |
    | `text`        | text   | "Sample Heading" | Heading text                               |
    | `level`       | select | h2               | Semantic level: H1, H2, H3, H4, H5, H6     |
    | `align`       | select | Start            | Alignment: Start, Center, End              |
    | `displaySize` | select | None             | Bootstrap display class: None, Display 1–6 |
  </Accordion>

  <Accordion title="Spacing">
    Standard margin and padding utilities.
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

***

## Paragraph

A block of body text with alignment and emphasis options.

### Properties

<AccordionGroup>
  <Accordion title="Content">
    | Property | Type     | Default                 | Description       |
    | -------- | -------- | ----------------------- | ----------------- |
    | `text`   | textarea | "Sample paragraph text" | Paragraph content |
  </Accordion>

  <Accordion title="Appearance">
    | Property | Type   | Default | Description                                |
    | -------- | ------ | ------- | ------------------------------------------ |
    | `align`  | select | Default | Alignment: Default, Start, Center, End     |
    | `lead`   | select | Normal  | Lead paragraph (larger text): Normal, Lead |
    | `muted`  | select | Normal  | Muted colour: Normal, Muted                |
  </Accordion>

  <Accordion title="Spacing">
    Standard margin and padding utilities.
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

***

## Separator

A horizontal rule with configurable spacing.

### Properties

| Property     | Type   | Default | Description                         |
| ------------ | ------ | ------- | ----------------------------------- |
| `size`       | select | 4       | Vertical margin: None, 1–9, Auto    |
| `showBorder` | radio  | Yes     | Show a visible border line: No, Yes |
| `className`  | text   | —       | Additional CSS classes              |

***

## YouTube Video

Embeds a YouTube video with full control over playback and aspect ratio.

### Properties

<AccordionGroup>
  <Accordion title="Video">
    | Property      | Type   | Default | Description                                                                                         |
    | ------------- | ------ | ------- | --------------------------------------------------------------------------------------------------- |
    | `url`         | text   | —       | YouTube URL or Video ID (supports `youtu.be`, `youtube.com/watch?v=`, `youtube.com/embed/` formats) |
    | `aspectRatio` | select | 16x9    | Aspect ratio: 16x9, 4x3, 1x1, 9x16                                                                  |
    | `maxWidth`    | text   | 100%    | Maximum width (px or %)                                                                             |
    | `align`       | select | start   | Horizontal alignment: Start, Center, End                                                            |
  </Accordion>

  <Accordion title="Playback">
    | Property   | Type    | Default | Description                               |
    | ---------- | ------- | ------- | ----------------------------------------- |
    | `autoplay` | boolean | false   | Start playing automatically (forces mute) |
    | `mute`     | boolean | false   | Mute audio                                |
    | `controls` | boolean | true    | Show player controls                      |
    | `loop`     | boolean | false   | Loop video playback                       |
  </Accordion>

  <Accordion title="Accessibility">
    | Property | Type | Default | Description                     |
    | -------- | ---- | ------- | ------------------------------- |
    | `title`  | text | —       | Iframe title for screen readers |
  </Accordion>

  <Accordion title="Advanced">
    | Property    | Type | Default | Description            |
    | ----------- | ---- | ------- | ---------------------- |
    | `className` | text | —       | Additional CSS classes |
  </Accordion>
</AccordionGroup>

***

## Component properties bar

When you click on any component in the canvas, the **Properties bar** appears on the right side of the editor. It contains:

1. **Component name** — displayed at the top.
2. **Collapsible groups** — properties are organised into logical sections (Content, Appearance, Spacing, Advanced, etc.) that you can expand or collapse.
3. **Slot drop zones** — some components have `slot` fields that appear as labelled drop zones where you can drag additional child components.

Every component that supports custom CSS classes exposes an **Advanced** group with a `className` field. This is where you can add [Bootstrap utility classes](/editor/bootstrap-classes).


# Custom Code and Fonts
Source: https://learn.nexudus.com/editor/custom-web-injector

Inject custom CSS, JavaScript, and HTML head elements into every page of the Members Portal using the Web Template Editor.

## Overview

The Members Portal exposes three injection points that let operators add custom code without modifying the portal source:

| Injection point | File in Web Template Editor | What it does                                                                         |
| --------------- | --------------------------- | ------------------------------------------------------------------------------------ |
| Custom CSS      | `styles.css`                | Injected as a `<style>` tag on every page                                            |
| Custom JS       | `app.js`                    | Executed once when the portal first mounts                                           |
| Custom head     | `head.js`                   | JSON array of `<script>`, `<meta>`, `<link>`, and similar elements added to `<head>` |

All three files are edited from the **Web Template Editor** in your Nexudus dashboard at **[Settings > Website > Web Template Editor > Built-in Files](https://dashboard.nexudus.com/settings/editor/templates)**.

<Warning>
  If you are migrating from a previous version of the Members Portal, each file must be **saved at least once** in the Web Template Editor before the setting becomes active in the new portal.
</Warning>

## Editing the files

<Steps>
  <Step title="Open the Web Template Editor">
    Go to **[Settings > Website > Web Template Editor](https://dashboard.nexudus.com/settings/editor/templates)** and select the **Built-in Files** tab.
  </Step>

  <Step title="Select a file">
    Click `app.js`, `styles.css`, or `head.js` depending on which injection point you want to customise.
  </Step>

  <Step title="Edit and save">
    Make your changes in the code editor and click **Save**. Changes take effect immediately on the next portal page load — no rebuild required.
  </Step>
</Steps>

***

## styles.css — Custom CSS

Anything you write in `styles.css` is injected verbatim inside a `<style data-nx-custom="css">` tag appended to `<head>`. Use it to override default portal styles or add entirely new rules.

```css theme={null}
/* Hide the default footer */
footer {
  display: none;
}

/* Apply a custom font */
body {
  font-family: 'Inter', sans-serif;
}

```

<Tip>
  Use the browser DevTools inspector to find the exact class names and element selectors used in the portal before writing overrides.
</Tip>

### Targeting embedded (iframe) mode

When the portal is loaded inside an iframe (e.g. via [widget embedding](/operators/portal-configuration/widget-embedding)), the `<html>` element automatically receives the `in-iframe` class. Use it in `styles.css` to apply styles only when the portal is embedded:

```css theme={null}
/* Remove extra padding when embedded */
html.in-iframe .page-wrapper {
  padding-top: 0;
}

/* Hide elements that are redundant inside the host page */
html.in-iframe .back-to-top-btn {
  display: none;
}
```

The class is added synchronously before any content renders, so it is safe to use in all CSS selectors without risk of a flash of unstyled content.

### Targeting authentication and membership status

The portal automatically toggles classes on the `<html>` element based on the current user's authentication and membership state:

| Class            | Applied when                                          |
| ---------------- | ----------------------------------------------------- |
| `nxd-logged-in`  | The user is signed in.                                |
| `nxd-logged-out` | The user is not signed in.                            |
| `nxd-is-member`  | The signed-in user has an active membership contract. |
| `nxd-is-contact` | The signed-in user does not have an active contract.  |

These classes update reactively — when a user signs in or out, or their membership status changes, the classes are toggled immediately.

```css theme={null}
/* Show a "become a member" banner only to contacts */
html.nxd-is-contact .membership-cta {
  display: block;
}
html.nxd-is-member .membership-cta {
  display: none;
}

/* Hide navigation items from logged-out users */
html.nxd-logged-out .members-only-nav {
  display: none;
}
```

<Tip>
  You can combine these classes with `in-iframe` for more specific targeting, e.g. `html.in-iframe.nxd-logged-in`.
</Tip>

***

## app.js — Custom JavaScript

Code in `app.js` runs exactly once, after the portal mounts. It executes in the context of the portal page, so it has full access to the DOM and to the `window.__nexudus` object (see below).

```js theme={null}
// Redirect unauthenticated visitors to your marketing site
if (!window.__nexudus.auth.isAuthenticated) {
  window.__nexudus.router.navigate('/sign-in')
}

// Inject a third-party live chat widget only for authenticated members
if (window.__nexudus.auth.isAuthenticated) {
  const script = document.createElement('script')
  script.src = 'https://cdn.example.com/livechat.js'
  document.head.appendChild(script)
}

// Read a custom business setting
const primaryColor = window.__nexudus.settings.getSetting('Website.PrimaryColour')
console.log('Portal primary colour:', primaryColor)
```

<Warning>
  Custom JS runs once on mount. It does not re-run on client-side navigation between portal pages. If you need code to respond to navigation, use the `router.navigate` method or attach a `popstate` listener.
</Warning>

***

## head.js — Custom head elements

`head.js` must contain a **JSON array** of element descriptors. Each object must have a `type` field (case-insensitive) set to one of:

* `script`
* `meta`
* `link`
* `style`
* `noscript`

All other fields on the object are applied as HTML attributes on the element.

```json theme={null}
[
  {
    "type": "meta",
    "name": "theme-color",
    "content": "#ff5100"
  },
  {
    "type": "link",
    "rel": "preconnect",
    "href": "https://fonts.googleapis.com"
  },
  {
    "type": "script",
    "src": "https://cdn.example.com/analytics.js",
    "defer": "true"
  }
]
```

Elements are injected into `<head>` in the order they appear in the array. If the JSON is invalid or an element uses a disallowed `type`, that element is silently skipped.

***

## The `window.__nexudus` object

Before `app.js` executes, the portal populates `window.__nexudus` with live application state. The object is kept up to date on every render, so values read at any time reflect the current portal state.

```ts theme={null}
window.__nexudus: {
  settings: { ... }
  location: { ... }
  auth:     { ... }
  router:   { ... }
}
```

### `__nexudus.settings`

Provides access to the current location's configuration.

| Property / Method                     | Type                                                  | Description                                                                                                                                                                                                     |
| ------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `all`                                 | `Record<string, string>`                              | All business settings as a flat name → value map.                                                                                                                                                               |
| `getSetting(name)`                    | `(name: string) => string \| undefined`               | Look up a single setting by name (case-insensitive). Returns `undefined` if not found.                                                                                                                          |
| `getBoolSetting(name, defaultValue?)` | `(name: string, defaultValue?: string) => boolean`    | Returns `true` if the setting value is the string `"true"` (case-insensitive, whitespace trimmed). If the setting does not exist, `defaultValue` is used before comparison; returns `false` if both are absent. |
| `canAccessSection(accessSettingName)` | `(accessSettingName: string \| undefined) => boolean` | Returns `true` if the currently signed-in user meets the access level stored in the named setting. Pass `undefined` to always allow access. See access levels below.                                            |
| `business`                            | `Business`                                            | The current business / location object (see fields below).                                                                                                                                                      |
| `checkoutTypes`                       | `CheckoutTypes`                                       | Available resource, tariff, and product types for the current location (see below).                                                                                                                             |

#### `canAccessSection` access levels

The setting value is a numeric code that maps to one of these access levels:

| Value | Constant        | Who can access                                                                |
| ----- | --------------- | ----------------------------------------------------------------------------- |
| `1`   | `Everyone`      | Always returns `true`, including unauthenticated users.                       |
| `2`   | `LoggedInUsers` | Any signed-in user.                                                           |
| `3`   | `OnlyMembers`   | Signed-in customers with an active membership contract (`coworker.IsMember`). |
| `4`   | `OnlyContacts`  | Signed-in customers without an active contract (`coworker.IsContact`).        |

Returns `false` for any other value or when the user does not meet the required level.

```js theme={null}
// Show a section only to members
if (window.__nexudus.settings.canAccessSection('Website.ShowMembersOnlyBanner')) {
  document.getElementById('members-banner').style.display = 'block'
}

// Read a boolean feature flag
const chatEnabled = window.__nexudus.settings.getBoolSetting('Website.LiveChatEnabled')
if (chatEnabled) {
  loadLiveChatWidget()
}
```

#### `business` fields

| Field            | Type             | Description                                                      |
| ---------------- | ---------------- | ---------------------------------------------------------------- |
| `Id`             | `number`         | Unique identifier for the business.                              |
| `Name`           | `string`         | Business display name.                                           |
| `WebAddress`     | `string`         | Portal web address.                                              |
| `Address`        | `string`         | Physical address.                                                |
| `TownCity`       | `string`         | City name.                                                       |
| `Country`        | `Country`        | Country object (`Name`, `Id`, `UniqueId`).                       |
| `Currency`       | `Currency`       | Currency object (`Name`, `Code`, `Format`).                      |
| `SimpleTimeZone` | `SimpleTimeZone` | Time zone details (`Iana`, `OffsetInMinutes`, `UsesSummerTime`). |
| `Longitude`      | `number`         | Longitude coordinate.                                            |
| `Latitude`       | `number`         | Latitude coordinate.                                             |
| `HasLogo`        | `boolean`        | Whether a logo has been uploaded.                                |
| `UniqueId`       | `string`         | Globally unique identifier (GUID).                               |

#### `checkoutTypes` fields

| Field                   | Description                                                  |
| ----------------------- | ------------------------------------------------------------ |
| `ResourceTypes`         | All resource types active at this location.                  |
| `ResourceTypesMembers`  | Resource types available to members with an active contract. |
| `ResourceTypesContacts` | Resource types available to contacts (no active contract).   |
| `TariffTypes`           | Plan / membership types available at this location.          |
| `ProductTypes`          | All product types active at this location.                   |
| `ProductTypesMembers`   | Product types available to members.                          |
| `ProductTypesContacts`  | Product types available to contacts.                         |

***

### `__nexudus.location`

Provides access to the current location context, including the list of businesses and HTTP clients for making API calls.

| Property / Method | Type             | Description                                                                                                                                                 |
| ----------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `businesses`      | `AllLocations[]` | All businesses available at the current location. Each entry includes `Id`, `Name`, `WebAddress`, `Address`, `Latitude`, `Longitude`, `Currency`, and more. |
| `WebAddress`      | `string`         | The current location's web address identifier.                                                                                                              |
| `apiClient`       | `ApiClient`      | Authenticated HTTP client for making API requests on behalf of the signed-in user.                                                                          |
| `httpClient`      | `HttpClient`     | Unauthenticated HTTP client for making public API requests.                                                                                                 |

```js theme={null}
// List all location names
const locations = window.__nexudus.location.businesses.map(b => b.Name)
console.log('Available locations:', locations)

// Get the current location's web address
console.log('Current location:', window.__nexudus.location.WebAddress)

// Make an authenticated API call
const response = await window.__nexudus.location.apiClient.get('/en/bookings')
console.log('Bookings:', response)
```

***

### `__nexudus.auth`

Contains the current authentication state and the signed-in customer's data.

| Property          | Type                           | Description                                                                          |
| ----------------- | ------------------------------ | ------------------------------------------------------------------------------------ |
| `isAuthenticated` | `boolean`                      | `true` if the user is signed in.                                                     |
| `coworker`        | `Coworker \| null`             | Full profile of the signed-in customer, or `null` if unauthenticated.                |
| `user`            | `UserProfile \| null`          | System user record (email, full name, access token).                                 |
| `isAdmin`         | `boolean`                      | `true` if the signed-in user has administrator access.                               |
| `profiles`        | `CoworkerProfiles \| null`     | All profiles linked to this user account, including the default business.            |
| `impersonating`   | `boolean`                      | `true` when an admin is viewing the portal as another customer.                      |
| `defaultBusiness` | `ProfileBusiness \| undefined` | The default business associated with this user account (`Id`, `Name`, `WebAddress`). |

#### Commonly used `coworker` fields

| Field                 | Type                 | Description                                               |
| --------------------- | -------------------- | --------------------------------------------------------- |
| `FullName`            | `string`             | Customer's full name.                                     |
| `Email`               | `string`             | Customer's email address.                                 |
| `IsMember`            | `boolean`            | `true` if the customer has an active membership contract. |
| `IsContact`           | `boolean`            | `true` if the customer has no active contract.            |
| `IsAdmin`             | `boolean`            | `true` if the customer has admin-level access.            |
| `IsTeamAdministrator` | `boolean`            | `true` if the customer manages a team.                    |
| `AvatarUrl`           | `string`             | URL of the customer's profile picture.                    |
| `CompanyName`         | `string`             | Company name if the profile is a company type.            |
| `CoworkerType`        | `string`             | `'Individual'` or `'Company'`.                            |
| `CanMakeBookings`     | `boolean`            | Whether this customer is allowed to make bookings.        |
| `CanPurchaseProducts` | `boolean`            | Whether this customer is allowed to purchase products.    |
| `CheckedIn`           | `boolean`            | Whether the customer is currently checked in.             |
| `ActiveContracts`     | `CoworkerContract[]` | List of currently active membership contracts.            |
| `HomeSpaceName`       | `string`             | Name of the customer's home location.                     |

***

### `__nexudus.router`

Provides access to the portal's client-side router so custom code can read the current URL or navigate programmatically.

| Property   | Type               | Description                                                                            |
| ---------- | ------------------ | -------------------------------------------------------------------------------------- |
| `location` | `Location`         | Current React Router location. Includes `pathname`, `search`, `hash`, and `state`.     |
| `navigate` | `NavigateFunction` | Programmatic navigation function. Accepts a path string or a delta number for history. |

```js theme={null}
// Read the current path
console.log(window.__nexudus.router.location.pathname)

// Navigate to a different page
window.__nexudus.router.navigate('/bookings/meeting-rooms/list')

// Go back one step in browser history
window.__nexudus.router.navigate(-1)
```

***

## Examples

### Add Google Tag Manager

In `head.js`:

```json theme={null}
[
  {
    "type": "script",
    "src": "https://www.googletagmanager.com/gtm.js?id=GTM-XXXXXXX",
    "async": "true"
  }
]
```

### Show a banner only to customers without an active plan

In `app.js`:

```js theme={null}
const { isAuthenticated, coworker } = window.__nexudus.auth

if (isAuthenticated && coworker && !coworker.IsMember) {
  const banner = document.createElement('div')
  banner.style.cssText = 'background:#ff5100;color:#fff;text-align:center;padding:10px;'
  banner.textContent = 'You do not have an active plan. Browse our plans to get started.'
  document.body.prepend(banner)
}
```

### Redirect a specific setting-based feature flag

In `app.js`:

```js theme={null}
const featureEnabled = window.__nexudus.settings.getSetting('Website.EnableCustomFeature')

if (featureEnabled !== 'true') {
  window.__nexudus.router.navigate('/home')
}
```

### Run code on specific pages and react to navigation

The portal is a single-page application. `app.js` runs once on initial mount — it does not re-execute when members navigate between pages. To run code whenever the route changes, patch `history.pushState` and `history.replaceState` and listen for the `popstate` event (which fires on browser back/forward).

In `app.js`:

```js theme={null}
function onRouteChange(pathname) {
  // Runs on every client-side navigation and on initial load.

  if (pathname.includes('/meeting-rooms/')) {
    console.log('User is on a bookings page for meeting rooms')
  }
}

// Intercept pushState (links, router.navigate calls)
const _push = history.pushState.bind(history)
history.pushState = function (...args) {
  _push(...args)
  onRouteChange(window.location.pathname)
}

// Intercept replaceState (redirects, query-string updates)
const _replace = history.replaceState.bind(history)
history.replaceState = function (...args) {
  _replace(...args)
  onRouteChange(window.location.pathname)
}

// Handle browser back / forward
window.addEventListener('popstate', () => {
  onRouteChange(window.location.pathname)
})

// Run immediately for the page the user landed on
onRouteChange(window.location.pathname)
```

For query-string or hash information, read directly from `window.location` inside `onRouteChange` — `window.__nexudus.router.location` is a snapshot from portal mount and is not updated by client-side navigation.

```js theme={null}
function onRouteChange(pathname) {
  if (pathname.startsWith('/bookings') && window.location.search.includes('type=meeting-rooms')) {
    console.log('User is browsing meeting rooms')
  }
}
```

<Warning>
  Patching `history.pushState` affects the entire page. Keep the patched functions lightweight and always call the original (`_push` / `_replace`) before your own logic to avoid breaking portal navigation.
</Warning>

### React to changes in a `__nexudus` value

`window.__nexudus` is a snapshot from portal mount — its plain value properties (`auth.*`, `router.location`, etc.) are not automatically updated as the portal state changes. To react when a value changes, poll it with `setInterval` and compare against the previous reading.

The helper below wraps that pattern and returns a cancel function so you can stop watching when it is no longer needed.

In `app.js`:

```js theme={null}
// Watch a __nexudus property and call onChange whenever its value changes.
// Returns a cancel function.
function watchNexudus(getValue, onChange, intervalMs) {
  var prev = getValue()
  var id = setInterval(function () {
    var next = getValue()
    if (next !== prev) {
      onChange(next, prev)
      prev = next
    }
  }, intervalMs || 300)
  return function () { clearInterval(id) }
}

// React when the signed-in customer switches (e.g. an admin impersonates another profile)
var stopWatchingCustomer = watchNexudus(
  function () { return window.__nexudus.auth.coworker?.Email },
  function (newEmail, prevEmail) {
    console.log('Active customer changed from', prevEmail, 'to', newEmail)
    // update any third-party widgets that display the customer's identity
  }
)

// React when authentication state changes (e.g. token expires mid-session)
var stopWatchingAuth = watchNexudus(
  function () { return window.__nexudus.auth.isAuthenticated },
  function (isAuthenticated) {
    if (!isAuthenticated) {
      console.log('Session ended — redirecting to sign-in')
      window.__nexudus.router.navigate('/sign-in')
    }
  }
)

// Call the returned functions to stop polling when no longer needed.
// stopWatchingCustomer()
// stopWatchingAuth()
```

<Tip>
  `router.navigate` is a stable function and always works correctly regardless of when you call it. `auth.*` and `router.location` are snapshots, so use polling (above) or the `history.pushState` approach for navigation to observe their changes.
</Tip>

### Apply a CSS custom property from a business setting

In `app.js`:

```js theme={null}
const accent = window.__nexudus.settings.getSetting('PrimaryWebColor')
if (accent) {
  document.documentElement.style.setProperty('--nx-accent', accent)
}
```

In `styles.css`:

```css theme={null}
.button {
  background-color: var(--nx-accent, #ff5100);
}
```

### Load a custom Google Font

Use `head.js` to preconnect and load the font stylesheet, then apply it in `styles.css`.

In `head.js`:

```json theme={null}
[
  {
    "type": "link",
    "href": "https://fonts.googleapis.com",
    "rel": "preconnect"
  },
  {
    "type": "link",
    "href": "https://fonts.gstatic.com",
    "rel": "preconnect",
    "crossorigin": true
  },
  {
    "type": "link",
    "href": "https://fonts.googleapis.com/css2?family=Playwrite+NZ+Guides&display=swap",
    "rel": "stylesheet",
    "crossorigin": true
  }
]
```

In `styles.css`:

```css theme={null}
body * {
  font-family: "Playwrite NZ Guides", cursive;
  font-weight: 400;
  font-style: normal;
}
```

### Redirect users to their home location

In a multi-location network, you may want users who land on the top-level (parent) location to be automatically redirected to their home location — the location where they are invoiced. Add this script to the `app.js` of the **parent location only** (the one you want to redirect users away from).

The script:

1. Checks if the user is on the root page of the current location.
2. Verifies the user is authenticated.
3. Looks up the user's home location (based on their `InvoicingBusinessId`).
4. Navigates them to that location's portal page if it differs from the current one.

In `app.js`:

```js theme={null}
(function () {
  // Normalise a URL path by stripping trailing slashes.
  function normalisePath(path) {
    return (path || '/').replace(/\/+$/, '') || '/'
  }

  function redirectToHomeLocation() {
    // Only run when the user is on the site root for this location.
    // e.g. if the portal is at /my-space, only redirect when on /my-space exactly.
    if (normalisePath(window.location.pathname) !== '/' + __nexudus.settings.business.WebAddress) {
      return
    }

    var nx = window.__nexudus

    // Do nothing if the user is not signed in.
    if (!nx?.auth?.isAuthenticated) {
      return
    }

    // Find the business that matches the user's invoicing (home) location.
    var homeBusiness = nx.location.businesses.find(function (b) {
      return b.Id == nx.auth.coworker.InvoicingBusinessId
    })

    // If we can't determine their home location, stay on the current page.
    if (!homeBusiness?.WebAddress) {
      return
    }

    // Navigate the user to their home location's portal root.
    nx.router.navigate('/' + homeBusiness.WebAddress)
  }

  redirectToHomeLocation()
})()
```

<Tip>
  Only add this script to the parent location's `app.js`. If you add it to every location, users will be redirected in a loop. The script is safe for users whose home location matches the current one — in that case it simply does nothing.
</Tip>


# Layout Components
Source: https://learn.nexudus.com/editor/layout-components

Containers, grids, stacks, divs and responsive layout primitives available in the portal editor.

Layout components are structural building blocks that control how other components are arranged on the page. They do not display content themselves — instead they provide containers, rows, columns and spacing that you fill with other components.

All layout components are found in the **Layout** category of the Blocks panel.

***

## Container

A centred, max-width wrapper that groups child components. This is the most common structural element.

### Properties

<AccordionGroup>
  <Accordion title="Spacing and Margins">
    | Property        | Type   | Description                |
    | --------------- | ------ | -------------------------- |
    | `marginTop`     | select | Top margin utility         |
    | `marginBottom`  | select | Bottom margin utility      |
    | `paddingTop`    | select | Top padding utility        |
    | `paddingBottom` | select | Bottom padding utility     |
    | `paddingStart`  | select | Left/start padding utility |
    | `paddingEnd`    | select | Right/end padding utility  |
  </Accordion>

  <Accordion title="Advanced">
    | Property     | Type | Description            |
    | ------------ | ---- | ---------------------- |
    | `classNames` | text | Additional CSS classes |
  </Accordion>
</AccordionGroup>

**Slot:** `items` — drop child components here. In the editor, the slot has a minimum height of 4 rem and `display: block` for easy targeting. At runtime, it uses `display: contents` to avoid extra wrapper elements.

***

## Responsive Grid

A Bootstrap row/column grid where every column shares the same responsive width. Use this when all columns should be the same size.

### Properties

<AccordionGroup>
  <Accordion title="Columns">
    Each breakpoint controls how many equal-width columns appear:

    | Property    | Breakpoint              | Range |
    | ----------- | ----------------------- | ----- |
    | `xsColumns` | Extra Small (\< 576 px) | 1–12  |
    | `smColumns` | Small (≥ 576 px)        | 1–12  |
    | `mdColumns` | Medium (≥ 768 px)       | 1–12  |
    | `lgColumns` | Large (≥ 992 px)        | 1–12  |
    | `xlColumns` | Extra Large (≥ 1200 px) | 1–12  |

    For example, setting `lgColumns` to 3 and `smColumns` to 1 gives you a three-column layout on desktops that stacks to a single column on small screens.
  </Accordion>

  <Accordion title="Layout">
    | Property | Type  | Description                                  |
    | -------- | ----- | -------------------------------------------- |
    | `fluid`  | radio | Full-width container (no max-width): No, Yes |
  </Accordion>

  <Accordion title="Spacing and Margins">
    Standard margin and padding utilities.
  </Accordion>

  <Accordion title="Advanced">
    | Property     | Type | Description            |
    | ------------ | ---- | ---------------------- |
    | `classNames` | text | Additional CSS classes |
  </Accordion>
</AccordionGroup>

**Slot:** `items` — an array of columns, each with its own content slot. You must have at least 1 column. Add columns by clicking the **+** button in the items array.

### Default

4 columns with empty content.

***

## Custom Grid

A Bootstrap row/column grid where each column has **individual size controls** per breakpoint. Use this when columns need different widths (e.g. an 8/4 sidebar layout).

### Properties

<AccordionGroup>
  <Accordion title="Column sizes (per item)">
    Each column in the `items` array has its own size settings:

    | Property | Breakpoint              | Options    |
    | -------- | ----------------------- | ---------- |
    | `xs`     | Extra Small (\< 576 px) | Auto, 1–12 |
    | `sm`     | Small (≥ 576 px)        | Auto, 1–12 |
    | `md`     | Medium (≥ 768 px)       | Auto, 1–12 |
    | `lg`     | Large (≥ 992 px)        | Auto, 1–12 |
    | `xl`     | Extra Large (≥ 1200 px) | Auto, 1–12 |

    Setting a column to **Auto** (0) makes it auto-sized.
  </Accordion>

  <Accordion title="Layout">
    | Property | Type   | Description                                         |
    | -------- | ------ | --------------------------------------------------- |
    | `fluid`  | radio  | Full-width container: No, Yes                       |
    | `gutter` | select | Gap between columns: Default, None, g-1 through g-5 |
  </Accordion>

  <Accordion title="Spacing and Margins">
    Standard margin and padding utilities.
  </Accordion>

  <Accordion title="Advanced">
    | Property     | Type | Description            |
    | ------------ | ---- | ---------------------- |
    | `classNames` | text | Additional CSS classes |
  </Accordion>
</AccordionGroup>

**Slot:** `items` — an array of columns. Each column has a `content` slot and its own `sizes` group.

### Default

Two columns: first at 8 cols (lg/xl), second at 4 cols (lg/xl) — a classic content-plus-sidebar layout.

***

## Stack

Arranges child components in a vertical or horizontal stack with configurable gap.

### Properties

| Property    | Type   | Default  | Description                             |
| ----------- | ------ | -------- | --------------------------------------- |
| `gap`       | select | gap-4    | Space between items: Default, None, 1–9 |
| `direction` | select | Vertical | Stack direction: Vertical, Horizontal   |

**Spacing and Margins:** standard margin and padding utilities.

**Slot:** `items` — drop components to stack them.

***

## Div

A plain `<div>` wrapper with text alignment and spacing. Use it to group components or apply utility classes.

### Properties

| Property    | Type   | Default | Description                                 |
| ----------- | ------ | ------- | ------------------------------------------- |
| `textAlign` | select | Default | Text alignment: Default, Start, Center, End |

**Spacing and Margins:** standard margin and padding utilities.

**Advanced:** `classNames` — additional CSS classes.

**Slot:** `items` — drop child components here.

***

## Separator

A horizontal rule used to visually divide sections.

| Property     | Type   | Default | Description                             |
| ------------ | ------ | ------- | --------------------------------------- |
| `size`       | select | 4       | Vertical margin: None, 1–9, Auto        |
| `showBorder` | radio  | Yes     | Show a visible horizontal line: No, Yes |
| `className`  | text   | —       | Additional CSS classes                  |

***

## Layout tips

* **Nest layouts freely** — you can place a Responsive Grid inside a Container, or a Stack inside a Custom Grid column.
* **Use Container for max-width** — wrap content in a Container to keep it centred and bounded.
* **Use Stack for quick lists** — the vertical stack with a gap is often the fastest way to arrange components.
* **Use Custom Grid for unequal columns** — when one column needs to be wider (e.g. 8/4 for sidebar), Custom Grid gives you per-column control.
* **Use Responsive Grid for equal columns** — when all columns should be the same width, Responsive Grid is simpler to configure.


# Left Menu & Pages
Source: https://learn.nexudus.com/editor/left-menu

Navigate built-in pages, custom pages, page templates and the navigation editor from the editor sidebar.

The left sidebar of the editor is your main navigation hub. It lets you open any page for editing, create new custom pages and jump to the Navigation editor.

## Menu structure

The sidebar is split into two sections:

1. **Scrollable page list** — all built-in and custom pages, grouped by category.
2. **Pinned bottom actions** — the **New Page** button and the **Navigation** link.

```
📋 Editor
├── 📁 Home Page
│   └── 🔗 Home
├── 📁 Dashboard
│   └── 🔗 Personal Dashboard
├── 📁 Bookings
│   ├── 🔗 Resource List
│   ├── 🔗 Resource Calendar
│   ├── 🔗 Building Availability
│   └── 🔗 Booking Edit
├── 📁 Events
│   ├── 🔗 Events
│   ├── 🔗 Event Checkout
│   └── 🔗 Event Details
├── ...more categories...
├── 📄 My Custom Page 1
├── 📄 My Custom Page 2
─────────────────────────
  + New Page
  🔗 Navigation
```

### Built-in pages

Built-in pages are the standard portal pages that ship with every Nexudus location. They are organised into categories such as **Home Page**, **Dashboard**, **Bookings**, **Events**, **Courses**, **Articles**, **Store**, **Team**, **My Activity**, **Community**, **FAQ**, **Contact** and **Personal**.

Each category groups related pages together. If a category contains only one page, it is promoted directly to the top level to avoid a single-item expandable section.

Click any page name to open it in the editor canvas. The currently active page is highlighted.

### Custom pages

Custom pages you have created appear below the built-in categories as flat items with a document icon. Click one to open it for editing.

### New Page button

Clicking **New Page** opens a template picker modal with eight pre-made starting layouts:

| Template               | Description                                                               |
| ---------------------- | ------------------------------------------------------------------------- |
| **Blank**              | Empty page with only a navigation bar                                     |
| **Single Column**      | NavBar, a heading and a paragraph in a container                          |
| **Two Columns**        | NavBar with a two-column responsive grid                                  |
| **Hero + Content**     | Full-width hero image followed by a content container                     |
| **Hero + Two Columns** | Hero image with a two-column grid below                                   |
| **Sidebar Layout**     | Main content area (8 columns) with a narrow sidebar (4 columns)           |
| **Landing Page**       | Hero, introduction section, three-column feature grid, and call-to-action |
| **Feature Grid**       | 2×2 grid of pre-configured cards                                          |

Select a template to create a new custom page pre-filled with that layout. You can also choose **Blank** and build from scratch.

<Tip>
  After selecting a template, the editor opens a new unsaved custom page. The template is applied once and the URL parameter is consumed — refreshing
  the page will not re-apply the template.
</Tip>

### Navigation link

The **Navigation** link at the bottom of the menu takes you to the [Navigation editor](/editor/navigation), where you organise how pages appear in the portal's top menu.

## Blocks and Outline panels

Once a page is loaded in the editor, you interact with two built-in Puck panels on the left:

### Blocks panel (Component drawer)

The **Blocks** panel lists every available component you can add to the page, grouped into categories:

| Category        | Examples                                                                                                        |
| --------------- | --------------------------------------------------------------------------------------------------------------- |
| **Layout**      | Container, Stack, Div, Responsive Grid, Custom Grid, Separator, CustomerType                                    |
| **Text**        | Heading, Paragraph                                                                                              |
| **Components**  | Card, Alert, Button, Image, YouTube Video                                                                       |
| **Home Page**   | HomePage, HomePageHero, NavBar                                                                                  |
| **Dashboard**   | DashboardHero, QuickActions, AnnouncementsBanner, PersonalDashboardHeader, StatisticsSection                    |
| **Bookings**    | ResourceList, ResourceCalendar, BookingEdit, PredictiveBookings                                                 |
| **Events**      | EventPageRouter, FeaturedEventsList, UpcomingEvents                                                             |
| **Courses**     | CoursePageRouter, FeaturedCourseList, CoursesList                                                               |
| **Articles**    | BlogPageRouter, FeaturedBlogList, RecentBlogPosts                                                               |
| **Store**       | SimpleProductGrid, SimplePlansGrid                                                                              |
| **Team**        | TeamMembersSection, TeamBookingsSection, TeamAttendanceSection, TeamPermissionsSection                          |
| **My Activity** | MyBookingsSection, MyInvoicesSection, MyVisitorsSection, MyDeliveriesSection, MyEventsSection, MyCoursesSection |
| **Community**   | CommunityBoardListSection, DirectorySection, PerksSection                                                       |
| **FAQ**         | FaqPageSection, HelpDeskSection                                                                                 |
| **Contact**     | ContactUsPage                                                                                                   |

**To add a component**, drag it from the Blocks panel and drop it onto the canvas in the desired position.

### AI Page Generation

At the top of the Blocks panel you will find a text area where you can describe the page you want to create in natural language (e.g. *"Create a landing page with a hero image, three feature cards, and a call-to-action button"*). Press **Enter** or click **Generate** to have the AI assistant produce a starting layout using available components. You can then refine the result manually.

* Press **Enter** to submit (use **Shift + Enter** for a new line).
* The AI takes the current page layout as context, so you can iteratively refine.

### Outline panel

The **Outline** panel shows the component tree of the current page in a hierarchical list. It is useful for:

* Seeing the nesting structure at a glance.
* Selecting deeply nested components that are hard to click on the canvas.
* Understanding the order of components from top to bottom.

Click any item in the Outline to select it on the canvas and show its properties in the right-hand panel.


# Navigation Editor
Source: https://learn.nexudus.com/editor/navigation

Organise your portal menu with fixed categories, custom groups and drag-and-drop ordering.

The Navigation editor controls how pages appear in the portal's top navigation menu. You can add both built-in and custom pages, group them into categories, and reorder them with drag-and-drop.

Access it from the **Navigation** link at the bottom of the editor's left menu.

## Navigation structure

The portal navigation is made up of two kinds of elements:

1. **Fixed categories** — four locked root-level categories that are always present.
2. **Custom groups** — root-level groups that you create and manage yourself.

### Fixed categories

Every portal ships with four permanent categories:

| Category        | Purpose                                                               |
| --------------- | --------------------------------------------------------------------- |
| **Bookings**    | Resource management — booking pages, resource list, resource calendar |
| **Store**       | Products and checkout pages                                           |
| **Memberships** | Plans and subscriptions                                               |
| **Community**   | Events, perks, community board, directory                             |

Fixed categories are marked with a **\[fixed]** badge and a lock icon. You cannot remove, rename or reorder them, but you **can** add items inside them.

### Custom groups

Custom groups are root-level categories that you create. They work exactly like fixed categories in that they hold navigation items, but you can:

* **Rename** them by editing the group label.
* **Reorder** them relative to other custom groups.
* **Delete** them (and their child items).

<Warning>Groups cannot be nested inside other groups. They must remain at the root level.</Warning>

## Navigation items

Each item in a category or group is one of two types:

| Type         | Description                                                                                                          |
| ------------ | -------------------------------------------------------------------------------------------------------------------- |
| **Built-in** | A reference to a standard portal page (e.g. Resource List, Events, Personal Dashboard). Uses the page's OutlineName. |
| **Custom**   | A reference to a published custom page you created in the editor. Identified by its page ID.                         |

## Editor layout

The Navigation editor is split into two panels:

### Left panel — Page picker

The left panel lets you browse and add pages to the navigation:

* **Built-in pages** tab — lists all available built-in pages alphabetically.
* **Custom pages** tab — lists your published custom pages (each shows a permalink badge).
* **"Add into" dropdown** — choose the target: a fixed category, a custom group, or the root level. Selecting a page adds it to the chosen target.

### Right panel — Navigation tree

The right panel shows the current navigation structure:

* **Fixed categories** — displayed at the top with their child items. The category header shows a lock icon and a \[fixed] badge.
* **Custom groups** — displayed below fixed categories. Each group header has an editable label and a delete button.
* All items within categories and groups are **drag-and-drop reorderable**.

## Drag-and-drop rules

| Action                                          | Allowed? |
| ----------------------------------------------- | -------- |
| Reorder items within the same category/group    | Yes      |
| Move an item from one category/group to another | Yes      |
| Reorder custom groups relative to each other    | Yes      |
| Drag a group into a fixed category              | No       |
| Nest a group inside another group               | No       |
| Remove or reorder fixed categories              | No       |

## Adding pages to the navigation

### Add a built-in page

1. In the left panel, select the **Built-in pages** tab.
2. Use the **"Add into"** dropdown to pick the target category or group.
3. Click on the page you want to add.
4. The page appears as a new item inside the chosen target.

### Add a custom page

1. Switch to the **Custom pages** tab.
2. Use the **"Add into"** dropdown to pick the target.
3. Click a published custom page.
4. It appears inside the chosen target.

<Note>
  Only **published** custom pages appear in the Custom pages tab. If you don't see a page, make sure it has been saved with a Published status in the
  editor.
</Note>

### Create a new custom group

To create a new top-level navigation group:

1. Click **Add group** (at the bottom or in the toolbar area of the right panel).
2. Give it a label.
3. Add pages into it from the left panel.

## Saving

Click **Save** in the toolbar to persist your navigation changes. The updated navigation takes effect across the portal immediately.


# Portal Editor Overview
Source: https://learn.nexudus.com/editor/overview

A visual drag-and-drop page editor for customising every page viewers and members see in your Nexudus Members Portal.

<Warning>
  The Portal Editor is currently in **preview**. If you'd like to try it out, please [reach out to us](mailto:support@nexudus.com) to join the early access program.
</Warning>

<Note>
  **Browser Compatibility:** The Portal Editor does not currently work in Firefox. Please use Chrome, Edge, Safari, or another Chromium-based browser.
</Note>

The Members Portal Editor is a visual, drag-and-drop page builder that lets coworking-space operators customise every page of their portal — from the public landing page to the member dashboard — without writing any code.

<Frame>
  <img alt="Booking checkout page" />
</Frame>

## What you can do

| Capability                   | Description                                                                                                         |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Edit built-in pages**      | Modify the layout and content of every standard portal page (Home, Dashboard, Articles, Events, etc.)               |
| **Create custom pages**      | Build entirely new pages from scratch or from pre-made templates                                                    |
| **Drag-and-drop components** | Add headings, cards, alerts, grids, images, iframes, scripts and many more — all with configurable properties       |
| **Responsive design**        | Preview your designs at Desktop (1400 px), Tablet (768 px) and Mobile (375 px) breakpoints                          |
| **Audience targeting**       | Show or hide sections for everyone, logged-in users, members only or contacts only using the CustomerType component |
| **Live preview**             | Open a full preview of your changes in a new browser tab before saving                                              |
| **AI page generation**       | Describe a page in natural language and let the AI assistant generate a starting layout for you                     |
| **Custom navigation**        | Organise built-in and custom pages into fixed categories and custom groups in the portal navigation                 |

## Editor anatomy

The editor interface is divided into four main areas:

1. **Left sidebar** — browse and open built-in pages, custom pages, create new pages from templates, and open the Navigation editor.
2. **Component drawer & Outline** — built-in Puck panels for inserting new components (drag from the drawer) and inspecting the component tree (Outline).
3. **Canvas** — the live preview area where you drag, drop and rearrange components. Supports Desktop, Tablet and Mobile viewports.
4. **Properties bar** — when you select a component on the canvas, its configurable properties appear on the right-hand side, organised in collapsible groups.
5. **Toolbar** — the top bar with Save, Reset, Delete, Preview buttons and an unsaved-draft indicator.

## How to access the editor

Navigate to **your portal URL** and append `/admin/editor` — for example `https://yourspace.nexudus.site/admin/editor`. You must be signed in as a space operator.

## Next steps

<CardGroup>
  <Card title="Left Menu & Pages" icon="sidebar" href="/editor/left-menu">
    Browse built-in pages, custom pages, templates and the navigation editor.
  </Card>

  <Card title="Navigation Editor" icon="bars" href="/editor/navigation">
    Configure fixed categories and custom groups to organise your portal menu.
  </Card>

  <Card title="Components & Properties" icon="cube" href="/editor/components">
    Learn about every available component and its configurable properties.
  </Card>

  <Card title="Toolbar & Workflow" icon="floppy-disk" href="/editor/toolbar">
    Draft management, saving, resetting, deleting, and previewing pages.
  </Card>

  <Card title="Layout Components" icon="table-columns" href="/editor/layout-components">
    Containers, grids, stacks, divs and responsive layout primitives.
  </Card>

  <Card title="Advanced: Iframes, Scripts & CustomerType" icon="code" href="/editor/advanced-components">
    Embed external content, load third-party scripts, and target content by audience.
  </Card>
</CardGroup>


# Page Section Components
Source: https://learn.nexudus.com/editor/page-sections

Data-aware page sections available in the editor — from Dashboard and Bookings to Events, Courses and Team management.

Page section components are the building blocks of each portal page. Unlike generic layout components (Container, Grid, etc.), these are **data-aware** — they fetch live data from your Nexudus location and render fully functional portal sections.

They are registered in the editor via `useEditorConfiguration` and organised by category. When used in the editor, they render with **mock data** so you can preview the layout without needing a live API connection.

***

## Categories and components

### Home Page

| Component        | Description                                                                                                                                                             |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **HomePage**     | The complete home page with toggleable hero, plans, events and locations sections. Configure which sections to show, heading sizes, and custom class names per section. |
| **HomePageHero** | The hero area with main text, sub-text and search box. Can be used standalone or as part of HomePage.                                                                   |
| **NavBar**       | The portal navigation bar. Supports fixed/floating header and transparent/solid styles.                                                                                 |

#### HomePage Parameters

| Parameter                       | Description                                                                                                 |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                                                           |
| Redirect URL                    | Custom redirect URL for the home page.                                                                      |
| **Navigation Bar**              |                                                                                                             |
| Show navigation bar             | Display the navigation bar at the top of the page.                                                          |
| Fixed header                    | Keep the navigation bar fixed at the top when scrolling.                                                    |
| Header type                     | Choose between Floating (transparent over hero) or Solid (solid background).                                |
| **Hero**                        |                                                                                                             |
| Show hero section               | Display the main hero area with title, search box and call-to-action text.                                  |
| Background style                | How to display the hero background — Primary colour, Bootstrap colour, Image from URL, or Custom image URL. |
| Bootstrap colour                | Select a Bootstrap colour for a solid colour background (if using Bootstrap colour style).                  |
| Background image URL            | URL of an image to use as the hero background (if using image style).                                       |
| Show main text                  | Display the large primary heading text.                                                                     |
| Show sub text                   | Display the secondary/subtitle text below the main heading.                                                 |
| Show search box                 | Display the location/plan search input field.                                                               |
| Location name                   | Override the automatically detected location name in the hero text.                                         |
| Typewriter text 1               | First line of typewriter text in the hero (e.g., "Get work done in").                                       |
| Typewriter text 2               | Second line of typewriter text (e.g., "Coworking spaces in").                                               |
| Typewriter text 3               | Third line of typewriter text (e.g., "Find meeting space in").                                              |
| Additional CSS classes          | Custom CSS classes to apply to the hero section for styling.                                                |
| **Plans**                       |                                                                                                             |
| Show plans section              | Display the membership plans section.                                                                       |
| Show title                      | Show the section heading ("Membership Plans").                                                              |
| Title size                      | Choose Small or Large heading size.                                                                         |
| Only show time passes           | Filter to display only time pass products (exclude monthly plans).                                          |
| Additional CSS classes          | Custom CSS classes for the plans section styling.                                                           |
| **Events**                      |                                                                                                             |
| Show events section             | Display the upcoming events section.                                                                        |
| Show title                      | Show the section heading ("Upcoming Events").                                                               |
| Title size                      | Choose Small or Large heading size.                                                                         |
| Number of events to show        | How many upcoming events to display (1-9).                                                                  |
| Additional CSS classes          | Custom CSS classes for the events section styling.                                                          |
| **Locations**                   |                                                                                                             |
| Show locations section          | Display the locations grid section.                                                                         |
| Show title                      | Show the section heading ("Our Locations").                                                                 |
| Title size                      | Choose Small or Large heading size.                                                                         |
| Additional CSS classes          | Custom CSS classes for the locations section styling.                                                       |

#### HomePageHero Parameters

| Parameter              | Description                                                                                                 |
| ---------------------- | ----------------------------------------------------------------------------------------------------------- |
| **Background**         |                                                                                                             |
| Background style       | How to display the hero background — Primary colour, Bootstrap colour, Image from URL, or Custom image URL. |
| Bootstrap colour       | Select a Bootstrap colour for a solid colour background (if using Bootstrap colour style).                  |
| Background image URL   | URL of an image to use as the hero background (if using image style).                                       |
| **Content**            |                                                                                                             |
| Show main text         | Display the large primary heading text.                                                                     |
| Show sub text          | Display the secondary/subtitle text below the main heading.                                                 |
| Show search box        | Display the location/plan search input field.                                                               |
| Location name          | Override the automatically detected location name in the hero text.                                         |
| Typewriter text 1      | First line of typewriter text (e.g., "Get work done in").                                                   |
| Typewriter text 2      | Second line of typewriter text (e.g., "Coworking spaces in").                                               |
| Typewriter text 3      | Third line of typewriter text (e.g., "Find meeting space in").                                              |
| **Advanced**           |                                                                                                             |
| Additional CSS classes | Custom CSS classes to apply to the hero section for styling.                                                |

#### NavBar Parameters

| Parameter    | Description                                                                  |
| ------------ | ---------------------------------------------------------------------------- |
| Fixed header | Keep the navigation bar fixed at the top when scrolling.                     |
| Type         | Choose between Floating (transparent over hero) or Solid (solid background). |

### Dashboard

| Component                     | Description                                                            |
| ----------------------------- | ---------------------------------------------------------------------- |
| **PersonalDashboard**         | Complete member dashboard container.                                   |
| **PersonalDashboardHeader**   | Dashboard welcome header area.                                         |
| **DashboardHero**             | Hero area for the dashboard page.                                      |
| **QuickActions**              | Grid of quick-action buttons (book, pay, etc.).                        |
| **AnnouncementsBanner**       | Displays active announcements from the dashboard.                      |
| **OnBoardingSection**         | Step-by-step onboarding guide for new members.                         |
| **StatisticsSection**         | Member usage statistics display.                                       |
| **WeeklyAgendaCalendar**      | Weekly calendar view of the member's upcoming bookings.                |
| **MyBenefits**                | Summary card showing booking credits, extra services, and time passes. |
| **DashboardFeaturedArticles** | Highlighted articles on the dashboard.                                 |
| **DashboardFeaturedEvents**   | Highlighted upcoming events on the dashboard.                          |

#### PersonalDashboard Parameters

| Parameter                       | Description                                                                                                 |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                                                           |
| **Hero**                        |                                                                                                             |
| Background style                | How to display the hero background — Primary colour, Bootstrap colour, Image from URL, or Custom image URL. |
| Bootstrap colour                | Select a Bootstrap colour for a solid colour background (if using Bootstrap colour style).                  |
| Background image URL            | URL of an image to use as the hero background (if using image style).                                       |
| **Quick Actions**               |                                                                                                             |
| Show title                      | Display the section heading ("Quick Actions").                                                              |
| Show "Book a room"              | Show button to book a meeting room.                                                                         |
| Show "Book a desk"              | Show button to book a desk space.                                                                           |
| Show "Buy a day pass"           | Show button to purchase a day pass.                                                                         |
| Show "Register a visitor"       | Show button to register an upcoming visitor.                                                                |
| Show "View invoices"            | Show link to view billing history and download invoices.                                                    |
| Show "View membership details"  | Show link to view current plan and benefits.                                                                |
| Show "Contact support"          | Show quick contact form for getting help.                                                                   |
| Show "View FAQ articles"        | Show link to browse common help articles.                                                                   |
| **Visibility**                  |                                                                                                             |
| Show announcements              | Display the announcements banner showing site updates or policies.                                          |
| Show onboarding                 | Show the step-by-step welcome guide for new members.                                                        |
| Show my benefits                | Display a summary card of available booking credits, extra services, and time passes.                       |
| Show weekly calendar            | Display a mini-calendar of upcoming bookings.                                                               |
| Show upcoming bookings          | Show list of confirmed future bookings.                                                                     |
| Show suggested bookings         | Show AI-suggested bookings based on regular patterns.                                                       |
| Show referral banner            | Display the friend referral promotion area.                                                                 |
| Show featured articles          | Highlight relevant help articles on the dashboard.                                                          |
| Show featured events            | Showcase upcoming events that may be of interest.                                                           |

#### DashboardHero Parameters

| Parameter                      | Description                                                                                                 |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| Slot for announcements content | Container slot for dynamic announcement components.                                                         |
| Background style               | How to display the hero background — Primary colour, Bootstrap colour, Image from URL, or Custom image URL. |
| Bootstrap colour               | Select a Bootstrap colour for a solid colour background (if using Bootstrap colour style).                  |
| Background image URL           | URL of an image to use as the hero background (if using image style).                                       |

#### QuickActions Parameters

| Parameter                      | Description                                              |
| ------------------------------ | -------------------------------------------------------- |
| Show title                     | Display the section heading ("Quick Actions").           |
| Show "Book a room"             | Show button to book a meeting room.                      |
| Show "Book a desk"             | Show button to book a desk space.                        |
| Show "Buy a day pass"          | Show button to purchase a day pass.                      |
| Show "Register a visitor"      | Show button to register an upcoming visitor.             |
| Show "View invoices"           | Show link to view billing history and download invoices. |
| Show "View membership details" | Show link to view current plan and benefits.             |
| Show "Contact support"         | Show quick contact form for getting help.                |
| Show "View FAQ articles"       | Show link to browse common help articles.                |

#### AnnouncementsBanner Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

#### OnBoardingSection Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

#### StatisticsSection Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

#### MyBenefits Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |
| Show title                      | Display the section heading ("My Benefits").      |

#### WeeklyAgendaCalendar Parameters

| Parameter                                        | Description |
| ------------------------------------------------ | ----------- |
| No parameters available — uses default settings. |             |

#### DashboardFeaturedArticles Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

#### DashboardFeaturedEvents Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

### Bookings

| Component                       | Description                                           |
| ------------------------------- | ----------------------------------------------------- |
| **ResourceList**                | Browsable list of bookable resources.                 |
| **ResourceCalendar**            | Calendar view for browsing and booking resources.     |
| **BookingEdit**                 | Booking creation and editing form.                    |
| **BuildingAvailabilitySection** | Real-time availability display for building/location. |
| **PredictiveBookings**          | AI-suggested bookings based on member usage patterns. |

#### ResourceList Parameters

| Parameter                       | Description                                                                          |
| ------------------------------- | ------------------------------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                                    |
| **Display options**             |                                                                                      |
| Show filters                    | Display filter controls for category, capacity and amenities.                        |
| Show grid                       | Show resources in a visual grid layout.                                              |
| Show sensor data                | Display real-time occupancy sensors (if enabled).                                    |
| Show price                      | Display the hourly/daily pricing for each resource.                                  |
| Show instant booking            | Enable direct booking without approval (instant confirmation).                       |
| Show status badge               | Display the availability status badge (Available/Unavailable) on each resource card. |
| **Views**                       |                                                                                      |
| Show calendar view              | Add month/day calendar toggle for date selection.                                    |
| Show floor plan view            | Display resources on an interactive floor plan map.                                  |
| Show map view                   | Show a simple map with resource locations marked.                                    |
| **Filters**                     |                                                                                      |
| Show category filter            | Allow filtering by resource type (e.g., Meeting Room, Desk).                         |
| Show capacity filter            | Filter resources by maximum person capacity.                                         |
| Show amenities filter           | Filter resources by available features (e.g., Whiteboard, TV).                       |

#### ResourceCalendar Parameters

| Parameter                       | Description                                                    |
| ------------------------------- | -------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.              |
| **Display options**             |                                                                |
| Show filters                    | Display filter controls for category, capacity and amenities.  |
| Show calendar                   | Show the main date/time selection calendar.                    |
| **Views**                       |                                                                |
| Show calendar view              | Add month/day calendar toggle for date selection.              |
| Show floor plan view            | Display resources on an interactive floor plan map.            |
| Show map view                   | Show a simple map with resource locations marked.              |
| **Filters**                     |                                                                |
| Show category filter            | Allow filtering by resource type (e.g., Meeting Room, Desk).   |
| Show capacity filter            | Filter resources by maximum person capacity.                   |
| Show amenities filter           | Filter resources by available features (e.g., Whiteboard, TV). |

#### BookingEdit Parameters

| Parameter                | Description                                                      |
| ------------------------ | ---------------------------------------------------------------- |
| **Sections**             |                                                                  |
| Show resource image      | Display an image of the booked resource.                         |
| Show resource details    | Show name, capacity and location information for the resource.   |
| Show desk selection      | Allow selecting specific desks within a shared space option.     |
| Show visitor management  | Enable adding guest/visitor names and email addresses.           |
| Show additional products | Display optional add-ons (print credits, event tickets, etc.).   |
| Show custom fields       | Render any custom fields configured for bookings.                |
| Show booking notes       | Allow adding internal notes to the booking.                      |
| **Checkout Options**     |                                                                  |
| Show payment method      | Display available payment methods during checkout.               |
| Show basket summary      | Show a summary of the booking and total cost before confirming.  |
| **Layout Options**       |                                                                  |
| Show back button         | Display a button to return to previous step in the booking flow. |

#### BuildingAvailabilitySection Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

#### PredictiveBookings Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |

### Events

| Component              | Description                                        |
| ---------------------- | -------------------------------------------------- |
| **EventPageRouter**    | Event listing with routing for event detail views. |
| **FeaturedEventsList** | Curated list of featured events.                   |
| **UpcomingEvents**     | Chronological list of upcoming events.             |
| **EventDetailsPage**   | Full event detail page.                            |
| **EventCheckoutPage**  | Event purchase checkout flow.                      |
| **SimpleEventsGrid**   | Simple grid display of events.                     |

#### EventPageRouter Parameters

| Parameter                        | Description                                                |
| -------------------------------- | ---------------------------------------------------------- |
| Show mock data (in editor only)  | Show mock data instead of live data when editing.          |
| **Sections**                     |                                                            |
| Show featured events section     | Display the curated "Featured Events" section at the top.  |
| Show featured section title      | Show heading ("Featured Events") for the featured section. |
| Show upcoming events section     | Display the chronological list of all upcoming events.     |
| **Views**                        |                                                            |
| Show calendar views (Month, Day) | Enable month and day view toggles in the calendar.         |
| **Filters**                      |                                                            |
| Upcoming events to skip          | Number of recent events to hide (for pagination).          |
| Show filters                     | Display category and date range filter controls.           |

#### FeaturedEventsList Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |
| Show title                      | Display the section heading ("Featured Events").  |

#### UpcomingEvents Parameters

| Parameter                       | Description                                                   |
| ------------------------------- | ------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.             |
| **Title**                       |                                                               |
| Show title                      | Display the section heading ("Upcoming Events").              |
| Title size                      | Choose Small or Large heading size.                           |
| **Filters**                     |                                                               |
| Events to skip (0-10)           | Number of events to exclude from the top of the list.         |
| **Advanced**                    |                                                               |
| Additional CSS classes          | Custom CSS classes for styling the event cards and container. |

#### EventDetailsPage Parameters

| Parameter                       | Description                                                   |
| ------------------------------- | ------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.             |
| **Sections**                    |                                                               |
| Show title                      | Display the event name and date as a page header.             |
| Show comments section           | Allow customers to leave reviews and ratings after attending. |
| Show related events             | Recommend similar upcoming events at the bottom of the page.  |

#### EventCheckoutPage Parameters

| Parameter              | Description                                                                 |
| ---------------------- | --------------------------------------------------------------------------- |
| **Sections**           |                                                                             |
| Show event image       | Display the main promotional image for the event.                           |
| Show event description | Show the full event details (date, time, location, what's included).        |
| **Checkout Options**   |                                                                             |
| Show basket summary    | Display order summary with total price before payment.                      |
| **Layout Options**     |                                                                             |
| Show back button       | Allow customer to return to event details page without completing purchase. |

#### SimpleEventsGrid Parameters

| Parameter                       | Description                                                   |
| ------------------------------- | ------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.             |
| **Title**                       |                                                               |
| Show title                      | Display the section heading ("Upcoming Events").              |
| Title size                      | Choose Small or Large heading size.                           |
| **Filters**                     |                                                               |
| Number of events to show (1-9)  | How many upcoming events to display in the grid.              |
| **Advanced**                    |                                                               |
| Additional CSS classes          | Custom CSS classes for styling the event cards and container. |

### Courses

| Component              | Description                                   |
| ---------------------- | --------------------------------------------- |
| **CoursePageRouter**   | Course listing with routing for detail views. |
| **FeaturedCourseList** | Curated list of featured courses.             |
| **CoursesList**        | Complete list of available courses.           |
| **CourseDetailsPage**  | Full course detail page.                      |
| **CourseCheckoutPage** | Course purchase checkout flow.                |

#### CoursePageRouter Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| **Sections**                    |                                                              |
| Show featured courses section   | Display the curated "Featured Courses" section at the top.   |
| Show featured section title     | Show heading ("Featured Courses") for the featured section.  |
| Show courses list section       | Display the chronological list of all available courses.     |
| Show courses list title         | Show heading ("Available Courses") for the main course list. |
| Title size                      | Choose Small or Large heading size for the main course list. |
| **Filters**                     |                                                              |
| Courses to skip                 | Number of recent courses to hide (for pagination).           |
| Show filters                    | Display category filter controls.                            |

#### FeaturedCourseList Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |
| Show title                      | Display the section heading ("Featured Courses"). |

#### CoursesList Parameters

| Parameter                       | Description                                            |
| ------------------------------- | ------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.      |
| Show title                      | Display the section heading ("Available Courses").     |
| Title size                      | Choose Small or Large heading size.                    |
| Courses to skip                 | Number of courses to exclude from the top of the list. |

#### CourseDetailsPage Parameters

| Parameter                       | Description                                              |
| ------------------------------- | -------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.        |
| **Sections**                    |                                                          |
| Show title                      | Display the course name and instructor as a page header. |
| Show course lessons section     | List all course modules/lessons with duration estimates. |

#### CourseCheckoutPage Parameters

| Parameter               | Description                                                                  |
| ----------------------- | ---------------------------------------------------------------------------- |
| **Sections**            |                                                                              |
| Show course image       | Display the main promotional image for the course.                           |
| Show course description | Show the full course details (schedule, what you'll learn, who it's for).    |
| **Checkout Options**    |                                                                              |
| Show basket summary     | Display order summary with total price before payment.                       |
| **Layout Options**      |                                                                              |
| Show back button        | Allow customer to return to course details page without completing purchase. |

### Articles

| Component               | Description                                    |
| ----------------------- | ---------------------------------------------- |
| **BlogPageRouter**      | Article listing with routing for detail views. |
| **FeaturedBlogList**    | Curated list of featured articles.             |
| **RecentBlogPosts**     | Chronological list of recent articles.         |
| **BlogPostDetailsPage** | Full article detail page.                      |

#### BlogPageRouter Parameters

| Parameter                       | Description                                                         |
| ------------------------------- | ------------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                   |
| **Sections**                    |                                                                     |
| Show featured posts section     | Display the curated "Featured Articles" section at the top.         |
| Show featured section title     | Show heading ("Featured Articles") for the featured section.        |
| Show recent posts section       | Display the chronological list of all articles.                     |
| **Filters**                     |                                                                     |
| Recent articles to skip         | Number of recent articles to exclude from display (for pagination). |
| Show filters                    | Display category and search filter controls.                        |

#### FeaturedBlogList Parameters

| Parameter                       | Description                                        |
| ------------------------------- | -------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.  |
| Show title                      | Display the section heading ("Featured Articles"). |

#### RecentBlogPosts Parameters

| Parameter                       | Description                                             |
| ------------------------------- | ------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.       |
| Posts to Skip (0-10)            | Number of articles to exclude from the top of the list. |

#### BlogPostDetailsPage Parameters

| Parameter                       | Description                                                 |
| ------------------------------- | ----------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.           |
| **Sections**                    |                                                             |
| Show title                      | Display the article title and author info as a page header. |
| Show comments section           | Allow customers to leave comments on articles.              |
| Show related articles           | Recommend similar articles at the bottom of the page.       |

### Store

| Component                | Description                                 |
| ------------------------ | ------------------------------------------- |
| **SimpleProductGrid**    | Grid display of purchasable products.       |
| **SimplePlansGrid**      | Grid display of available membership plans. |
| **ProductCheckoutPage**  | Single product checkout flow.               |
| **ProductsCheckoutPage** | Multi-product checkout flow.                |

#### SimpleProductGrid Parameters

| Parameter                       | Description                                                              |
| ------------------------------- | ------------------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                        |
| Show title                      | Display the section heading ("Products").                                |
| Title size                      | Choose Small or Large heading size.                                      |
| Only show time passes           | Filter to display only time pass products (exclude other product types). |
| **Advanced**                    |                                                                          |
| Additional CSS classes          | Custom CSS classes for styling the product cards and container.          |

#### SimplePlansGrid Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| **Title**                       |                                                              |
| Show title                      | Display the section heading ("Membership Plans").            |
| Title size                      | Choose Small or Large heading size.                          |
| **Filters**                     |                                                              |
| Number of plans to show         | How many membership plans to display in the grid (1-9).      |
| **Advanced**                    |                                                              |
| Additional CSS classes          | Custom CSS classes for styling the plan cards and container. |

#### ProductCheckoutPage Parameters

| Parameter                       | Description                                                              |
| ------------------------------- | ------------------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                        |
| **Display Options**             |                                                                          |
| Show title                      | Display the product name as a page header.                               |
| **Checkout Options**            |                                                                          |
| Show payment method             | Display available payment methods during checkout.                       |
| Show basket summary             | Show order summary with total price before confirming purchase.          |
| **Layout Options**              |                                                                          |
| Show back button                | Allow customer to return to product listing without completing purchase. |

#### ProductsCheckoutPage Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| **Display Options**             |                                                              |
| Show filters                    | Display category and location filter controls.               |
| Show product type filter        | Filter products by type (e.g., Day Pass, Desk, Room).        |
| Show location selector          | Allow switching between locations to view local products.    |
| **Product Card Options**        |                                                              |
| Show product description        | Display the product summary text on each card.               |
| Show product price              | Show the hourly/daily/monthly pricing on each card.          |
| Show product image              | Display a visual thumbnail for each product.                 |
| **Layout Options**              |                                                              |
| Grid gap                        | Space between cards in the grid (e.g., "1.5rem").            |
| Minimum card width              | Smallest width a product card can shrink to (e.g., "300px"). |

### My Activity

| Component               | Description                                     |
| ----------------------- | ----------------------------------------------- |
| **MyBookingsSection**   | Member's booking history and upcoming bookings. |
| **MyInvoicesSection**   | Member's invoices and payment history.          |
| **MyVisitorsSection**   | Member's visitor registrations.                 |
| **MyDeliveriesSection** | Member's parcel/delivery log.                   |
| **MyEventsSection**     | Member's event registrations.                   |
| **MyCoursesSection**    | Member's course enrolments.                     |
| **MyPlansSection**      | Member's active plans and subscriptions.        |

#### MyBookingsSection Parameters

| Parameter                       | Description                                               |
| ------------------------------- | --------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.         |
| **Sections**                    |                                                           |
| Show title                      | Display the section heading ("My Bookings").              |
| Show filter bar                 | Show date and category filters for quick searching.       |
| Show resource image             | Display thumbnail images for booked resources.            |
| **Actions**                     |                                                           |
| Show booking settings button    | Link to manage recurring bookings and preferences.        |
| Show make a booking button      | Quick access button to book a new resource.               |
| Show modify button              | Allow editing existing bookings (if enabled).             |
| **Team**                        |                                                           |
| Show team bookings              | Include bookings made by other team members in this view. |

#### MyInvoicesSection Parameters

| Parameter            | Description                                          |
| -------------------- | ---------------------------------------------------- |
| **Sections**         |                                                      |
| Show title           | Display the section heading ("My Invoices").         |
| Show filter bar      | Show date and status filters for quick searching.    |
| **Actions**          |                                                      |
| Show download button | Allow customers to download invoice PDFs.            |
| Show pay button      | Quick access button to make a payment on an invoice. |

#### MyVisitorsSection Parameters

| Parameter                       | Description                                          |
| ------------------------------- | ---------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.    |
| **Sections**                    |                                                      |
| Show title                      | Display the section heading ("My Visitors").         |
| Show filter bar                 | Show date and status filters for quick searching.    |
| **Actions**                     |                                                      |
| Show register visitor button    | Quick access to invite a guest/visitor.              |
| Show delete button              | Allow deleting past visitor records.                 |
| Show reinvite button            | Resend the invitation email to a registered visitor. |

#### MyDeliveriesSection Parameters

| Parameter                       | Description                                            |
| ------------------------------- | ------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.      |
| **Sections**                    |                                                        |
| Show title                      | Display the section heading ("My Deliveries").         |
| Show filter bar                 | Show date and status filters for quick searching.      |
| **Actions**                     |                                                        |
| Show manage button              | Link to manage delivery preferences and notifications. |

#### MyEventsSection Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| **Sections**                    |                                                              |
| Show title                      | Display the section heading ("My Events").                   |
| Show filter bar                 | Show date and category filters for quick searching.          |
| Show event card image           | Display promotional images on each event card.               |
| **Actions**                     |                                                              |
| Show ticket action buttons      | Quick access to view/download tickets, or cancel attendance. |
| Show see all events button      | Link to browse the full upcoming events calendar.            |

#### MyCoursesSection Parameters

| Parameter                       | Description                                                          |
| ------------------------------- | -------------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                    |
| **Sections**                    |                                                                      |
| Show title                      | Display the section heading ("My Courses").                          |
| Show course image               | Display thumbnail images for enrolled courses.                       |
| Show progress badge             | Show progress percentage on each enrolled course card.               |
| **Actions**                     |                                                                      |
| Show see all courses button     | Link to browse all available courses (for upgrading or taking more). |

#### MyPlansSection Parameters

| Parameter                   | Description                                               |
| --------------------------- | --------------------------------------------------------- |
| **Sections**                |                                                           |
| Show title                  | Display the section heading ("My Plans").                 |
| Show join a plan button     | Quick access to browse and purchase new membership plans. |
| Show my plans section       | List currently active plans with renewal dates.           |
| Show my benefits section    | Display included benefits (booking credit, passes, etc.). |
| Show my products section    | List any one-time purchased products or credits.          |
| **Benefits**                |                                                           |
| Show booking credit section | Display remaining booking credit balance and expiry.      |
| Show booking time section   | Show available booking time (e.g., 40 hours/month).       |
| Show passes section         | Display any unused day passes included in the plan.       |

### Team

| Component                  | Description                      |
| -------------------------- | -------------------------------- |
| **TeamMembersSection**     | Team member list and management. |
| **TeamBookingsSection**    | Team booking overview.           |
| **TeamAttendanceSection**  | Team attendance tracking.        |
| **TeamPermissionsSection** | Team permission management.      |

#### TeamMembersSection Parameters

| Parameter                       | Description                                       |
| ------------------------------- | ------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing. |
| Show title                      | Display the section heading ("Team Members").     |
| Show filter bar                 | Show search and role filters for quick searching. |
| Show add members button         | Quick access to invite new team members.          |

#### TeamBookingsSection Parameters

| Parameter                       | Description                                                     |
| ------------------------------- | --------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.               |
| **Sections**                    |                                                                 |
| Show title                      | Display the section heading ("Team Bookings").                  |
| Show filter bar                 | Show date and status filters for quick searching.               |
| **Actions**                     |                                                                 |
| Show booking settings button    | Link to team-wide booking preferences and policies.             |
| Show make a booking button      | Quick access for admins to book resources on behalf of members. |
| **Display options**             |                                                                 |
| Show team member column         | Display which team member each booking belongs to.              |

#### TeamAttendanceSection Parameters

| Parameter                       | Description                                                |
| ------------------------------- | ---------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.          |
| Show title                      | Display the section heading ("Team Attendance").           |
| Show my attendance section      | Show your own recent check-in/out history.                 |
| Show team attendance matrix     | Display a calendar overview of all team member attendance. |
| Show manage attendance button   | Link to adjust attendance settings and policies.           |

#### TeamPermissionsSection Parameters

| Parameter                       | Description                                                |
| ------------------------------- | ---------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.          |
| Show title                      | Display the section heading ("Team Permissions").          |
| Show access card                | Display team member access card information.               |
| Show manage permissions button  | Link to adjust role-based permissions and settings.        |
| Show access account button      | Quick link to view and edit your personal account details. |

### Personal / Profile

| Component                      | Description                                                              |
| ------------------------------ | ------------------------------------------------------------------------ |
| **PersonalInformationSection** | Member profile editing form.                                             |
| **BillingInformationSection**  | Billing address and details.                                             |
| **BillingCardSection**         | Payment method management card.                                          |
| **EInvoicingCardSection**      | E-invoicing configuration card.                                          |
| **PaymentMethodsSections**     | Multi-provider payment method management (Stripe, Spreedly, GoCardless). |
| **ProfessionalProfileSection** | Public professional profile editing.                                     |
| **SettingTabsSection**         | Account settings tabbed interface.                                       |
| **CredentialsSection**         | Password and security credentials.                                       |
| **IntegrationsSection**        | Third-party integration settings.                                        |
| **VoManageSection**            | Virtual office management interface.                                     |

#### PersonalInformationSection Parameters

| Parameter           | Description                                     |
| ------------------- | ----------------------------------------------- |
| **Profile images**  |                                                 |
| Allow banner upload | Enable uploading a profile header/banner image. |
| Allow avatar upload | Enable uploading a profile photo/avatar image.  |

#### BillingInformationSection Parameters

| Parameter           | Description                                          |
| ------------------- | ---------------------------------------------------- |
| **Billing Card**    |                                                      |
| Show title          | Display the section heading ("Billing Information"). |
| **eInvoicing Card** |                                                      |
| Show title          | Display the section heading ("E-Invoicing").         |

#### BillingCardSection Parameters

| Parameter    | Description                                          |
| ------------ | ---------------------------------------------------- |
| **Sections** |                                                      |
| Show title   | Display the section heading ("Billing Information"). |

#### EInvoicingCardSection Parameters

| Parameter    | Description                                  |
| ------------ | -------------------------------------------- |
| **Sections** |                                              |
| Show title   | Display the section heading ("E-Invoicing"). |

#### PaymentMethodsSections Parameters

| Parameter                                        | Description |
| ------------------------------------------------ | ----------- |
| No parameters available — uses default settings. |             |

#### ProfessionalProfileSection Parameters

| Parameter               | Description                                                        |
| ----------------------- | ------------------------------------------------------------------ |
| **Sections**            |                                                                    |
| Show social networks    | Display links to your LinkedIn, Twitter, or other social profiles. |
| Show skills & expertise | Show your professional skills and areas of expertise.              |
| Show directory section  | Include you in the public member directory search.                 |

#### SettingTabsSection Parameters

| Parameter                       | Description                                                                 |
| ------------------------------- | --------------------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.                           |
| **Tabs visibility**             |                                                                             |
| Show Bookings tab               | Enable the Bookings settings tab in the account settings menu.              |
| Show Preferences tab            | Enable the Email/SMS notification preferences tab.                          |
| Show Security tab               | Enable the password and two-factor authentication settings tab.             |
| Show Integrations tab           | Enable the third-party integration management tab (Google, Outlook, Apple). |
| Show Notifications tab          | Enable the mobile push notification settings tab.                           |

#### CredentialsSection Parameters

| Parameter                          | Description                                                  |
| ---------------------------------- | ------------------------------------------------------------ |
| **Section visibility**             |                                                              |
| Show PIN section                   | Display the 4-digit PIN setup and management area.           |
| Show change password section       | Allow changing your account password.                        |
| Show "Request new password" button | Display a quick link to reset forgotten passwords via email. |

#### IntegrationsSection Parameters

| Parameter                          | Description                                                        |
| ---------------------------------- | ------------------------------------------------------------------ |
| **Section visibility**             |                                                                    |
| Show Calendar Integrations section | Display Google Calendar, Outlook and Apple Calendar sync settings. |
| Show Calendar Feeds section        | Display iCal feed URLs for subscribing externally.                 |
| Show Resource Feeds section        | Display API feeds for integrating with external systems.           |
| **Provider visibility**            |                                                                    |
| Show Google                        | Enable Google account linking and sync options.                    |
| Show Outlook                       | Enable Microsoft Outlook/Exchange account linking.                 |
| Show Apple                         | Enable Apple Calendar account linking.                             |

#### VoManageSection Parameters

| Parameter                     | Description                                                                   |
| ----------------------------- | ----------------------------------------------------------------------------- |
| **Tabs**                      |                                                                               |
| Show handling preferences tab | Configure how packages and mail are handled (hold time, notifications).       |
| Show address book tab         | Manage the list of people who can collect your deliveries.                    |
| Show identity checks tab      | View and manage completed identity verification status.                       |
| **Display**                   |                                                                               |
| Show profile mismatch alert   | Display a warning if your profile information doesn't match official records. |

### Community

| Component                     | Description                   |
| ----------------------------- | ----------------------------- |
| **CommunityBoardListSection** | Community discussion board.   |
| **DirectorySection**          | Member directory listing.     |
| **PerksSection**              | Available perks and benefits. |
| **Newsletter**                | Newsletter subscription form. |

#### CommunityBoardListSection Parameters

| Parameter                       | Description                                                    |
| ------------------------------- | -------------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.              |
| **Sections**                    |                                                                |
| Show title                      | Display the section heading ("Community Board").               |
| Show filter bar                 | Show category and date filters for quick searching.            |
| **Actions**                     |                                                                |
| Show "Start discussion" button  | Quick access to create a new forum thread or discussion topic. |

#### DirectorySection Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| **Sections**                    |                                                              |
| Show title                      | Display the section heading ("Directory").                   |
| Show filter bar                 | Show search and category filters for finding members.        |
| **Filters**                     |                                                              |
| Show industry / skill filter    | Filter directory results by profession or area of expertise. |
| Show order filter               | Sort results by date joined, name, or company size.          |
| Show search box                 | Display the member search input field.                       |
| **Card display**                |                                                              |
| Show company name               | Display the registered business/company name on each card.   |
| Show home location              | Display which location is set as this member's primary base. |
| **Actions**                     |                                                              |
| Show view profile button        | Quick access to view a member's full public profile.         |
| Show message button             | Allow sending an in-app message to another member.           |

#### PerksSection Parameters

| Parameter                       | Description                                                  |
| ------------------------------- | ------------------------------------------------------------ |
| Show mock data (in editor only) | Show mock data instead of live data when editing.            |
| Show title                      | Display the section heading ("Community Perks").             |
| Show filter bar                 | Show category filters for finding specific perks.            |
| Max perks to show               | Limit how many perk cards display before showing "View all". |
| **Advanced**                    |                                                              |
| Additional CSS classes          | Custom CSS classes for styling the perks grid and cards.     |

#### Newsletter Parameters

| Parameter              | Description                                                              |
| ---------------------- | ------------------------------------------------------------------------ |
| Title Type             | Set context for the newsletter title — General, Blog, or Event specific. |
| Show image             | Display a featured image in the newsletter signup card.                  |
| **Advanced**           |                                                                          |
| Additional CSS classes | Custom CSS classes for styling the newsletter form and container.        |

### Support

| Component           | Description                           |
| ------------------- | ------------------------------------- |
| **FaqPageSection**  | Frequently asked questions.           |
| **HelpDeskSection** | Help desk / support ticket interface. |
| **ContactUsPage**   | Contact form page.                    |
| **LocationsGrid**   | Grid of all business locations.       |

#### FaqPageSection Parameters

| Parameter                            | Description                                                                        |
| ------------------------------------ | ---------------------------------------------------------------------------------- |
| Show mock data (in editor only)      | Show mock data instead of live data when editing.                                  |
| Show title                           | Display the section heading ("Help & FAQ").                                        |
| Show filter bar                      | Show search and category filters for finding answers.                              |
| Show "Help me find an answer" button | Launch the guided help assistant that asks questions to suggest relevant articles. |

#### HelpDeskSection Parameters

| Parameter                            | Description                                                                        |
| ------------------------------------ | ---------------------------------------------------------------------------------- |
| Show title                           | Display the section heading ("Help Desk").                                         |
| Show filter bar                      | Show search and category filters for finding answers.                              |
| Show "Help me find an answer" button | Launch the guided help assistant that asks questions to suggest relevant articles. |
| Show "Request help" button           | Quick access to open a new support ticket or contact the team.                     |

#### ContactUsPage Parameters

| Parameter                       | Description                                              |
| ------------------------------- | -------------------------------------------------------- |
| Show mock data (in editor only) | Show mock data instead of live data when editing.        |
| **Sections**                    |                                                          |
| Show contact us header          | Display the section title and introductory text.         |
| Show contact us form            | Show the name, email, subject and message input fields.  |
| Show contact map                | Include an interactive map showing the location address. |

#### LocationsGrid Parameters

| Parameter              | Description                                                  |
| ---------------------- | ------------------------------------------------------------ |
| **Title**              |                                                              |
| Show title             | Display the section heading ("Our Locations").               |
| Title size             | Choose Small or Large heading size.                          |
| **Advanced**           |                                                              |
| Additional CSS classes | Custom CSS classes for styling the locations grid and cards. |

***

## Mock data in the editor

When editing a page, section components render with **mock data** instead of making live API calls. This means you see realistic placeholder content (sample events, bookings, members, etc.) that lets you design the layout without needing actual data.

Most section components include a **Show mock data (in editor only)** toggle in their properties. This defaults to `true` in the editor. When disabled, the component attempts to fetch live data — useful for testing with your actual data during local development.

## Default page layouts

Every built-in page has a **default layout** — a pre-configured arrangement of section components. For example:

* **Home** defaults to a HomePage component with hero, plans, events and locations.
* **Personal Dashboard** defaults to DashboardHero, QuickActions, AnnouncementsBanner, WeeklyAgendaCalendar, and more.
* **Articles** defaults to NavBar + BlogPageRouter + Newsletter.

You can customise these layouts freely. If you want to start over, use the **Delete outline** button in the toolbar to restore the default layout.


# Toolbar & Workflow
Source: https://learn.nexudus.com/editor/toolbar

Draft management, saving, resetting, deleting and previewing pages in the portal editor.

The editor toolbar sits at the top of the canvas and provides all the actions you need to manage the lifecycle of a page — from drafting changes through to previewing and saving.

## Toolbar buttons (left to right)

| Element                     | Visibility           | Description                                                                                                                           |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **Unsaved draft indicator** | When changes exist   | A small label that reads *"Unsaved draft"*, shown whenever the current layout differs from the last saved version.                    |
| **Page status selector**    | Custom pages only    | A dropdown to set the page visibility: Unpublished, Hidden (Private), Published, or Only Members.                                     |
| **Delete page**             | Custom pages (saved) | Permanently deletes the custom page. Requires confirmation.                                                                           |
| **Reset**                   | Always               | Discards all unsaved changes and reverts to the last saved version (or the default layout for built-in pages). Requires confirmation. |
| **Delete outline**          | Built-in pages only  | Removes all customisations from a built-in page and restores the factory-default layout. Requires confirmation.                       |
| **Preview**                 | Always               | Opens a full preview of the current layout in a new browser tab.                                                                      |
| **Save**                    | Always               | Persists the current layout to the server.                                                                                            |

## Unsaved drafts

The editor automatically tracks whether you have unsaved changes:

* Every edit you make is compared against the last saved version.
* If there is a difference, the **"Unsaved draft"** indicator appears in the toolbar.
* Drafts are stored in your browser's **localStorage** so they survive page refreshes and accidental tab closes.
* The localStorage key follows the pattern `editor-draft-{pageName}` for built-in pages and `editor-draft-file-{fileId}` for custom pages.

<Warning>
  Drafts are stored locally in your browser. If you switch to a different browser or clear your browser data, unsaved drafts are lost. Always **Save**
  important changes.
</Warning>

### How draft detection works

1. When you open a page, the editor loads any existing draft from localStorage first, falling back to the saved version from the API, and finally to the default layout.
2. On every change in the editor, the current state is compared to the saved reference.
3. If they differ, `hasDraft` is set to `true` and the indicator appears.
4. Saving or resetting clears the draft from localStorage and hides the indicator.

## Page status (custom pages)

Custom pages have a visibility dropdown with four options:

| Status               | Behaviour                                                                                                        |
| -------------------- | ---------------------------------------------------------------------------------------------------------------- |
| **Unpublished**      | The page is not accessible to anyone. Useful for work-in-progress pages.                                         |
| **Hidden (private)** | The page exists but is not listed in the navigation. Only accessible via direct URL.                             |
| **Published**        | The page is visible to everyone and appears in the navigation (if added).                                        |
| **Only Members**     | The page is only visible to authenticated members (i.e. customer with an active contract for one of your plans). |

The status is set in the toolbar and saved together with the page content when you click **Save**.

## Reset

Clicking **Reset** shows a confirmation dialog:

> *"This will discard all unsaved changes and revert to the last saved version. Are you sure?"*

* For **custom pages**, the editor reloads the page content from the API.
* For **built-in pages**, the editor reloads the saved layout, or the default layout if no customisation has been saved.
* The draft is cleared from localStorage.

## Delete outline (built-in pages)

Built-in pages can be customised but never truly deleted. The **Delete outline** button removes your customisations and restores the factory-default layout:

> *"This will restore the default layout for this page. All your customisations will be lost. Are you sure?"*

After confirming:

* The saved customisation is deleted from the API.
* The editor loads the default layout from the built-in defaults.
* The draft is cleared from localStorage.

<Note>This action does not remove the page itself — the page continues to exist with its default layout.</Note>

## Delete page (custom pages)

For custom pages that have been saved at least once (i.e. they have a page ID), the **Delete** button permanently removes the page:

> *"Are you sure you want to delete this page? This action cannot be undone."*

After confirming:

* The page is deleted from the API.
* The localStorage draft is cleared.
* You are redirected away from the editor.

## Preview

Clicking **Preview** opens a new browser tab showing the page as a member would see it — including the current unsaved changes.

### How preview works

1. The editor encodes the current page layout as a Base64 string.
2. A preview URL is constructed with `?previewOutline=<base64>&previewName=<identifier>` parameters.
3. For **built-in pages**, the URL points to the page's standard route.
4. For **custom pages**, the URL points to `/pages/{fileId}/{slug}`.
5. When the portal loads, it reads the URL parameters, stores the preview data in localStorage, and strips the parameters from the URL.

### Preview banner

While preview outlines are active, the portal shows a **yellow warning banner** at the top of every page:

* **Text:** *"Preview mode — You are browsing the site with unsaved page previews."*
* **Button:** *"Clear preview"* — removes all preview data from localStorage and reloads the portal.
* The banner does **not** appear inside the editor itself.

<Tip>
  Preview data persists in the browser until you click "Clear preview" or close the tab. This lets you navigate around the portal and see how the
  previewed page interacts with the rest of the site.
</Tip>

## Save

Clicking **Save** persists the current layout:

* **New custom pages** (ID = 0): the editor sends a `POST` request to create the page. On success, the URL updates to reflect the new page ID.
* **Existing custom pages**: the editor sends a `PUT` request to update the page.
* **Built-in pages**: the editor sends a `PUT` request to update the named outline.
* The draft is cleared from localStorage.
* The `hasDraft` indicator disappears.

## Viewports

The canvas supports three viewport sizes for responsive design:

| Viewport    | Width   | Icon       |
| ----------- | ------- | ---------- |
| **Desktop** | 1400 px | Monitor    |
| **Tablet**  | 768 px  | Tablet     |
| **Mobile**  | 375 px  | Smartphone |

Switch between viewports using the icons in the toolbar to see how your layout adapts to different screen sizes.


# Getting Started Overview
Source: https://learn.nexudus.com/get-started/overview

An introduction to the Nexudus Platform documentation and links to main sections.

# Introduction

Welcome to the Nexudus Platform documentation! This guide is your gateway to mastering the tools and features that make coworking spaces thrive. Whether you're setting up your space, managing your community, or customizing the portal, you'll find everything you need here.

<Columns>
  <Frame>
    <img alt="Nexudus Administration Panel" />
  </Frame>

  <Frame>
    <img alt="Nexudus Administration Panel" />
  </Frame>
</Columns>

## Overview

<CardGroup>
  <Card title="Getting Started" icon="rocket" href="/get-started/overview">
    Guides for using the Nexudus Dashboard as a coworking space operator.
  </Card>

  <Card title="Member Portal" icon="browser" href="/member-portal/overview">
    Guide to every page and section your members see in the portal.
  </Card>

  <Card title="Portal Editor" icon="pen-ruler" href="/editor/overview">
    Visual drag-and-drop page editor for customising your Members Portal.
  </Card>

  <Card title="REST API Reference" icon="book-open" href="/rest-api/overview">
    Complete reference for every endpoint in the Nexudus REST API.
  </Card>

  <Card title="Public API Reference" icon="plug" href="/api/overview">
    Public API details and usage examples for the Members Portal.
  </Card>

  <Card title="Marketplaces API" icon="store" href="/rest-api/marketplaces/overview">
    API for marketplace providers aggregating inventory data across Nexudus customers.
  </Card>

  <Card title="Environment API" icon="temperature-half" href="/rest-api/environment/overview">
    Pull and receive sensor data to trigger actions and display measurements.
  </Card>

  <Card title="Nexudus MCP" icon="plug" href="/mcp/overview">
    Connect AI assistants like Claude and ChatGPT to your Nexudus account using the official MCP server.
  </Card>

  <Card title="Nexudus CLI" icon="terminal" href="/cli/overview">
    Command-line tool and AI Agent Skills for managing Nexudus coworking spaces.
  </Card>

  <Card title="Nexudus SDK" icon="cube" href="/sdk/overview">
    The official .NET SDK for interacting with the Nexudus REST API programmatically.
  </Card>

  <Card title="Access Control" icon="lock" href="/integrations/access-control/overview">
    Connect your access control systems to Nexudus.
  </Card>

  <Card title="Network Bridge" icon="bridge" href="/integrations/network-bridge">
    Connect with systems and services installed on your Location's local network.
  </Card>
</CardGroup>

## Need Help?

<Tip>
  If you have any questions or need further assistance, visit our [Help Center](https://help.nexudus.com) or contact our support team. We're here to
  help you succeed!
</Tip>


# Admin vs Members Portal
Source: https://learn.nexudus.com/get-started/platform-overview/admin-vs-members-portal

Understand the differences between the Admin Panel and the Members Portal in the Nexudus platform.

## Overview

The Nexudus platform provides two distinct interfaces to cater to the needs of coworking space operators and members:

1. **Admin Panel**: Designed for operators to manage and configure the coworking space.
2. **Members Portal**: Designed for members to interact with the coworking space and manage their accounts.

## Admin Panel

The Admin Panel is the control center for coworking space operators. It provides tools and features to:

* Configure the coworking space, including locations, plans, and resources.
* Manage memberships, bookings, and financials.
* Monitor and analyze space usage and revenue.
* Customize the Members Portal experience for your members.
* Access advanced settings and integrations.

### Key Features

* **Dashboard**: Provides an overview of key metrics and activities.
* **Bookings Management**: Allows operators to view, edit, and manage bookings.
* **Financial Tools**: Includes invoicing, payments, and revenue tracking.
* **Customization Options**: Enables operators to tailor the Members Portal to their brand and needs.

The Admin Panel is accessible only to authorized operators and requires appropriate permissions.

## Members Portal

The Members Portal is the interface for members to interact with the coworking space. It allows members to:

* Book resources such as meeting rooms and desks.
* Purchase plans, passes, and products.
* View and pay invoices.
* Participate in community features like events and discussion boards.
* Manage their account settings and preferences.

### Key Features

* **Home and Navigation**: Provides an intuitive interface for members to access features.
* **Bookings**: Allows members to view and manage their bookings, including advanced options like one-click bookings for existing customers and even zero-click bookings through predictive algorithms.
* **Fast Checkout**: Offers quick conversion features such as fast checkout for new customers (if enabled by operators).
* **Community Features**: Includes events, courses, and discussion boards.
* **Account Management**: Enables members to update their profile, view invoices, and manage privacy settings.

The Members Portal is designed to be user-friendly and accessible to all members.

## Summary

* The **Admin Panel** is for operators to manage and configure the coworking space.
* The **Members Portal** is for members to interact with the coworking space and manage their accounts.
* Operators should be familiar with both interfaces to provide better support to members.


# Understanding Your Nexudus Platform Data Structure
Source: https://learn.nexudus.com/get-started/platform-overview/data-model-overview

Learn how data is organized and connected in Nexudus to optimize coworking operations.

## Overview

As a coworking operator using Nexudus, you work with various types of data every day - from customer profiles to bookings to invoices. This guide explains how all the information in your Nexudus platform is organized and connected, helping you better understand how to manage and optimize your coworking space operations.

## Your Core Business Data

### 1. **Locations**

Your physical coworking spaces and how they're configured in Nexudus:

* Each location you operate (whether one space or multiple buildings)
* Essential details: address, contact information, operating hours
* Your branding: logos, colors, website information
* Location-specific settings: pricing, policies, features
* Payment processing and billing configurations
* Access control and security settings
* Locations can be nested to create networks, enabling better organization and management of interconnected spaces.

<Info>
  Why this matters: This is the foundation of your Nexudus setup. Each location can have different pricing, policies,
  and features.
</Info>

### 2. **Staff Users**

Your team members who help run the coworking space:

* **Platform administrators**: Full access to manage all locations and settings
* **Location managers**: Day-to-day operations for specific spaces
* **Front desk staff**: Customer service and basic operations
* **Support team**: Help with customer issues and platform questions

<Info>
  Why this matters: Different staff roles have different permissions, ensuring the right people can access the tools
  they need while maintaining security.
</Info>

### 3. **Customers**

The heart of your business - the people who use your coworking space:

* **Member profiles**: Contact details, emergency contacts, company information
* **Professional profiles**: Job title, company, social media, networking preferences
* Customers can be registered with multiple locations if they use more than one, avoiding duplication and ensuring seamless management.

### 4. **Plans and Products**

* Plans and products can be configured to be available across multiple locations, reducing duplication and ensuring consistency.
* Alternatively, they can be set per site to accommodate different pricing or currency requirements.

## Your Physical Space and Assets

### 5. **Resources**

Everything customers can book or use in your space:

* **Meeting rooms**: Conference rooms, phone booths, private offices for meetings
* **Workspaces**: Hot desks, dedicated desks, private offices
* **Equipment**: Printers, projectors, lockers, parking spaces
* **Event spaces**: Areas for workshops, networking events, presentations

**Each resource includes:**

* **Booking rules**: How far in advance, minimum/maximum booking times
* **Pricing**: Hourly rates, member vs non-member pricing
* **Features**: What's included (projector, whiteboard, catering setup)
* **Capacity**: Maximum occupancy and layout details
* **Availability**: Operating hours and blackout periods

<Info>
  Why this matters: Properly configured resources maximize your revenue and ensure customers can easily find and book
  what they need.
</Info>

### 6. **Teams**

Groups of customers who work together and share billing:

* **Companies**: Organizations with multiple employees as members
* **Departments**: Teams within larger companies
* **Project groups**: Temporary collaborations
* **Shared billing**: One contact handles payments for the entire team

<Info>
  Why this matters: Teams simplify billing and help you understand which organizations are your biggest customers.
</Info>

## Your Pricing and Membership Structure

### 7. **Plans**

Your membership packages and pricing tiers:

* **Hot desk plans**: Flexible workspace access with different usage limits
* **Dedicated desk plans**: Reserved workspace with varying included benefits
* **Private office plans**: Exclusive space rentals
* **Day pass rates**: Casual use pricing for non-members
* **Corporate plans**: Custom packages for larger teams

**Each plan includes:**

* Monthly or weekly rates
* Included benefits (meeting room hours, printing credits, guest passes)
* Access schedules (24/7, business hours, weekends)
* Billing frequency and payment terms

<Info>
  Why this matters: Well-structured plans attract different customer segments and maximize revenue from your space.
</Info>

### 8. **Products**

Add-on services and extras you sell. These can be one-off, recurrent or event added as part of a contract (see below).

* **Printing and copying** services
* **Guest day passes** for member visitors
* **Storage lockers** and mail handling
* **Event tickets** and workshop fees
* **Food and beverage** packages
* **Parking spaces** and bike storage

<Info>Why this matters: Products create additional revenue streams beyond basic membership fees.</Info>

### 9. **Contracts**

The membership agreements that formalize your customer relationships:

* **Contract terms**: Start/end dates, renewal conditions
* **Assigned plan**: Which pricing package applies
* **Dedicated resources**: Specific desks or offices assigned to the customer
* **Billing schedule**: When and how often to invoice
* **Contract status**: Active, paused, cancelled, pending

<Info>
  Why this matters: Contracts provide predictable recurring revenue and clear terms for both you and your customers.
</Info>

## Managing Bookings and Space Utilization

### 10. **Bookings**

Every reservation made by your customers:

* **Meeting room reservations** with setup preferences and catering needs
* **Hot desk bookings** when customers want to guarantee a workspace
* **Equipment reservations** for printers, projectors, or special tools
* **Event space bookings** for member-hosted events or workshops

**Key booking information:**

* Date, time, and duration
* Special requests and setup needs
* Pricing (member rates vs guest rates)
* Cancellation and no-show policies
* Integration with calendar systems (Google, Outlook)

<Info>
  Why this matters: Efficient booking management maximizes space utilization and customer satisfaction while minimizing
  conflicts.
</Info>

### 11. **Calendar Events**

Community activities and events you host:

* **Networking events** to build member community
* **Educational workshops** and skill-sharing sessions
* **Social activities** like happy hours or fitness classes
* **Member presentations** and pitch sessions
* **External events** that generate additional revenue

<Info>
  Why this matters: A strong event calendar builds community, increases member retention, and can provide additional
  revenue streams.
</Info>

## Your Financial Operations

### 12. **Invoices**

Bills sent to your customers for their usage:

* **Monthly membership fees** for recurring plans
* **Usage charges** for meeting rooms, printing, and other services
* **Product purchases** like guest passes or event tickets
* **Overage fees** when customers exceed their plan limits
* **Late fees** and other administrative charges

<Info>Why this matters: Automated invoicing ensures consistent cash flow and reduces administrative overhead.</Info>

### 13. **Charges**

Individual items that make up each invoice:

* **Plan fees**: The base membership cost
* **Usage charges**: Pay-per-use services consumed
* **Product sales**: Additional items purchased
* **Credits applied**: Discounts, refunds, or promotional adjustments
* **Tax calculations**: Automatically applied based on your location and customer type

<Info>
  Why this matters: Detailed charge tracking helps you understand revenue sources and customer usage patterns.
</Info>

### 14. **Payment Management**

How money flows into your business:

* **Payment methods**: Credit cards, bank transfers, cash payments
* **Automated billing**: Recurring charges processed automatically
* **Payment tracking**: Success/failure status and retry logic
* **Financial reporting**: Revenue analysis and forecasting tools
* **Refunds and adjustments**: Managing credits and payment corrections

<Info>Why this matters: Streamlined payment processing reduces admin work and improves cash flow.</Info>

## Building Community and Member Engagement

### 15. **Community Features**

Tools to foster connections and engagement:

* **Member directory**: Helping customers network and collaborate
* **Discussion forums**: Space-specific and interest-based conversations
* **Announcement system**: Important updates and space information
* **Articles**: Content marketing and thought leadership
* **Event RSVP system**: Managing attendance for community events

<Info>
  Why this matters: Strong community features increase member satisfaction, retention, and word-of-mouth referrals.
</Info>

### 16. **Integrations and Apps**

Connecting Nexudus with your other business tools:

* **Calendar sync**: Google Calendar, Outlook integration for seamless booking
* **Payment processors**: Stripe, PayPal, and local payment gateways
* **Access control**: Door locks, key cards, and security systems
* **Accounting software**: QuickBooks, Xero for financial management
* **Marketing tools**: Email campaigns and customer communication

<Info>
  Why this matters: Integrations eliminate double-entry and create a seamless experience for both you and your
  customers.
</Info>

## Security and Access Management

### 17. **Access Control**

Managing who can enter your space and when:

* **Key cards and fobs**: Physical access credentials for members
* **PIN codes**: Backup access for doors and lockers
* **Access schedules**: Different permissions based on plan type and time
* **Visitor management**: Temporary access for guests and clients
* **Security logs**: Tracking entry/exit for safety and billing verification

<Info>
  Why this matters: Proper access control keeps your space secure while providing convenient access for paying
  customers.
</Info>

## Advanced Features and Credits System

### 18. **Passes and Credits**

Flexible payment options for casual users and additional services:

**Passes:**

* **Day passes**: Single-day access for non-members or visitors
* **Week passes**: Short-term access for temporary projects
* **Trial passes**: Free or discounted access for prospective members
* **Event passes**: Access specifically for workshops or networking events

**Money Credits:**

* **Prepaid credits**: Customers purchase credit that's applied to future usage
* **Meeting room allowances**: Credits included in membership plans
* **Printing credits**: Prepaid balance for copying and printing services
* **Promotional credits**: Bonus credits from referrals or special offers

**Time/Usage Credits:**

* **Meeting room hours**: Time-based credits for booking conference rooms
* **Equipment usage**: Credits for printer, scanner, or projector use
* **Locker rentals**: Time-based access to storage facilities
* **Parking credits**: Daily or hourly parking allowances

<Info>
  Why this matters: Credits and passes provide flexibility for customers while creating additional revenue opportunities
  and improving cash flow.
</Info>

### 19. **Promotions and Discounts**

Tools to attract and retain customers:

* **Discount codes**: Percentage or fixed-amount reductions
* **Referral programs**: Credits for bringing in new members
* **Early bird pricing**: Discounts for annual plans or advance payments
* **Corporate discounts**: Special rates for large teams or long-term commitments
* **Seasonal promotions**: Holiday specials and limited-time offers

<Info>Why this matters: Strategic promotions help fill capacity during slow periods and reward loyal customers.</Info>

## How It All Works Together: Your Daily Operations

Understanding how these components connect helps you make the most of your Nexudus platform:

### **Customer Journey:**

1. **Prospect visits** your website and browses available **Plans**
2. **Customer signs up** and creates a **Contract** with their chosen plan
3. **Access credentials** are provided (key card, PIN code)
4. **Customer makes Bookings** for meeting rooms and services
5. **Usage generates Charges** which are compiled into **Invoices**
6. **Payments** are processed automatically or manually
7. **Community engagement** through events and networking features

### **Your Management Workflow:**

1. **Configure your Location** settings, pricing, and policies
2. **Set up Resources** with appropriate booking rules and pricing
3. **Create Plans** that appeal to different customer segments
4. **Monitor Bookings** and space utilization
5. **Process Invoices** and manage payments
6. **Engage your community** through events and communications
7. **Analyze data** to optimize pricing and operations

### **Revenue Optimization:**

* **Recurring revenue** from membership plans provides stability
* **Usage-based charging** maximizes revenue from heavy users
* **Product sales** create additional income streams
* **Event tickets** can generate extra revenue
* **Corporate contracts** provide larger, predictable revenue
* **Credits and passes** improve cash flow through prepayments

### **Key Benefits for Your Operation:**

* **Automated billing** reduces administrative overhead
* **Real-time availability** prevents double bookings
* **Member self-service** reduces front desk workload
* **Detailed reporting** helps you understand your business
* **Community tools** increase member retention
* **Integration capabilities** streamline your workflow

This integrated system helps you focus on what matters most: creating a thriving coworking community while running a profitable business.


# How Admin Settings Affect Members
Source: https://learn.nexudus.com/get-started/platform-overview/how-configuration-flows-to-members

Understand how configuration and data flow from the Admin Panel to the Members Portal, shaping the user experience.

## Overview

The Nexudus Members Portal is not a standalone product. Everything users see, access, and can do in the portal is determined by how Nexudus has been configured in the Admin Panel.

This page explains how configuration and data flow from the Admin Panel to the Members Portal, with particular focus on:

* Members vs contacts
* Contracts as the source of membership
* Suspensions and frozen contracts
* Login, contact-level, and member-only access
* Multi-location and network visibility

## The Core Mental Model

At a high level, the flow looks like this:

**Admin Configuration → Customer State → Contract State → Rules & Permissions → Members Portal Experience**

### Key Principles

* Every person using your space in Nexudus is a customer.
* Customers fall into two states:
  * **Members**: At least one active contract.
  * **Contacts**: No active contracts.
* The Members Portal renders a filtered experience based on:
  * Whether the customer is a member or a contact.
  * Whether contracts are active, frozen, or suspended.
  * Portal access rules.
  * Location and network scope.

Most “why does this user…” questions can be traced back to one of these layers.

## Customers, Members, and Contacts

### Customers as the Base Entity

In Nexudus, a customer is the base entity for people and companies. All customers:

* Can exist in the system.
* May have login credentials.
* May appear in directories or listings.
* May access parts of the Members Portal.

Whether they are treated as members or contacts depends entirely on contracts.

### Members vs Contacts

* A **member** is a customer with at least one active contract.
* A **contact** is a customer with no active contracts.

Membership is not a manual flag — it is derived dynamically from contract state.

* When a customer gains an active contract, they immediately become a member.
* When all contracts end or are removed, they revert to being a contact.

## Contracts Define Membership and Benefits

Contracts are the source of membership in Nexudus. They define:

* Whether a customer is currently a member.
* Which plan applies.
* What benefits and entitlements are available.
* How billing and access are handled.

<Info>A customer with multiple contracts is considered a member as long as at least one contract is active.</Info>

### Suspended Customers

A customer can be suspended, regardless of whether they are a member or a contact. When suspended:

* Login may still be allowed.
* Access to actions is restricted.
* Member-only functionality may be blocked.

#### Examples:

* A suspended member may not be able to create bookings.
* A suspended member may not be able to make payments.
* Some sections may become read-only.
  <Warning>
    Suspension does not override membership benefits while it is active but automatic billing will stop for suspended
    members.
  </Warning>

### Frozen Contracts

Contracts can be frozen, temporarily pausing membership benefits without ending the contract. When frozen:

* The customer is still a member (the contract exists).
* Benefits linked to the frozen contract are suspended.
* Member-only access may be restricted.

#### Examples:

* A member may not be able to book a member-only resource.
* Included credits or allowances are paused.
* Plan-based discounts do not apply.

When the contract resumes, benefits and access are restored automatically.

## Portal Access Requirements

Each section of the Members Portal can be configured to require different access levels.

### Access Levels

Portal sections can be configured to require users to be:

* **Public**: No login required.
* **Logged in**.
* **Contacts**: Customers without active contracts.
* **Members**: Customers with at least one active contract.

This allows operators to expose different experiences to different customer states.

### Sections with Configurable Access Rules

The following sections can each be configured independently:

* Entire portal
* Home page
* About us page
* Help Desk module
* Events list and calendar
* Booking pages
* Directory pages
* Discussion board pages
* Article pages
* Contact pages
* Payments page
* Plan selection page
* Benefits page
* Products store page
* Perks and benefits page
* Frequently asked questions

#### Example Scenarios:

* Contacts may browse plans but not book resources.
* Members may access bookings and payments.
* Some content may require login but not membership.

## Portal Access and Customer Status

Regardless of a customer's status (member or contact), they can either have portal access or not. Portal access is a separate configuration that determines whether a customer can log in and interact with the Members Portal.

### Customers Without Portal Access

* Customers without portal access cannot log in to the Members Portal.
* They are unable to view or interact with any portal content, regardless of their membership or contract status.

### Customers With Portal Access

* Customers with portal access can log in and interact with the portal based on their status and permissions.
* Access to specific sections and features is further determined by:
  * Member vs contact status.
  * Contract state (active, frozen, or suspended).
  * Configured portal access rules.

## Permissions and Roles

Permissions determine what a customer can do, not just what they can see. Permissions are evaluated based on:

* Member vs contact status.
* Active, frozen, or suspended contracts.
* Team or company membership.
* Enabled features.

Two members on the same plan may still have different permissions due to role or team context.

## Plans, Benefits, and Entitlements

Plans define the benefits of a contract, not the identity of the customer. Plans control:

* Which resources can be booked.
* Included credits or allowances.
* Pricing rules.
* Discounts and benefits.
* Access to member-only areas.

If a contract is frozen or the customer is suspended:

* Plan benefits are temporarily disabled.
* Access may be restricted even though the contract still exists.

## Bookings and Availability

Booking access is determined by stacked rules. Availability is evaluated in this order:

1. Portal access requirements.
2. Member vs contact status.
3. Customer suspension state.
4. Contract freeze state.
5. Plan entitlements.
6. Resource configuration.
7. Availability schedules.
8. Booking rules and constraints.
9. Time-based rules.

This explains why:

* A resource appears but cannot be booked.
* A member sees availability but cannot confirm a booking.
* Access changes when a contract is frozen.

## Products, Store, and Payments

Commerce in the Members Portal is driven entirely by Admin configuration. Visibility and access depend on:

* Portal access rules.
* Member vs contact status.
* Contract state.
* Plan restrictions.
* Suspension state.

#### Example:

A suspended member may:

* See products.
* But be prevented from purchasing.

## Community Content Visibility

Community content is filtered by both access level and location scope. Content types affected:

* Events
* Articles
* Perks and discounts
* FAQ articles

Content can be:

* Public
* Contact-only
* Member-only
* Restricted by plan

## Location and Network Visibility

When an operator manages multiple locations, content and resources can be scoped.

### Supported Visibility Scopes

The following can be configured to show data from:

* The current location.
* All child locations.
* All parent locations.
* All locations in a network.

Applies to:

* Events
* Articles
* Perks and discounts
* FAQ articles
* Bookable resources
* Products

This allows operators to balance local relevance with network-wide consistency.

## Branding, Language, and Customization

Portal appearance is centrally controlled. Operators define:

* Branding and colors.
* Logos.
* Available languages.
* Custom pages.
* Embedded pages.

Customers can typically only change:

* Their preferred language.
* Personal profile settings.

## Timing, Sync, and Delays

Not all changes take effect immediately. Examples:

* Contract freezes affect access immediately.
* Suspension restricts actions immediately.
* Plan changes may affect billing on the next cycle.
* Permission changes may require re-login.

Understanding timing is essential when troubleshooting.

## Common Troubleshooting Scenarios

### “Why can this user log in but not book anything?”

Likely causes:

* They are a contact, not a member.
* All contracts are frozen.
* The customer is suspended.
* The section requires members.

### “Why did a member lose access temporarily?”

Check:

* Contract freeze dates.
* Suspension status.
* Plan changes.
* Billing state.

### “Why does content differ between locations?”

Check:

* Location visibility rules.
* Network vs location scope.
* Current location context.

## Key Takeaway

Membership in Nexudus is contract-driven. All users are customers, but only customers with active contracts are members.

The Members Portal reflects the current state of contracts, permissions, suspensions, freezes, and configuration — not just who the user is.

If something doesn’t appear or work as expected, the answer almost always lives in the Admin Panel or contract state.


# Configure your Location
Source: https://learn.nexudus.com/get-started/quick-starts/configure-location

Set up your coworking space location details in Nexudus to enable members to see accurate information about your facility

## Overview

Configuring your location details is one of the first steps when setting up Nexudus. These details form the foundation of your members' experience, from how they see your space online to how they interact with your booking systems and operations.

In this guide, you'll learn how to add your location's basic information, contact details, address, and branding elements that appear throughout the members portal and administrative interface.

<Note>
  You'll need administrator access to configure location settings. If you don't have the required permissions, contact
  your location administrator.
</Note>

## Configure Location Details

<Steps>
  <Step title="Configure Name & Logo">
    Navigate to [Name & Logo Settings](https://dashboard.nexudus.com/settings/0/0/0) in your Nexudus dashboard.

    Complete the following fields:

    * **Location name**: The official name of your coworking space

    * **Main logo**: Upload your location's logo that appears in portal headers and documents

    * **Main banner**: Upload a banner image for your location

    <Tip>
      High-quality logos (JPG or PNG at least 300x300px for the logo and 1280x600px for the banner) provide the best appearance across different devices and contexts. The primary color of your logo will be used as the primary color throughout the portal.
    </Tip>
  </Step>

  <Step title="Add Contact & Location Details">
    Complete the [Contact & Location Details section](https://dashboard.nexudus.com/settings/0/0/0) to set your contact
    information and address: - **Website**: Your location's website URL - **Email**: Contact email address for your
    location - **Phone**: Main phone number for customer inquiries - **Fax**: Fax number (if applicable) - **Location
    address**: Search and select your physical address using the address lookup - **Country**: Select your country -
    **Postal address**: Complete postal address of your location - **State / Province / Region**: Your state, province, or
    region - **City**: City where your location is based - **Zip / Post code**: Your postal or ZIP code

    <Check>
      Verify the address is complete and accurate. Members use this information to find your location and view you on the
      map.
    </Check>
  </Step>

  <Step title="Set Location Map Coordinates">
    Configure the [Location Map section](https://dashboard.nexudus.com/settings/0/0/0) to pinpoint your exact location on
    the map. - Use the interactive map to drag the location pin to the exact coordinates of your space - Members will see
    this map on your contact page to find your location
  </Step>

  <Step title="Configure Invoice Details">
    Go to [Invoice Details](https://dashboard.nexudus.com/settings/1/0/0) to set up billing information for invoices: -
    **Company / trading name**: Legal company name (may differ from location name) - **Billing address**: Complete billing
    address for invoices - **City**: City for billing - **ZIP / Postcode**: Postal code for billing - **Country**:
    Country for tax and legal compliance

    <Warning>
      Ensure billing information matches your legal business entity, as this is used for invoicing and financial
      reporting. These details will appear on all invoices issued to customers.
    </Warning>
  </Step>

  <Step title="Customize Appearance">
    Configure how your portal looks by visiting [Appearance Settings](https://dashboard.nexudus.com/settings/2/0/0): -
    **Domain**: The web address for your portal - **Primary color**: Main color used throughout the interface -
    **Secondary color**: Secondary color for accents - **Portal version**: Select your preferred portal experience -
    **Display this location in your website and the app**: Toggle to show/hide this location in public directories
    <Tip>Your primary color should complement your logo's primary color for a cohesive branded experience.</Tip>
  </Step>

  <Step title="Set Primary Currency">
    Navigate to [Primary Currency Settings](https://dashboard.nexudus.com/settings/1/1/0) to configure your billing
    currency: - **Primary currency**: Select the currency for all invoices issued by this location - Items priced in
    different currencies will be automatically converted using live exchange rates

    <Note>
      This is the currency used for all financial transactions and invoicing. You can set a secondary currency separately
      if you process payments in a different currency.
    </Note>
  </Step>

  <Step title="Review and Save">
    Review all entered information for accuracy, then click **Save** to apply your changes.

    Your location details are now configured and will be visible to members in the portal.
  </Step>
</Steps>

## Additional Location Configuration

Once you've set up basic details, you may want to configure these related settings:

<AccordionGroup>
  <Accordion title="Operating Hours">
    Set your location's [operating hours](/get-started/quick-starts/opening-hours) to help members understand when your space is available. This controls booking availability and appears in member-facing information.
  </Accordion>

  <Accordion title="Member Portal Customization">
    Customize the [member portal experience](https://dashboard.nexudus.com/settings/business/portal) including homepage
    text, featured sections, and available features.
  </Accordion>

  <Accordion title="Terms and Policies">
    Set your [terms, conditions, and policies](https://dashboard.nexudus.com/settings/business/legal) that members accept when joining.
  </Accordion>
</AccordionGroup>


# Configure Opening Hours
Source: https://learn.nexudus.com/get-started/quick-starts/opening-hours

Set your location's operating hours and manage booking availability exceptions in Nexudus

## Overview

Setting your location's opening hours tells members when your coworking space is available for visits. These hours are **informational only** and appear throughout the portal to help members plan their visits—they do **not** prevent members from booking resources.

To actually prevent bookings during specific dates or times (such as holidays or maintenance periods), use **booking availability exceptions**. These exceptions actively block members from selecting those dates when making reservations.

<Note>
  You'll need administrator access to configure opening hours. If you don't have the required permissions, contact your
  location administrator.
</Note>

## Configure Opening Hours

<Steps>
  <Step title="Access Opening Times Settings">
    Navigate to [Opening Times Settings](https://dashboard.nexudus.com/settings/0/0/1) in your Nexudus dashboard.

    Click **Settings** in the main menu, then select your location from the location selector if you manage multiple spaces.
  </Step>

  <Step title="Set Daily Operating Hours">
    Configure the [Opening times section](https://dashboard.nexudus.com/settings/0/0/1) to define your regular schedule: -
    **Days of the week**: Select each day your location operates - **Opening time**: Set the time your location opens
    (e.g., 8:00 AM) - **Closing time**: Set the time your location closes (e.g., 6:00 PM) - **Closed days**: Mark any days
    your location is not open (e.g., Sundays)

    <Warning>
      Opening times are **informational only** and do not prevent bookings. Members can still book resources at any time,
      even outside these hours. If you need to block bookings during specific periods, use booking availability exceptions
      instead.
    </Warning>

    <Tip>
      Display accurate opening hours to help members understand when your location is staffed and available for them to
      visit.
    </Tip>
  </Step>

  <Step title="Define Booking Availability Exceptions">
    Use the [Booking availability exceptions section](https://dashboard.nexudus.com/settings/0/0/1) to manage dates when
    your location or resources are unavailable and you want to **prevent bookings**: - **Exception name**: Give your
    exception a descriptive name (e.g., "Summer closure" or "Annual maintenance") - **Start date**: The first date of the
    unavailability - **End date**: The last date of the unavailability - **Apply to**: Choose whether this affects: - Your
    entire location - Specific resources or areas

    <Warning>
      Booking availability exceptions **actively block** members from booking during the specified dates. Unlike opening
      times (which are informational), exceptions prevent reservations from being made.
    </Warning>

    <Tip>
      Use exceptions for dates when you cannot accommodate bookings, such as holidays, emergency closures, or scheduled
      maintenance.
    </Tip>
  </Step>

  <Step title="Add Multiple Exceptions">
    Create separate exceptions for each closure or maintenance period: - Click the **Add exception** button to create a
    new entry - Fill in the details for each exception period - Save each exception individually

    <Tip>
      Plan ahead by adding exceptions for known holidays, planned maintenance, or seasonal closures well in advance.
    </Tip>
  </Step>

  <Step title="Review and Save">
    Review all opening hours and exceptions for accuracy, then click **Save** to apply your changes.

    Your schedule is now live and will be visible to members in the portal.

    <Check>
      Verify that your opening hours and exceptions appear correctly on the member-facing contact page and in the booking calendar.
    </Check>
  </Step>
</Steps>

## Best Practices

**Set opening times for visibility**

Configure your opening times to reflect when your location is staffed and available for member visits. These are informational and help members plan when to use the space.

**Use exceptions to block bookings**

Only use booking availability exceptions for dates when you truly cannot accommodate bookings (holidays, closures, maintenance). These actively prevent reservations.

**Account for transitions**

If your location has staggered hours (e.g., 7:00 AM on weekdays but 9:00 AM on weekends), set each day individually.

**Plan exceptions ahead**

Add booking availability exceptions for known holidays and planned closures at least 2-4 weeks in advance so members can plan accordingly.

**Communicate changes**

When you add exceptions, consider sending a notification to members so they're aware of the blackout dates and cannot accidentally book during those periods.

**Test your schedule**

After saving, visit the member portal and verify that your opening times display correctly on the contact page and that exceptions properly block dates on the booking calendar.

**Review regularly**

Periodically review your opening times and exceptions to ensure they remain accurate, especially if your schedule changes seasonally.


# Set up Resources Inventory
Source: https://learn.nexudus.com/get-started/quick-starts/set-resources-inventory

Configure your resources and floor plans to enable members to book spaces in your coworking location

## Overview

Setting up your essential inventory—resources and floor plans—is a critical step for getting your members portal ready for bookings. Resources are the bookable items in your location (desks, meeting rooms, parking spaces, etc.), and floor plans help members visualize and select specific locations within those resources.

This quick start guide points you to the detailed configuration pages. For complete information on setting up each element, see the full documentation linked in each section.

<Note>
  You'll need administrator access to configure resources and floor plans. If you don't have the required permissions, contact your location administrator.
</Note>

## Prerequisites

* Administrator account with access to bookings and resources settings

* Your location configured with name, address, and opening hours

* Understanding of what physical spaces and resources your location offers

* Information about resource types (desks, meeting rooms, parking, etc.)

## Set up Your Resources

Resources are the core of your bookable inventory. They represent everything members can reserve—from dedicated desks to meeting rooms to parking spaces.

### What You'll Configure

When setting up resources, you'll define:

* **Resource names and types**: Desks, meeting rooms, parking spaces, etc.

* **Capacity and features**: How many people can use the resource, what amenities it has

* **Pricing**: How much to charge for bookings (or if it's free)

* **Availability**: When the resource can be booked

* **Images and descriptions**: Visual and textual information about the resource

### Getting Started with Resources

Visit the [Resources configuration page](/operators/bookings-and-resources/resources) for complete step-by-step instructions on:

* Creating new resources

* Assigning resources to categories

* Setting up resource pricing

* Configuring availability rules

* Adding images and descriptions

<Tip>
  Start by creating at least one resource so members have something to book. You can add more resources and customize them later.
</Tip>

## Set up Your Floor Plans

Floor plans are optional but highly recommended. They provide a visual map of your location showing where specific resources (like desks) are located. Members can view your floor plan and click on a desk to book it directly.

### Why Use Floor Plans?

Floor plans help members:

* **Visualize your space**: See the layout of your location

* **Choose specific locations**: Select a desk or space based on preference or proximity

* **Understand capacity**: See how many spaces are available in each area

* **Plan their visits**: Know exactly where they'll be working

### What You'll Configure

When setting up floor plans, you'll define:

* **Floor plan image or map**: Upload a visual representation of your space

* **Floor levels**: If your location has multiple floors (ground floor, first floor, etc.)

* **Resource placement**: Assign specific resources to locations on the plan

* **Interactive elements**: Make resources clickable for booking

### Getting Started with Floor Plans

Visit the [Floor Plans configuration page](/operators/bookings-and-resources/floor-plans) for complete step-by-step instructions on:

* Uploading floor plan images

* Creating multiple floor levels

* Positioning resources on the plan

* Testing the interactive floor plan

* Publishing your floor plan

<Warning>
  Floor plans require a clear image or map of your space. If you don't have one available, you can create resources without floor plans and add floor plans later.
</Warning>

## Implementation Order

Follow this sequence to set up your inventory efficiently:

<Steps>
  <Step title="Create Basic Resources First">
    Visit [Resources](/operators/bookings-and-resources/resources) and create at least one resource (e.g., "Hot Desk", "Meeting Room A").

    This enables basic booking functionality even without floor plans.
  </Step>

  <Step title="Add Resource Details">
    Complete resource details including:

    * Resource type and capacity

    * Pricing (or mark as free)

    * Availability rules

    * Images and descriptions
  </Step>

  <Step title="Create Floor Plans (Optional)">
    Visit [Floor Plans](/operators/bookings-and-resources/floor-plans) to create visual representations of your space.

    This step is optional but recommended for better member experience.
  </Step>

  <Step title="Link Resources to Floor Plans">
    Assign your resources to specific locations on the floor plan.

    Members can then click on desks or rooms to book them directly.
  </Step>

  <Step title="Test Availability and Bookings">
    After configuring resources and floor plans:

    * Visit your members portal

    * Check that resources appear in the booking calendar

    * Verify floor plans display correctly (if used)

    * Test making a test booking to ensure the workflow is smooth
  </Step>
</Steps>


# What is Nexudus?
Source: https://learn.nexudus.com/get-started/what-is-nexudus

Discover the Nexudus platform and its key benefits for coworking operators.

# Introduction

Welcome to Nexudus, the all-in-one platform designed to empower coworking operators and help you create thriving, connected communities. Whether you're just starting your coworking journey or looking to optimize your operations, Nexudus provides the tools and insights you need to succeed.

## Overview

Nexudus is more than just a coworking management software—it's a comprehensive solution that streamlines your day-to-day operations, enhances member experiences, and drives growth for your space. Trusted by thousands of coworking spaces worldwide, Nexudus is your partner in building a vibrant and efficient coworking community.

### Key Benefits

* **Simplify Operations**: Automate bookings, billing, and member management, so you can focus on what matters most—your community.
* **Enhance Member Experience**: Provide your members with a seamless, user-friendly portal to manage their bookings, plans, and more.
* **Grow Your Business**: Leverage powerful analytics and marketing tools to attract new members and retain existing ones.
* **Integrate Seamlessly**: Connect Nexudus with your favorite tools and platforms, from payment gateways to access control systems.
* **Stay Flexible**: Customize Nexudus to fit your unique needs, whether you run a single coworking space or a global network.

<Check>
  By choosing Nexudus, you're joining a global community of coworking operators who are transforming the way people work
  and connect.
</Check>

### Member Portal

The Nexudus Member Portal is the heart of your coworking community. It allows members to:

* Book meeting rooms and desks
* Purchase plans and passes
* View invoices and make payments
* Connect with other members
* Much more...

### Admin Dashboard

The Admin Dashboard gives you full control over your coworking space. From here, you can:

* Manage bookings and resources
* Track revenue and expenses
* Communicate with members
* Configure settings and integrations
* Much more...

### Integrations

Nexudus integrates with a wide range of tools, including:

* Payment gateways like Stripe and PayPal
* Access control systems like Kisi and Salto
* Communication tools like Slack
* A open API-first architecture
* Many other integrations...


# Who is this for?
Source: https://learn.nexudus.com/get-started/who-is-this-for

Understand the intended audience for the Nexudus platform and its documentation.

# Who is this for?

## Overview

The Nexudus platform is designed to serve two primary audiences:

1. **Coworking Space Operators**: These are the administrators and managers responsible for setting up, configuring, and managing the Nexudus platform to run their coworking spaces efficiently.
2. **Members/Tenants**: These are the individuals or teams who use the coworking space and interact with the Members Portal to manage their bookings, plans, and other services.

## For Operators

As an operator, you should familiarize yourself with all sections of this documentation. The content is tailored to help you:

* Set up and configure your coworking space.
* Manage bookings, memberships, and financials.
* Understand the platform's features and how to customize them to suit your needs.
* Troubleshoot common issues and optimize your operations.

Operators are encouraged to explore both the **Operators** and **Members** sections to gain a comprehensive understanding of the platform. This will enable you to better support your members and ensure a seamless experience for everyone.

## For Members

As a member or tenant, your primary focus should be on the **Members** section of this documentation. This section provides guidance on:

* Navigating the Members Portal.
* Managing your bookings, plans, and invoices.
* Accessing community features like events, discussion boards, and announcements.
* Understanding your account settings and privacy options.

While members are welcome to explore other sections, the **Members** section is specifically designed to address your needs and questions.

## Summary

* **Operators**: Familiarize yourself with all content to effectively manage the platform and support your members.
* **Members**: Focus on the **Members** section to make the most of your experience with the Members Portal.


# Custom Access Control API
Source: https://learn.nexudus.com/integrations/access-control/custom-access-control-api

Integrate your own access control system with Nexudus using the Generic Access Control API.

The Custom Access Control API allows system integrators to connect any access control system to Nexudus. Instead of relying on a pre-built integration, you provide your own endpoints and Nexudus communicates with them to manage access groups and notify your system of changes.

## How it works

Nexudus maintains a mapping table that links resources, day passes, and floor plan items to access groups in your system. When a customer books a resource, purchases a day pass, or is assigned a desk through a contract, Nexudus determines which access groups they should belong to and notifies your system via a webhook.

The integration requires two components:

1. **Access Groups endpoint** — An endpoint you host that returns the list of access groups in your system. Nexudus calls this endpoint so operators can map Nexudus items to your access groups from the admin panel.
2. **Webhook receiver** — An endpoint you host that receives notifications from Nexudus whenever a customer's access groups change.

## Configuration

Configure the integration from the Nexudus admin panel at **Settings > Integrations > Custom ACS**:

| Field                              | Description                                                                         |
| ---------------------------------- | ----------------------------------------------------------------------------------- |
| **Access groups API endpoint**     | The URL of your endpoint that returns the list of access groups.                    |
| **Access groups API Access Token** | An optional bearer token Nexudus includes when calling your access groups endpoint. |
| **Webhook URL**                    | The HTTPS URL Nexudus calls to notify your system of access changes.                |
| **Webhook Bearer**                 | The bearer token Nexudus includes in webhook requests to your endpoint.             |

<Warning>
  The webhook URL must use HTTPS. Nexudus does not send webhook notifications to HTTP endpoints.
</Warning>

## Access Groups endpoint

You must provide an endpoint that returns the list of access groups available in your system. Nexudus calls this endpoint when an operator opens the access control configuration page in the admin panel.

### Request

Nexudus sends a `GET` request to your endpoint with the following headers:

| Header                        | Description                                                         |
| ----------------------------- | ------------------------------------------------------------------- |
| `Authorization`               | `Bearer <token>` — Included only if you configured an Access Token. |
| `X-Nexudus-Business-UniqueId` | The unique identifier of the Nexudus Location making the request.   |
| `X-Nexudus-User-UniqueId`     | The unique identifier of the admin user performing the action.      |

### Response

Your endpoint must return a JSON array of access group objects:

```json theme={null}
[
  {
    "Id": "group-1",
    "Name": "Main Entrance"
  },
  {
    "Id": "group-2",
    "Name": "Meeting Rooms"
  },
  {
    "Id": "group-3",
    "Name": "Executive Floor"
  }
]
```

Each object has two fields:

<ResponseField name="Id" type="string">
  A unique identifier for the access group in your system.
</ResponseField>

<ResponseField name="Name" type="string">
  A human-readable name displayed to operators in the Nexudus admin panel.
</ResponseField>

<Note>
  Nexudus enforces a 10-second timeout when calling your access groups endpoint. Make sure your endpoint responds within this limit.
</Note>

## Mapping access groups

Once Nexudus retrieves the list of access groups from your endpoint, operators can map them to Nexudus items from the admin panel. The following item types can be mapped:

* **Resources** — Bookable inventory such as meeting rooms, phone booths, and event spaces.
* **Day passes** — Time-limited passes that grant access to the Location.
* **Floor plan desks** — Desks assigned through contracts on a floor plan.

Each item can be assigned to one or more access groups. When a customer acquires one of these items, they are added to the corresponding access groups.

## Webhook notifications

Whenever a customer's access groups change, Nexudus sends a webhook notification to the URL you configured. Changes are triggered by:

* A customer purchasing or being assigned a day pass.
* A customer making or being added as a visitor to a resource booking (within 15 minutes of the booking start time).
* A customer's contract including assigned desks.
* A customer's day pass expiring or being revoked.
* A booking ending.
* A customer being deactivated.
* A customer checking in with a day pass.
* A team leader's contract desks being inherited by team members.

### Request

Nexudus sends a `POST` request to your webhook URL with the following headers:

| Header          | Description                                                  |
| --------------- | ------------------------------------------------------------ |
| `Authorization` | `Bearer <webhook_bearer>` — The bearer token you configured. |

### Payload

The webhook payload contains the customer's current access state:

```json theme={null}
{
  "time": "2025-01-15T10:30:00Z",
  "business": {
    "id": 123456,
    "name": "My Coworking Space",
    "uniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "coworker": {
    "id": 789012,
    "full_name": "Jane Smith",
    "email": "jane@example.com",
    "uniqueId": "f1e2d3c4-b5a6-7890-abcd-ef0987654321",
    "accessCardId": "CARD-001",
    "keyFobNumber": "FOB-123",
    "accessPincode": "1234"
  },
  "access_signature": "hash-of-current-access-state",
  "groups": ["group-1", "group-2"],
  "schedule": [
    {
      "group": "group-1",
      "expires_on": null
    },
    {
      "group": "group-2",
      "expires_on": "2025-01-15T12:00:00Z"
    }
  ]
}
```

<Accordion title="Payload field reference">
  | Field                    | Type             | Description                                                                                        |
  | ------------------------ | ---------------- | -------------------------------------------------------------------------------------------------- |
  | `time`                   | `string`         | ISO 8601 timestamp of when the notification was generated (UTC).                                   |
  | `business.id`            | `number`         | The Nexudus Location ID.                                                                           |
  | `business.name`          | `string`         | The name of the Location.                                                                          |
  | `business.uniqueId`      | `string`         | The unique identifier of the Location.                                                             |
  | `coworker.id`            | `number`         | The customer's Nexudus ID.                                                                         |
  | `coworker.full_name`     | `string`         | The customer's full name.                                                                          |
  | `coworker.email`         | `string`         | The customer's email address.                                                                      |
  | `coworker.uniqueId`      | `string`         | The customer's unique identifier.                                                                  |
  | `coworker.accessCardId`  | `string`         | The customer's access card identifier, if set.                                                     |
  | `coworker.keyFobNumber`  | `string`         | The customer's key fob number, if set.                                                             |
  | `coworker.accessPincode` | `string`         | The customer's access PIN code, if set.                                                            |
  | `access_signature`       | `string`         | A hash representing the customer's current access state.                                           |
  | `groups`                 | `string[]`       | The list of access group IDs the customer currently belongs to.                                    |
  | `schedule`               | `object[]`       | Detailed schedule showing each group and when access expires.                                      |
  | `schedule[].group`       | `string`         | The access group ID.                                                                               |
  | `schedule[].expires_on`  | `string \| null` | ISO 8601 expiration timestamp, or `null` if access does not expire (e.g. from an active contract). |
</Accordion>

### Access expiration rules

The `expires_on` field in the schedule varies depending on what grants access:

| Source                                               | Expiration                                                      |
| ---------------------------------------------------- | --------------------------------------------------------------- |
| Day pass                                             | The day pass expiration date, extended by 12 hours.             |
| Resource booking                                     | The booking end time.                                           |
| Desk in a contract                                   | `null` (no expiration while the contract is active).            |
| Team member inheriting from a team leader's contract | The contract renewal date, or `null` if no renewal date is set. |

When a customer belongs to a group through multiple sources (for example, a day pass and a booking), the latest expiration is used.

### Handling the webhook

Your webhook endpoint should:

1. **Respond with a `2xx` status code** to acknowledge receipt.
2. **Replace the customer's access groups** with the list provided in the `groups` array. This is a full replacement, not an incremental update.
3. **Use the `schedule` array** to set time-based access rules if your system supports them.

<Info>
  Nexudus sends a webhook notification on every access update, even if the customer's groups have not changed. Your system should handle idempotent updates gracefully.
</Info>

## Implementation checklist

<Steps>
  <Step title="Build the Access Groups endpoint">
    Create an HTTPS endpoint that returns a JSON array of `{"Id": "...", "Name": "..."}` objects representing your access groups.
  </Step>

  <Step title="Build the Webhook receiver">
    Create an HTTPS endpoint that accepts POST requests with the webhook payload described above and updates access in your system accordingly.
  </Step>

  <Step title="Configure Nexudus">
    In the Nexudus admin panel, navigate to **Settings > Integrations > Custom ACS** and enter your endpoint URLs and tokens.
  </Step>

  <Step title="Map access groups">
    Use the admin panel to map your access groups to Nexudus resources, day passes, and floor plan desks.
  </Step>

  <Step title="Test the integration">
    Assign a day pass to a test customer and verify that your webhook receives the expected notification with the correct access groups.
  </Step>
</Steps>


# Google Analytics
Source: https://learn.nexudus.com/integrations/google-analytics

Track how customers browse and purchase on your Members Portal using Google Analytics 4 or Google Tag Manager.

## Overview

The Members Portal can send page views and user events directly to your **Google Analytics 4** (GA4) property or your **Google Tag Manager** (GTM) container. This lets you measure how customers interact with your portal — from first visit through to signup, bookings, and purchases — using the same analytics tools you already know.

<Note>
  You can use **either** GA4 or GTM, but not both at the same time. If you enable GA4 while GTM is active, GTM will be automatically disabled.
</Note>

## Setup

1. Open the Nexudus admin panel and go to **Settings > Integrations > [Google Analytics](https://dashboard.nexudus.com/settings/integrations/googleanalytics4)**.
2. Enter your **Measurement ID** (starts with `G-`) for GA4, or your **Container ID** (starts with `GTM-`) for Google Tag Manager.
3. Save your changes.

The tracking code is injected automatically on every page of your Members Portal — no additional setup is required.

## What is tracked

### Page views

Every page your customers visit is automatically recorded as a `page_view` event in your GA4 property or GTM dataLayer. This happens on every navigation within the portal, including single-page transitions.

### GA4 event name mapping

Some portal events are mapped to GA4 recommended event names. The table below shows which portal events are renamed before being sent to GA4 / GTM. All other events are sent with their original name.

| Portal event                 | GA4 event name   |
| ---------------------------- | ---------------- |
| `signup_completed`           | `sign_up`        |
| `checkout_completed`         | `purchase`       |
| `booking_purchase_completed` | `purchase`       |
| `plan_purchase_completed`    | `purchase`       |
| `event_purchase_completed`   | `purchase`       |
| `checkout_booking_start`     | `begin_checkout` |
| `login_success`              | `login`          |

***

## Event reference

### Signup funnel

<AccordionGroup>
  <Accordion title="signup_start">
    **When fired:** Customer lands on the signup/checkout page.

    | Property   | Description                                                    |
    | ---------- | -------------------------------------------------------------- |
    | `referrer` | The referring URL that brought the customer to the signup page |
  </Accordion>

  <Accordion title="signup_form_started">
    **When fired:** The signup form step loads for the first time.

    No payload.
  </Accordion>

  <Accordion title="signup_form_submitted">
    **When fired:** Customer submits the main signup form with their personal details.

    No payload.
  </Accordion>

  <Accordion title="signup_form_additional_submitted">
    **When fired:** Customer submits the additional information form during signup (when extra fields are configured).

    No payload.
  </Accordion>

  <Accordion title="signup_form_einvoicing_submitted">
    **When fired:** Customer completes the e-invoicing settings step during signup.

    No payload.
  </Accordion>

  <Accordion title="signup_plan_selected">
    **When fired:** Customer selects a membership plan from the plan list.

    | Property     | Description                                                                            |
    | ------------ | -------------------------------------------------------------------------------------- |
    | `plan_name`  | Name of the selected plan                                                              |
    | `plan_price` | Price of the selected plan                                                             |
    | `plan_id`    | ID of the selected plan                                                                |
    | `plan_type`  | Type of the plan (e.g. recurring, one-off). Only included for plans with a tariff type |
  </Accordion>

  <Accordion title="signup_store_viewed">
    **When fired:** The add-on products step loads during signup.

    No payload.
  </Accordion>

  <Accordion title="signup_store_item_added">
    **When fired:** Customer increases the quantity of an add-on product.

    | Property        | Description               |
    | --------------- | ------------------------- |
    | `product_name`  | Name of the product added |
    | `product_price` | Price of the product      |
  </Accordion>

  <Accordion title="signup_proposal_accepted">
    **When fired:** Customer accepts the proposal/terms and confirms.

    No payload.
  </Accordion>

  <Accordion title="signup_signature_completed">
    **When fired:** Customer completes the e-signature for the proposal document.

    No payload.
  </Accordion>

  <Accordion title="signup_payment_started">
    **When fired:** The payment step loads during signup.

    | Property         | Description                                           |
    | ---------------- | ----------------------------------------------------- |
    | `payment_method` | The pre-selected payment method shown to the customer |
  </Accordion>

  <Accordion title="signup_completed — GA4: sign_up">
    **When fired:** Customer reaches the signup confirmation page after completing all steps.

    | Property         | Description                            |
    | ---------------- | -------------------------------------- |
    | `plan_name`      | Name of the purchased plan             |
    | `payment_method` | Payment method used                    |
    | `value`          | Invoice due amount                     |
    | `currency`       | Currency code (e.g. `USD`, `EUR`)      |
    | `utm_source`     | UTM source (if present on landing URL) |
    | `utm_medium`     | UTM medium (if present)                |
    | `utm_campaign`   | UTM campaign (if present)              |
    | `utm_term`       | UTM term (if present)                  |
    | `utm_content`    | UTM content (if present)               |
  </Accordion>
</AccordionGroup>

### Checkout — starting a purchase

<AccordionGroup>
  <Accordion title="checkout_booking_start — GA4: begin_checkout">
    **When fired:** Customer opens the booking checkout page and the resource details load.

    | Property               | Description                              |
    | ---------------------- | ---------------------------------------- |
    | `resource_id`          | ID of the resource being booked          |
    | `resource_name`        | Name of the resource                     |
    | `resource_type`        | Resource type name (e.g. "Meeting Room") |
    | `system_resource_type` | System resource type identifier          |
  </Accordion>

  <Accordion title="checkout_product_start">
    **When fired:** Customer opens the product checkout page and the product details load.

    | Property       | Description                    |
    | -------------- | ------------------------------ |
    | `product_name` | Name of the product            |
    | `product_type` | System product type identifier |
    | `product_id`   | ID of the product              |
  </Accordion>

  <Accordion title="checkout_event_start">
    **When fired:** Customer opens the event ticket checkout page and the event details load.

    | Property     | Description       |
    | ------------ | ----------------- |
    | `event_name` | Name of the event |
    | `event_id`   | ID of the event   |
  </Accordion>

  <Accordion title="checkout_course_start">
    **When fired:** Customer opens the course checkout page and the course details load.

    | Property      | Description         |
    | ------------- | ------------------- |
    | `course_name` | Title of the course |
    | `course_id`   | ID of the course    |
  </Accordion>
</AccordionGroup>

### Checkout — payment and completion

<AccordionGroup>
  <Accordion title="checkout_payment_submitted">
    **When fired:** Customer submits a payment form. Fired for each payment method (invoice, Stripe, Spreedly, PayPal).

    | Property         | Description                                                       |
    | ---------------- | ----------------------------------------------------------------- |
    | `payment_method` | Payment method used: `invoice`, `stripe`, `spreedly`, or `paypal` |
    | `checkout_type`  | Type of checkout (only for invoice payments)                      |
    | `value`          | Amount being paid                                                 |
    | `currency`       | Currency code                                                     |
  </Accordion>

  <Accordion title="checkout_completed — GA4: purchase">
    **When fired:** Payment is processed and the confirmation page loads. Fired once per checkout regardless of items.

    | Property        | Description                                         |
    | --------------- | --------------------------------------------------- |
    | `checkout_type` | `booking`, `event`, `tariff`, `product`, or `other` |
    | `value`         | Invoice total amount                                |
    | `currency`      | Currency code                                       |
    | `utm_source`    | UTM source (if present on landing URL)              |
    | `utm_medium`    | UTM medium (if present)                             |
    | `utm_campaign`  | UTM campaign (if present)                           |
    | `utm_term`      | UTM term (if present)                               |
    | `utm_content`   | UTM content (if present)                            |
  </Accordion>

  <Accordion title="booking_purchase_completed">
    **When fired:** A booking purchase completes successfully. Fired once per booking in the invoice. Can occur via checkout (payment required) or directly (no payment due).

    | Property               | Description                                                   |
    | ---------------------- | ------------------------------------------------------------- |
    | `value`                | Invoice total amount                                          |
    | `currency`             | Currency code                                                 |
    | `method`               | `checkout` (via payment flow) or `direct` (no payment needed) |
    | `coworker_id`          | ID of the customer                                            |
    | `booking_id`           | ID of the booking                                             |
    | `resource_id`          | ID of the booked resource                                     |
    | `resource_name`        | Name of the booked resource                                   |
    | `resource_type`        | Resource type name                                            |
    | `system_resource_type` | System resource type (direct bookings only)                   |
    | `from_time`            | Booking start time                                            |
    | `to_time`              | Booking end time                                              |
    | `utm_*`                | UTM parameters (if present on landing URL)                    |
  </Accordion>

  <Accordion title="event_purchase_completed — GA4: purchase">
    **When fired:** An event ticket purchase completes successfully. Fired once per attendee in the invoice. Can occur via checkout or directly.

    | Property             | Description                                |
    | -------------------- | ------------------------------------------ |
    | `value`              | Invoice total amount                       |
    | `currency`           | Currency code                              |
    | `method`             | `checkout` or `direct`                     |
    | `coworker_id`        | ID of the customer                         |
    | `event_id`           | ID of the event                            |
    | `event_name`         | Name of the event                          |
    | `event_product_name` | Name of the ticket type (checkout only)    |
    | `attendee_id`        | ID of the attendee record (checkout only)  |
    | `location`           | Event location (direct only)               |
    | `utm_*`              | UTM parameters (if present on landing URL) |
  </Accordion>

  <Accordion title="plan_purchase_completed — GA4: purchase">
    **When fired:** A plan purchase completes successfully. Fired once per contract in the invoice. Can occur via checkout or directly.

    | Property      | Description                                |
    | ------------- | ------------------------------------------ |
    | `value`       | Invoice total amount                       |
    | `currency`    | Currency code                              |
    | `method`      | `checkout` (checkout purchases only)       |
    | `coworker_id` | ID of the customer (checkout only)         |
    | `contract_id` | ID of the contract (checkout only)         |
    | `tariff_name` | Name of the plan (checkout only)           |
    | `tariff_id`   | ID of the plan (checkout only)             |
    | `tariff_type` | Plan type (checkout only)                  |
    | `start_date`  | Contract start date (checkout only)        |
    | `utm_*`       | UTM parameters (if present on landing URL) |
  </Accordion>

  <Accordion title="product_purchase_completed">
    **When fired:** A product purchase completes successfully. Fired once per product in the invoice. Can occur via checkout or directly.

    | Property       | Description                                |
    | -------------- | ------------------------------------------ |
    | `value`        | Invoice total amount                       |
    | `currency`     | Currency code                              |
    | `method`       | `checkout` or `direct`                     |
    | `coworker_id`  | ID of the customer                         |
    | `product_id`   | ID of the product                          |
    | `product_name` | Name of the product                        |
    | `product_type` | System product type                        |
    | `quantity`     | Quantity purchased (checkout only)         |
    | `utm_*`        | UTM parameters (if present on landing URL) |
  </Accordion>
</AccordionGroup>

### Guest checkout

<AccordionGroup>
  <Accordion title="guest_checkout_started">
    **When fired:** Customer clicks "Continue as guest" to proceed without signing in.

    | Property        | Description                                |
    | --------------- | ------------------------------------------ |
    | `checkout_type` | `course`, `product`, `booking`, or `other` |
  </Accordion>

  <Accordion title="guest_account_created">
    **When fired:** Guest customer creates a permanent account after completing their purchase.

    No payload.
  </Accordion>

  <Accordion title="guest_checkout_completed">
    **When fired:** Guest customer's checkout is confirmed and payment succeeds.

    | Property        | Description                                         |
    | --------------- | --------------------------------------------------- |
    | `checkout_type` | `booking`, `event`, `tariff`, `product`, or `other` |
    | `value`         | Invoice total amount                                |
    | `currency`      | Currency code                                       |
    | `utm_*`         | UTM parameters (if present on landing URL)          |
  </Accordion>
</AccordionGroup>

### Bookings

<AccordionGroup>
  <Accordion title="booking_created">
    **When fired:** Customer creates a new booking (before payment, if any is required).

    | Property               | Description                     |
    | ---------------------- | ------------------------------- |
    | `coworker_id`          | ID of the customer              |
    | `resource_id`          | ID of the booked resource       |
    | `resource_name`        | Name of the booked resource     |
    | `resource_type`        | Resource type name              |
    | `system_resource_type` | System resource type identifier |
    | `date`                 | Start date/time of the booking  |
  </Accordion>

  <Accordion title="booking_modified">
    **When fired:** Customer modifies an existing booking (e.g. changes dates or times).

    | Property               | Description                                |
    | ---------------------- | ------------------------------------------ |
    | `coworker_id`          | ID of the customer                         |
    | `booking_id`           | ID of the booking                          |
    | `resource_id`          | ID of the booked resource                  |
    | `resource_name`        | Name of the booked resource                |
    | `resource_type`        | Resource type name                         |
    | `system_resource_type` | System resource type identifier            |
    | `from_time`            | New booking start time                     |
    | `to_time`              | New booking end time                       |
    | `utm_*`                | UTM parameters (if present on landing URL) |
  </Accordion>

  <Accordion title="instant_booking_initiated">
    **When fired:** Customer clicks the book button on a resource to start an instant booking.

    | Property     | Description        |
    | ------------ | ------------------ |
    | `resourceId` | ID of the resource |
  </Accordion>

  <Accordion title="instant_booking_confirmed">
    **When fired:** Customer confirms the instant booking in the confirmation dialog.

    | Property     | Description        |
    | ------------ | ------------------ |
    | `resourceId` | ID of the resource |
  </Accordion>

  <Accordion title="instant_booking_aborted">
    **When fired:** Customer dismisses the instant booking confirmation dialog without confirming.

    | Property     | Description        |
    | ------------ | ------------------ |
    | `resourceId` | ID of the resource |
  </Accordion>

  <Accordion title="booking_cancelled">
    **When fired:** Customer successfully cancels an existing booking.

    | Property     | Description                 |
    | ------------ | --------------------------- |
    | `booking_id` | ID of the cancelled booking |
  </Accordion>

  <Accordion title="predicted_booking_confirm_initiated">
    **When fired:** Customer clicks to confirm a system-suggested booking from their dashboard.

    | Property     | Description                  |
    | ------------ | ---------------------------- |
    | `resourceId` | ID of the suggested resource |
  </Accordion>

  <Accordion title="predicted_booking_confirmed">
    **When fired:** Customer confirms a system-suggested booking in the confirmation dialog.

    | Property     | Description        |
    | ------------ | ------------------ |
    | `resourceId` | ID of the resource |
  </Accordion>

  <Accordion title="predicted_booking_confirm_aborted">
    **When fired:** Customer dismisses the suggested booking confirmation dialog without confirming.

    | Property     | Description        |
    | ------------ | ------------------ |
    | `resourceId` | ID of the resource |
  </Accordion>
</AccordionGroup>

### Events and courses

<AccordionGroup>
  <Accordion title="event_registered">
    **When fired:** Customer registers for an event (before payment, if any is required).

    | Property     | Description       |
    | ------------ | ----------------- |
    | `event_name` | Name of the event |
  </Accordion>

  <Accordion title="event_cancelled">
    **When fired:** Customer cancels their registration for an event.

    | Property   | Description     |
    | ---------- | --------------- |
    | `event_id` | ID of the event |
  </Accordion>

  <Accordion title="course_enrolled">
    **When fired:** Customer enrols in a course (before payment, if any is required).

    | Property      | Description         |
    | ------------- | ------------------- |
    | `course_name` | Title of the course |
    | `course_id`   | ID of the course    |
  </Accordion>

  <Accordion title="lesson_completed">
    **When fired:** Customer finishes a lesson and marks it as complete.

    | Property    | Description             |
    | ----------- | ----------------------- |
    | `lesson_id` | Unique ID of the lesson |
    | `course_id` | ID of the parent course |
  </Accordion>

  <Accordion title="course_completed">
    **When fired:** Customer finishes all lessons and reaches the course completion page.

    | Property    | Description      |
    | ----------- | ---------------- |
    | `course_id` | ID of the course |
  </Accordion>
</AccordionGroup>

### Cart and basket

<AccordionGroup>
  <Accordion title="cart_viewed">
    **When fired:** Customer views the cart page with items in it.

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `item_count`   | Number of items in the cart            |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>

  <Accordion title="cart_empty_viewed">
    **When fired:** Customer views an empty cart page.

    No payload.
  </Accordion>

  <Accordion title="cart_item_added">
    **When fired:** An item is added to the cart.

    | Property    | Description                                              |
    | ----------- | -------------------------------------------------------- |
    | `item_type` | Type of item: `product`, `booking`, `event`, or `course` |
    | `item_id`   | ID of the item added                                     |
    | `item_name` | Name of the item                                         |
    | `quantity`  | Quantity added                                           |
  </Accordion>

  <Accordion title="cart_item_removed">
    **When fired:** An item is removed from the cart.

    | Property    | Description                                              |
    | ----------- | -------------------------------------------------------- |
    | `item_type` | Type of item: `product`, `booking`, `event`, or `course` |
    | `item_id`   | ID of the item removed                                   |
    | `item_name` | Name of the item                                         |
  </Accordion>

  <Accordion title="cart_item_quantity_updated">
    **When fired:** The quantity of a product in the cart is changed.

    | Property       | Description       |
    | -------------- | ----------------- |
    | `item_type`    | Type of item      |
    | `item_id`      | ID of the item    |
    | `item_name`    | Name of the item  |
    | `old_quantity` | Previous quantity |
    | `new_quantity` | New quantity      |
  </Accordion>

  <Accordion title="cart_checkout_started">
    **When fired:** Customer clicks "Proceed to checkout" from the cart page.

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `item_count`   | Number of items in the cart            |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>

  <Accordion title="cart_checkout_viewed">
    **When fired:** Customer views the cart checkout confirmation page.

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `item_count`   | Number of items in the cart            |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>

  <Accordion title="cart_purchase_completed">
    **When fired:** Cart checkout completes successfully (for purchases with payment due).

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `value`        | Total amount                           |
    | `currency`     | Currency code (e.g. `USD`, `EUR`)      |
    | `item_count`   | Number of items purchased              |
    | `coworker_id`  | ID of the customer                     |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>

  <Accordion title="cart_continue_shopping">
    **When fired:** Customer clicks "Continue shopping" from the cart page (potential cart abandonment).

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `item_count`   | Number of items left in the cart       |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>

  <Accordion title="discount_code_applied">
    **When fired:** Customer enters or applies a discount code in the cart or checkout.

    | Property        | Description                            |
    | --------------- | -------------------------------------- |
    | `discount_code` | The discount code entered              |
    | `utm_source`    | UTM source (if present on landing URL) |
    | `utm_medium`    | UTM medium (if present)                |
    | `utm_campaign`  | UTM campaign (if present)              |
    | `utm_term`      | UTM term (if present)                  |
    | `utm_content`   | UTM content (if present)               |
  </Accordion>

  <Accordion title="checkout_continue_to_payment">
    **When fired:** Customer clicks "Continue to payment" to scroll to the payment section.

    | Property       | Description                            |
    | -------------- | -------------------------------------- |
    | `utm_source`   | UTM source (if present on landing URL) |
    | `utm_medium`   | UTM medium (if present)                |
    | `utm_campaign` | UTM campaign (if present)              |
    | `utm_term`     | UTM term (if present)                  |
    | `utm_content`  | UTM content (if present)               |
  </Accordion>
</AccordionGroup>

### Products

<AccordionGroup>
  <Accordion title="product_added_to_basket">
    **When fired:** Customer adds a product to their basket (from the store or quick-buy flow).

    | Property        | Description          |
    | --------------- | -------------------- |
    | `product_name`  | Name of the product  |
    | `product_price` | Price of the product |
  </Accordion>
</AccordionGroup>

### Authentication

<AccordionGroup>
  <Accordion title="login_success — GA4: login">
    **When fired:** Customer signs in successfully with valid credentials.

    No payload.
  </Accordion>

  <Accordion title="login_failed">
    **When fired:** Customer attempts to sign in with invalid credentials.

    No payload.
  </Accordion>

  <Accordion title="oauth_login_clicked">
    **When fired:** Customer clicks a single sign-on (SSO) button on the sign-in page.

    | Property   | Description                                             |
    | ---------- | ------------------------------------------------------- |
    | `provider` | SSO provider: `google`, `okta`, `azure_ad`, or `openid` |
  </Accordion>

  <Accordion title="logout">
    **When fired:** Customer signs out of their account.

    No payload.
  </Accordion>

  <Accordion title="password_reset_requested">
    **When fired:** Customer submits the forgot-password form to request a password reset email.

    No payload.
  </Accordion>
</AccordionGroup>

### Profile and account

<AccordionGroup>
  <Accordion title="profile_updated">
    **When fired:** Customer saves changes to their personal information.

    No payload.
  </Accordion>

  <Accordion title="billing_details_updated">
    **When fired:** Customer saves changes to their billing information.

    No payload.
  </Accordion>

  <Accordion title="newsletter_subscribed">
    **When fired:** Customer subscribes to the newsletter from the articles page.

    No payload.
  </Accordion>
</AccordionGroup>

### Help desk

<AccordionGroup>
  <Accordion title="contact_us_submitted">
    **When fired:** Customer clicks the "Contact us" button to reach the help desk.

    No payload.
  </Accordion>

  <Accordion title="support_ticket_created">
    **When fired:** Customer creates a new support ticket.

    No payload.
  </Accordion>

  <Accordion title="support_ticket_replied">
    **When fired:** Customer replies to an existing support ticket.

    No payload.
  </Accordion>

  <Accordion title="support_ticket_closed">
    **When fired:** Customer closes an open support ticket.

    No payload.
  </Accordion>
</AccordionGroup>

### Forms

<AccordionGroup>
  <Accordion title="form_submitted">
    **When fired:** Customer submits a custom form page.

    | Property    | Description           |
    | ----------- | --------------------- |
    | `form_id`   | Unique ID of the form |
    | `form_name` | Name of the form      |
  </Accordion>
</AccordionGroup>

### Session and navigation

<AccordionGroup>
  <Accordion title="app_session_start">
    **When fired:** The Members Portal application loads for the first time.

    No payload.
  </Accordion>

  <Accordion title="authenticated_session_start">
    **When fired:** A signed-in customer's session begins (after authentication is confirmed).

    | Property      | Description            |
    | ------------- | ---------------------- |
    | `coworker_id` | ID of the customer     |
    | `user_id`     | ID of the user account |
  </Accordion>

  <Accordion title="guest_session_start">
    **When fired:** An anonymous visitor's session begins (not signed in).

    No payload.
  </Accordion>

  <Accordion title="section_public_entered">
    **When fired:** Customer navigates to a public-facing page (landing, resource list, events, etc.).

    No payload.
  </Accordion>

  <Accordion title="section_auth_entered">
    **When fired:** Customer navigates to the sign-in or authentication pages.

    No payload.
  </Accordion>

  <Accordion title="section_dashboard_entered">
    **When fired:** Customer navigates to their personal dashboard.

    No payload.
  </Accordion>

  <Accordion title="section_location_entered">
    **When fired:** Customer navigates to a location-specific page.

    No payload.
  </Accordion>

  <Accordion title="section_course_entered">
    **When fired:** Customer navigates to a course page.

    No payload.
  </Accordion>

  <Accordion title="section_admin_entered">
    **When fired:** An admin user navigates to the admin section of the portal.

    No payload.
  </Accordion>
</AccordionGroup>

***

## UTM attribution

The Members Portal automatically captures UTM parameters (`utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content`) from the landing URL. These are included as properties on conversion events such as `signup_completed`, `checkout_completed`, `booking_purchase_completed`, `plan_purchase_completed`, `event_purchase_completed`, `product_purchase_completed`, and `guest_checkout_completed`.

This means you can track which marketing campaigns are driving signups and purchases without any additional configuration.

## Analytics in embedded widgets

When you embed the Members Portal into your marketing website using [widget embedding](/operators/portal-configuration/widget-embedding), Google Analytics continues to work automatically — no extra configuration is needed. However, there are some differences in how data is collected compared to the standalone portal.

### How it works

Modern browsers restrict third-party cookies when content is loaded inside a cross-origin iframe (which is the case when your portal is embedded on a different domain). Since GA4 normally relies on cookies to identify returning visitors, the portal automatically switches to a **cookieless tracking mode** when embedded.

In this mode:

* All events and page views are still sent to your GA4 property or GTM container
* A temporary session identifier is generated for each visit, so events within a single session are grouped correctly
* Cross-session visitor recognition (e.g. "returning user") is not available because the browser blocks the persistent cookies GA4 uses for this

### Automatic upgrade on interaction

After a customer interacts with the embedded portal (e.g. clicks a booking button), the portal automatically requests cookie access from the browser using the Storage Access API. If the browser grants access, GA4 upgrades to full cookie-based tracking for the remainder of the session, restoring returning-visitor recognition.

This happens silently and requires no action from you or your customers.

### What this means for your reports

| Metric                        | Standalone portal | Embedded widget             |
| ----------------------------- | ----------------- | --------------------------- |
| Event tracking                | Full              | Full                        |
| Page views                    | Full              | Full                        |
| Session grouping              | Full              | Full                        |
| Returning visitor recognition | Full              | Limited (until interaction) |
| UTM attribution               | Full              | Full                        |

<Note>
  If you need full returning-visitor recognition from the first page load, direct customers to your standalone portal domain instead of using the embedded widget for those flows.
</Note>

## GA4 vs GTM — which should I use?

|                      | GA4 (Measurement ID)           | GTM (Container ID)                       |
| -------------------- | ------------------------------ | ---------------------------------------- |
| **Best for**         | Simple setup, direct analytics | Advanced tag management, multiple tools  |
| **Setup effort**     | Minimal — paste your ID        | Requires GTM container configuration     |
| **Custom tags**      | No                             | Yes — add Facebook Pixel, LinkedIn, etc. |
| **Event forwarding** | Automatic                      | Automatic via dataLayer                  |

If you only need Google Analytics, use the GA4 Measurement ID. If you need to manage multiple marketing tags or apply custom triggers, use Google Tag Manager.


# Nexudus Network Bridge
Source: https://learn.nexudus.com/integrations/network-bridge

Understand how the Nexudus Network Bridge securely connects your Location's on-premise systems to the cloud-based Nexudus platform.

## Overview

The Nexudus Network Bridge is a secure communication system that allows Nexudus to connect with systems and services installed on your Location's local network—without requiring VPNs, static IP addresses, or firewall port forwarding.

Think of the Bridge as a secure tunnel that lets Nexudus talk to printers, access control systems, building management systems, and other hardware that lives inside your network, while keeping your network safe and isolated.

## Why the Network Bridge Exists

Many coworking spaces use local systems that don't live in the cloud. These might include:

* **Printing systems** — PaperCut or other print management solutions
* **Access control** — Door locks and access management systems
* **Building systems** — HVAC, lighting, sensors, and other building automation
* **Accounting and finance** — Local invoicing or accounting software
* **Custom applications** — Business-specific tools running on your network

The challenge is that Nexudus (a cloud service) can't directly reach these local systems. They're intentionally hidden behind firewalls for security reasons. The Network Bridge solves this by:

* Creating a secure, one-way outbound connection from your local network to Nexudus
* Allowing Nexudus to request data or actions from your local systems
* Keeping your network isolated and secure—no inbound connections needed
* Eliminating the need for complex networking setups

## Who Needs the Network Bridge

The Network Bridge is essential if you:

* Use **local printing systems** (like PaperCut) that you want to integrate with Nexudus billing
* Integrate with **local access control systems** that don't have native cloud connectivity
* Want to sync data between **local business systems** and your Nexudus Location
* Need **real-time communication** with on-premise hardware or software

If all your integrations are cloud-based (like cloud access control systems), you may not need the Bridge.

## How the Network Bridge Works

### The Basic Flow

1. **Bridge Agent Installation** — You install a small Bridge Agent application on a computer or server in your Location's network

2. **Secure Connection** — The Agent establishes a secure outbound connection to the Nexudus cloud, creating a persistent tunnel

3. **Request Handling** — When Nexudus needs to access a local system, it sends a request through the tunnel to the Agent

4. **Local Communication** — The Agent forwards the request to the local system (like PaperCut or your access control system)

5. **Response Delivery** — The local system responds, and the Agent sends the response back through the tunnel to Nexudus

6. **Connection Maintained** — The tunnel stays open continuously, so Nexudus can make requests whenever needed

### Why This Architecture is Secure

* **Outbound Only** — The connection is initiated from inside your network going outward. No inbound connections from the internet are needed.
* **Network Isolation** — Your firewall doesn't need any special rules or port forwarding. The Agent simply makes an outbound connection like any other application.
* **One-Way Control** — Only the Agent can initiate connections. Nexudus can only send requests through the established tunnel; it can't directly reach your network.
* **Encrypted Communication** — All data traveling through the tunnel is encrypted and secure.

## Setting Up the Network Bridge

### System Requirements

To use the Network Bridge, you need:

* A **Windows 64-bit (x64)** computer or server that runs continuously in your Location's network
* **No additional software required** — the Bridge is built on .NET 8.0 and includes all necessary runtime components (self-contained deployment)
* Administrator access to install the Agent service
* The local IP address and port of the system you want to connect to (for example, `http://192.168.1.100:9191` for PaperCut)
* Internet connectivity from the computer running the Agent

### Installation Overview

Setting up the Network Bridge requires three main steps:

<Steps>
  <Step title="Configure your local system">
    Ensure the system you want to integrate with (like PaperCut) is properly configured and accessible from within your network. You'll need:

    * The local IP address and port of the system
    * Any API keys or authentication credentials the system requires
    * Basic network access testing to confirm the system is reachable

    <Note>
      Specific configuration steps depend on which system you're integrating with. Refer to that system's setup guide for details.
    </Note>
  </Step>

  <Step title="Install and register the Bridge Agent">
    [Download](https://Nexuduscdneu.s3.eu-west-1.amazonaws.com/auto-updates/Nexudus.Coworking.Bridge/Nexudus.Coworking.Bridge.Client.exe) and run the Bridge Agent on a computer in your Location's network. You can run the Bridge Agent from any folder, but we recommend using `C:\NexudusBridge` for easier management. When you run it for the first time, it will:

    1. Generate a unique Device ID that identifies your location's installation
    2. Display this ID on the screen so you can copy it
    3. Open a connection to the Nexudus cloud (still in setup mode)

    You'll then register this Device ID in your Nexudus dashboard by going to [Settings → Devices](https://dashboard.nexudus.com/settings/4/7/0) and entering the Device ID using the "Register Device" button. This registration tells Nexudus to trust requests from this specific Agent installation.

    After registration, configure the Agent to point to the local system you want to connect to (for example, the IP address and port of your PaperCut server). Save this configuration, and the Agent is ready to connect. Do not use a trailing slash and ensure you use the correct schema (http\:// or https\://).
  </Step>

  <Step title="Enable the integration in Nexudus">
    In your Nexudus Location settings, enable the integration you want to use (for example, "PaperCut Bridge Integration"). You'll enter:

    * If the itegration reuires it, add the Bridge Device ID you registered earlier
    * If the integration requires a URL to connect to, use [https://bridge.nexudus.com/\{DEVICE\_ID}](https://bridge.nexudus.com/\{DEVICE_ID}). For example [https://bridge.nexudus.com/ABC1234...DEF](https://bridge.nexudus.com/ABC1234...DEF)
    * Any API keys or credentials required by the specific integration
    * Configuration options specific to that integration (like which product to use for charging, or which Location to sync)

    Once these settings are saved, Nexudus will begin communicating with your local system through the Bridge.
  </Step>

  <Step title="Install the Bridge as a Service">
    If the Bridge Agent is still running in the console, close it by pressing `Ctrl + C` in the terminal window.

    Next, install the Bridge Agent as a Windows Service so it runs automatically:

    1. Open a Command Prompt or PowerShell window with Administrator privileges.
    2. Navigate to the folder where the Bridge Agent is installed.
    3. Run the following command to install the service:
       ```
       Nexudus.Coworking.Bridge.Client.exe --install
       ```
    4. Start the service called "Nexudus Bridge Agent (device id)" from the services list.

    Once installed and started, the Bridge Agent will run in the background and automatically start whenever the computer restarts.
  </Step>
</Steps>

<Tip>
  Once configured, you should install the Agent as a Windows Service so it runs automatically whenever the computer starts. This ensures the connection is always available.
</Tip>

## Core Behavior

### Connection Reliability

The Network Bridge is designed to handle temporary network issues gracefully:

* **Automatic Reconnection** — If the Agent loses internet connectivity, it automatically reconnects to the Nexudus cloud when the connection is restored
* **Request Queuing** — If the tunnel is temporarily unavailable, requests are held and processed once the connection is restored
* **Fallback Handling** — If the local system is unavailable, the Agent returns an error, and Nexudus logs the failure for troubleshooting

### Multi-Agent Setups

You can run multiple Bridge Agents on the same computer or network, each connecting to a different local system:

* Each Agent gets its own Device ID and configuration
* Each must be installed in a separate folder
* All operate independently and can be configured differently
* Use different Device IDs for each Agent in your Nexudus settings

This is useful if you want to integrate with both PaperCut and a local access control system, for example.

### Data Synchronization

How frequently Nexudus communicates with local systems depends on the specific integration:

* **Periodic Syncing** — Some integrations (like PaperCut) run on a schedule (for example, every 60 minutes) to check for changes and keep systems in sync
* **Event-Driven Syncing** — Other integrations sync immediately when something changes in Nexudus (for example, when a customer buys printing credit)
* **Real-Time Updates** — Access control integrations typically provide immediate updates when customer access should change

The specific sync behavior for each integration is detailed in that integration's documentation.

## Key Interactions

### Access Control Integration

When the Network Bridge is used with access control systems:

* Customers are automatically added to or removed from access groups based on their active Plans and resource bookings
* Access is revoked immediately when a Plan expires or a booking ends
* Real-time occupancy check-ins may occur when customers unlock doors (depending on the access control system)

### Billing Integration

When the Network Bridge is used with systems like PaperCut:

* Customer account information is kept synchronized between Nexudus and the local system
* Credits allocated in Nexudus are synced to the local system, allowing customers to use them
* Overages are tracked and can trigger automatic billing in Nexudus
* Customer status changes (like when a Plan expires) are reflected in the local system

## Important Implications

### Network Access and Permissions

The Agent requires network access to the local system you're integrating with. Make sure:

* The computer running the Agent can reach the local system's IP address and port
* Any internal firewalls between the Agent computer and the local system allow communication
* The local system is configured to accept API requests (authentication keys, if required, are correctly entered)

### Agent Uptime

The Agent must run continuously for Nexudus to access your local systems. If the Agent is stopped or the computer is offline:

* Nexudus cannot communicate with your local systems
* Integrations may stop working until the Agent is restored
* Install the Agent as a Windows Service to ensure it starts automatically when the computer restarts

### Security and Access Keys

When setting up an integration:

* Store API keys and credentials securely—never share them publicly
* If you're providing troubleshooting data to Nexudus support, be careful not to expose sensitive authentication credentials
* Only the registered Device ID should be used in your Nexudus configuration; changing this invalidates the Agent registration

### Testing and Troubleshooting

After initial setup, verify the integration is working by:

* Checking the integration status in your Nexudus Location settings
* Performing a test action (for example, creating a test customer in PaperCut and checking if they appear in Nexudus, or vice versa)
* Reviewing integration logs in your Location settings to see if any errors occurred
* Ensuring the Agent computer is online and the local system is accessible

If issues occur, check that the Agent is running, has network access to both the local system and the internet, and that your configuration settings are correct.


# Authentication
Source: https://learn.nexudus.com/mcp/authentication

How the Nexudus MCP server authenticates your account and how to manage your session.

# Authentication

The Nexudus MCP server uses **OAuth 2.0** — the same standard used by "Sign in with Google" and similar flows. Your MCP client opens a browser, you sign in to Nexudus, and the server gives the client a short-lived token to use on your behalf.

## What you see as a user

1. You add `https://mcp.nexudus.com` to your MCP client.
2. The client opens a browser window with the Nexudus login page.
3. You enter your Nexudus **email and password**.
4. You **tick the responsibility disclaimer** to acknowledge that you understand what an AI assistant connected to your Nexudus account can do.
5. You **choose whether to share member personal data** with the AI assistant (see [PII redaction](/mcp/pii-redaction)).
6. The browser redirects back to your client.
7. Your AI assistant now has Nexudus tools available for the next **8 hours**.

You never share your password with the MCP client itself — only with the Nexudus login page that the browser opens. The MCP server is the only thing that ever sees your password, and only for the brief moment of verifying it.

<img alt="Nexudus MCP sign-in page with email and password fields, a responsibility disclaimer checkbox, and a checkbox to allow the AI assistant to see member personal data." />

## The two checkboxes on the login page

The Nexudus login page shows two checkboxes that you need to read before connecting.

### Responsibility disclaimer (required)

You must tick this box to sign in. It confirms that you understand:

* AI assistants connected through the server can **read, create, update, and delete** data in your Nexudus account on your behalf.
* AI behaviour is **not deterministic** and can produce unintended actions.
* You are responsible for **reviewing what the assistant does**.
* Anything you type into the AI client is sent to that provider under its own terms, **regardless of the PII setting** on the Nexudus side.
* Nexudus **cannot guarantee or be held liable** for actions taken by third-party AI assistants.

For practical guidance on living with these tradeoffs, see [Good practice](/mcp/good-practice).

### PII redaction (optional)

The second checkbox controls whether the AI assistant sees real personal data — member names, emails, phone numbers, addresses, and other personally identifiable information (PII).

* **Leave it unchecked** (the default) and PII is **replaced with safe tokens** before any response leaves the server.
* **Tick it** to send real PII to the AI provider in full.

The default is the safer option. See the dedicated [PII redaction](/mcp/pii-redaction) page for the full list of what gets redacted, when to turn it off, and how to switch the setting mid-conversation.

## What is stored

| Stored                                 | For how long                               | Where                 |
| -------------------------------------- | ------------------------------------------ | --------------------- |
| Your Nexudus email and password        | **Never stored** — used once and discarded | —                     |
| A short-lived Nexudus access token     | The lifetime of your session (8 hours)     | The MCP server memory |
| A signed token used by your MCP client | The lifetime of your session (8 hours)     | Your MCP client       |
| Your PII redaction choice              | The lifetime of your session (8 hours)     | Signed into the token |

The token the MCP client holds is a **signed wrapper** around the Nexudus access token. The client cannot read or use the underlying Nexudus token directly — it can only ask the MCP server to use it on the client's behalf. Your PII redaction choice is signed into that token, so it cannot be changed without re-authenticating.

## Permissions

The MCP server uses your own Nexudus account to make API calls, so it has exactly the same permissions you do. If your account can see five locations, the assistant can see five locations. If your account cannot delete invoices, the assistant cannot delete invoices either.

<Tip>
  The MCP server requires an **administrator** account to sign in. For sensitive workflows, consider creating a dedicated administrator scoped to only
  the locations and permissions you actually need, rather than connecting the MCP client with your full-access login. A generic **read-only mode** for
  administrator accounts is on the roadmap; once it ships, signing in with a read-only admin will limit the MCP server to reads as well.
</Tip>

## Session lifetime

A session lasts **8 hours** from the moment you sign in. After that, the next tool call returns an authentication error and your AI assistant will tell you the connection has expired. Reconnect from your client's connector settings — the steps are the same as the first time.

See [Sessions and re-authentication](/mcp/sessions) for more on what happens when a session ends.

## Disconnecting

To revoke access, disconnect the Nexudus connector inside your MCP client. The exact steps vary by client — see the [client setup pages](/mcp/connecting) for instructions. Disconnecting from the client invalidates the token immediately on the next request.

If you change your Nexudus password, any active MCP sessions stop working as soon as they next try to call the Nexudus API.

## Security notes

* **All traffic is encrypted** — the MCP server is only reachable over HTTPS.
* **Tokens are signed** — the wrapper token your MCP client holds is cryptographically signed by the server, so it cannot be forged or tampered with.
* **Tokens are short-lived** — even if a token were leaked, it expires in 8 hours.
* **No long-term storage of credentials** — your password is verified once and never persisted.
* **Account-scoped** — every action runs as your Nexudus account, with the same permissions and audit trail.

## Next steps

<CardGroup>
  <Card title="PII redaction" icon="user-shield" href="/mcp/pii-redaction">
    What gets redacted and how to flip the setting.
  </Card>

  <Card title="Good practice" icon="check" href="/mcp/good-practice">
    Do's, don'ts, and how to keep AI actions safe.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    What happens when your session expires.
  </Card>
</CardGroup>


# Connect from ChatGPT
Source: https://learn.nexudus.com/mcp/clients/chatgpt

How to connect the Nexudus MCP server to ChatGPT by enabling Developer mode and adding a custom MCP connector.

# Connect from ChatGPT

ChatGPT supports custom MCP servers through **Developer mode**, currently in beta. You enable Developer mode once on your account, add the Nexudus MCP server as a custom connector, and then toggle it on in any chat where you want to use it.

## Prerequisites

* A **ChatGPT** account on a paid plan — Developer mode is available on **Plus, Pro, Business, Enterprise, and Edu** at the time of writing. Free accounts cannot add custom MCP connectors.
* A **Nexudus** account with API access.
* A web browser.
* For **Business / Enterprise / Edu** workspaces: your workspace admin must have enabled **Developer mode / Create custom MCP connectors** under **Workspace Settings → Permissions & Roles → Connected Data**. If the option is missing in your personal settings, ask your admin to turn it on.

<Warning>
  Developer mode is a beta feature with elevated risk. It gives ChatGPT full read and write access to whichever MCP servers you connect, and OpenAI
  warns users to watch for prompt injection, malicious servers, and unintended write actions. Only add MCP servers you trust — `https://mcp.nexudus.com`
  is the official Nexudus server.
</Warning>

## Step 1 — Enable Developer mode

<Steps>
  <Step title="Open ChatGPT settings">
    Sign in to [chatgpt.com](https://chatgpt.com), open your profile menu, and choose **Settings**.
  </Step>

  <Step title="Open the Apps & Connectors section">
    In the settings sidebar, open **Apps & Connectors** (sometimes shown as **Connectors**).
  </Step>

  <Step title="Open Advanced settings">
    Scroll to the bottom of the connectors list and open **Advanced settings**.
  </Step>

  <Step title="Turn on Developer mode">
    Toggle **Developer mode** on. ChatGPT shows a warning about the risks of connecting unverified MCP servers — read it and confirm.
  </Step>
</Steps>

## Step 2 — Add the Nexudus connector

<Steps>
  <Step title="Create a new app">
    Back in **Apps & Connectors → Advanced settings**, click **Create** (sometimes labelled **Create app**) to add a custom MCP server.
  </Step>

  <Step title="Enter the Nexudus details">
    * **Name:** `Nexudus`
    * **MCP server URL:** `https://mcp.nexudus.com`
    * **Authentication:** OAuth (the default)
    * Tick **I understand and want to continue** to acknowledge the Developer mode risk notice.

    Save the connector.

    <img alt="ChatGPT 'New App' dialog with name 'Nexudus MCP Server', the MCP server URL, OAuth authentication, and the risk acknowledgement checkbox ticked." />
  </Step>

  <Step title="Sign in to Nexudus">
    ChatGPT opens a browser window to the Nexudus login page. Enter your Nexudus email and password and approve the connection. You are
    redirected back to ChatGPT, and the connector is marked **Connected**.

    <img alt="Nexudus sign-in page asking for email and password to authorise the MCP connection." />
  </Step>
</Steps>

## Step 3 — Enable the connector in a chat

Developer mode connectors are off by default in each new chat. To use Nexudus in a conversation:

1. Start a new chat.
2. Open the **Developer mode** tool menu at the bottom of the message box.
3. Toggle **Nexudus** on for the chat.

The composer's border turns **orange** to indicate Developer mode is active and that memory is paused for that chat. After this, ChatGPT can call the Nexudus tools when responding.

## Verify it works

In a chat with the connector enabled, ask:

> *"List my Nexudus locations."*

ChatGPT should call the Nexudus connector and return your locations. If it does not, see [Troubleshooting](/mcp/troubleshooting).

## Things to try

* *"Show me the bookings for today at my main location."*
* *"How many active members do I have?"*
* *"Find the contact named 'Smith' and show their email."*
* *"Update product 12345678 to set its price to £50."*

<Warning>
  ChatGPT can create, update, and delete real data through the connector. Always read the proposed action before confirming, especially for destructive
  operations like deletions or bulk updates. There is no undo button.
</Warning>

## Disconnect or re-authenticate

To disconnect, return to **Settings → Apps & Connectors → Advanced settings** and remove the Nexudus connector. To re-authenticate after the 8-hour
session expires, open the connector and choose **Reconnect** — ChatGPT walks you back through the login.

## Common issues

| Issue                                                        | Solution                                                                                              |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| "Create" button is missing in Advanced settings              | Developer mode is off — turn it on at **Settings → Apps & Connectors → Advanced settings**.           |
| Developer mode toggle is missing entirely                    | On a Business/Enterprise/Edu workspace, your admin needs to enable it under **Permissions & Roles**.  |
| ChatGPT does not see any Nexudus tools                       | Toggle the Nexudus connector on in the current chat's **Developer mode** menu — it is off by default. |
| ChatGPT reports it cannot reach Nexudus                      | Reconnect from Settings → Apps & Connectors. The 8-hour session may have expired.                     |
| The OAuth window does not appear                             | Disable pop-up blockers in your browser, then retry the connection.                                   |
| ChatGPT picks the wrong field name when creating or updating | Ask it to call `nexudus_describe_entity` first to fetch the field schema.                             |

For more, see [Troubleshooting](/mcp/troubleshooting).

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Connect from Claude.ai
Source: https://learn.nexudus.com/mcp/clients/claude-ai

How to connect the Nexudus MCP server to Claude.ai using the Connectors directory.

# Connect from Claude.ai

Claude.ai connects to MCP servers through its **Connectors** feature. The Nexudus MCP server appears as a custom connector you add once and reuse across chats.

## Prerequisites

* A **Claude.ai** account on a plan that supports custom connectors (Pro, Team, or Enterprise at the time of writing).
* A **Nexudus** account with API access.
* A web browser.

<Info>
  The Connectors feature is available on Claude.ai's paid plans. Free accounts cannot add custom MCP connectors. Check your plan on the Claude.ai
  billing page if you are unsure.
</Info>

## Add the Nexudus connector

<Steps>
  <Step title="Open Claude.ai settings">
    Sign in to [claude.ai](https://claude.ai), open the menu, and choose **Settings**.
  </Step>

  <Step title="Go to Connectors">
    In the settings sidebar, open **Connectors** (sometimes labelled **Integrations**).
  </Step>

  <Step title="Add a custom connector">
    Click **Add custom connector**. A dialog appears asking for a name and a remote MCP server URL.
  </Step>

  <Step title="Enter the Nexudus details">
    * **Name:** `Nexudus`
    * **Remote MCP server URL:** `https://mcp.nexudus.com`

    Save the connector.

    <img alt="Claude.ai 'Add custom connector' dialog with the name 'Nexudus MCP' and the URL https://mcp.nexudus.com filled in." />
  </Step>

  <Step title="Sign in to Nexudus">
    Claude.ai opens a browser window to the Nexudus login page. Enter your Nexudus email and password and approve the connection. You are
    redirected back to Claude.ai, and the connector is marked **Connected**.

    <img alt="Nexudus sign-in page asking for email and password to authorise the MCP connection." />
  </Step>
</Steps>

## Verify it works

Start a new chat and ask:

> *"List my Nexudus locations."*

Claude should call the Nexudus connector and return your locations. If it does not, see [Troubleshooting](/mcp/troubleshooting).

## Using the connector in chats

Once connected, the Nexudus tools are available in any chat. You don't need to enable the connector each time. Some prompts to try:

* *"Show me all upcoming bookings for my main location this week."*
* *"How many visitors are expected today?"*
* *"List all members whose contracts expire next month."*
* *"Create a new product called 'Day Pass' priced at £25 at my main location."*

<Warning>
  Claude.ai can create, update, and delete real data through the connector. Always read the proposed action before confirming, especially for
  destructive operations. There is no undo button.
</Warning>

## Disconnect or re-authenticate

To disconnect, return to **Settings → Connectors** and click **Disconnect** next to the Nexudus connector. To re-authenticate after the 8-hour session
expires, open the connector and choose **Reconnect** — Claude.ai walks you back through the login.

## Common issues

| Issue                                              | Solution                                                                                        |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| Claude says it cannot reach the Nexudus connector  | Open Settings → Connectors and click **Reconnect**. The session may have expired (8 hours).     |
| Claude lists no Nexudus tools                      | The connector finished registering but failed to load tools — disconnect and reconnect.         |
| Login redirects to a Nexudus error page            | Your Nexudus credentials may have changed. Try logging in directly at spaces.nexudus.com first. |
| Claude proposes the wrong field name when updating | Ask Claude to describe the entity first — *"Describe the 'products' entity before updating."*   |

For more, see [Troubleshooting](/mcp/troubleshooting).

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Connect from Claude Code
Source: https://learn.nexudus.com/mcp/clients/claude-code

How to connect the Nexudus MCP server to Claude Code, Anthropic's terminal-based AI assistant.

# Connect from Claude Code

Claude Code is Anthropic's terminal-based AI assistant. It supports remote MCP servers through the `/mcp` command.

## Prerequisites

* **Claude Code** installed and signed in — see [claude.ai/code](https://claude.ai/code).
* A **Nexudus** account with API access.
* A web browser available for the one-time login.

## Add the Nexudus server

Run Claude Code in any directory, then add the Nexudus MCP server:

```bash theme={null}
claude mcp add --transport http nexudus https://mcp.nexudus.com
```

This registers a new MCP server called **nexudus** that points at the hosted server. You only need to do this once per machine.

## Sign in

Inside Claude Code, run:

```
/mcp
```

You will see **nexudus** in the list of servers, marked as **needs authentication**. Select it and Claude Code opens your default browser to the
Nexudus login page. Sign in with your Nexudus email and password and approve the connection. The browser returns control to your terminal.

<img alt="Nexudus sign-in page asking for email and password to authorise the MCP connection." />

When you re-run `/mcp`, the **nexudus** server is now marked **connected** and the Nexudus tools are available.

## Verify it works

In your Claude Code session, ask:

> *"List my Nexudus locations."*

Claude Code should call the Nexudus server and return your locations.

## Things to try

* *"Show all bookings for today, grouped by location."*
* *"For each member with an overdue invoice, list their name and the invoice total."*
* *"Create a new visitor record for 'Jane Doe' visiting member 12345 at 2pm tomorrow."*
* *"Find every product priced above £100 and list them by location."*

<Warning>
  Claude Code can create, update, and delete real data through the server. For destructive operations, the assistant should confirm with you first
  — read its plan before approving.
</Warning>

## Remove the server

To remove the Nexudus server from Claude Code:

```bash theme={null}
claude mcp remove nexudus
```

## Re-authenticate

After the 8-hour session expires, run `/mcp` inside Claude Code, pick **nexudus**, and choose to reauthenticate. The browser flow runs again.

## Common issues

| Issue                                              | Solution                                                                               |
| -------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `claude mcp add` is not recognised                 | Make sure you are on a recent version of Claude Code. Run `claude --version` to check. |
| Browser does not open during sign-in               | Check Claude Code's logs for the manual URL and open it in your browser.               |
| Tools show as registered but fail with auth errors | Your 8-hour session has expired. Run `/mcp` and reauthenticate.                        |
| Tools missing from the catalogue                   | Run `/mcp` to check the server status — it may have disconnected.                      |

For more, see [Troubleshooting](/mcp/troubleshooting).

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Connect from Claude Desktop
Source: https://learn.nexudus.com/mcp/clients/claude-desktop

How to connect the Nexudus MCP server to Claude Desktop using a custom MCP connector.

# Connect from Claude Desktop

Claude Desktop is Anthropic's desktop application for Mac and Windows. It supports remote MCP servers through its custom connector settings.

## Prerequisites

* **Claude Desktop** installed on your machine — download from [claude.ai/download](https://claude.ai/download).
* A **Claude.ai** account signed in to the desktop app.
* A **Nexudus** account with API access.

## Add the Nexudus connector

<Steps>
  <Step title="Open settings">
    Open Claude Desktop. From the menu bar (macOS) or the in-app menu (Windows), choose **Settings**.
  </Step>

  <Step title="Go to Connectors">
    In the settings sidebar, open **Connectors**.
  </Step>

  <Step title="Add a custom connector">
    Click **Add custom connector**.
  </Step>

  <Step title="Enter the Nexudus details">
    * **Name:** `Nexudus`
    * **Remote MCP server URL:** `https://mcp.nexudus.com`

    Save.
  </Step>

  <Step title="Sign in to Nexudus">
    Claude Desktop opens your default browser to the Nexudus login page. Enter your Nexudus email and password and approve the connection. The
    browser redirects back to Claude Desktop, and the connector is marked **Connected**.

    <img alt="Nexudus sign-in page asking for email and password to authorise the MCP connection." />
  </Step>
</Steps>

## Verify it works

Start a new chat in Claude Desktop and ask:

> *"List my Nexudus locations."*

Claude Desktop should call the Nexudus connector and return your locations. If it does not, restart the app and retry — connectors are loaded at app startup.

## Things to try

* *"How many bookings do I have this week across all locations?"*
* *"Create a tentative booking for member John Doe in Meeting Room A from 2 to 3pm today."*
* *"Archive product 12345678."*
* *"List the visitors expected at my London location tomorrow."*

<Warning>
  Claude Desktop can create, update, and delete real data through the connector. Always read the proposed action before confirming.
</Warning>

## Resource support

Claude Desktop currently consumes MCP **tools** but not MCP **resources**. This means the Nexudus server's per-entity documentation is fetched
through the `nexudus_get_skill_guide` and `nexudus_get_entity_guide` tools rather than directly. You will see those tool calls in the response trace — this
is normal.

## Disconnect or re-authenticate

To disconnect, open **Settings → Connectors** and remove the Nexudus connector. To re-authenticate after the 8-hour session expires, reopen the
connector and choose **Reconnect**.

## Common issues

| Issue                                              | Solution                                                                |
| -------------------------------------------------- | ----------------------------------------------------------------------- |
| Connector appears but no tools are listed          | Restart Claude Desktop — tools are loaded at app startup.               |
| OAuth browser window does not open                 | Check that your default browser is set, then retry from settings.       |
| "Authentication required" errors mid-chat          | Your 8-hour session expired. Reconnect from settings.                   |
| Tools work but field names are guessed incorrectly | Ask Claude to describe the entity first with `nexudus_describe_entity`. |

For more, see [Troubleshooting](/mcp/troubleshooting).

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Connect from VS Code (GitHub Copilot)
Source: https://learn.nexudus.com/mcp/clients/vs-code

How to connect the Nexudus MCP server to GitHub Copilot in VS Code.

# Connect from VS Code (GitHub Copilot)

GitHub Copilot in VS Code supports MCP servers through the **MCP** settings in the Copilot extension. Once added, Copilot's chat panel can call Nexudus tools alongside its other capabilities.

## Prerequisites

* **VS Code** with the **GitHub Copilot** extension installed and signed in.
* A **GitHub Copilot** subscription that supports MCP servers (Business or Enterprise at the time of writing — check your plan in VS Code).
* A **Nexudus** account with API access.

## Add the Nexudus server

VS Code stores MCP server entries in a JSON config file. The easiest way to add Nexudus is via the command palette.

<Steps>
  <Step title="Open Agent Customizations">
    From the VS Code activity bar, open **Agent Customizations** (or run **MCP: Add Server** from the command palette with **Cmd/Ctrl + Shift + P**).
  </Step>

  <Step title="Add a new MCP server">
    In the **MCP Servers** section, click the **+** button to add a new server.
  </Step>

  <Step title="Choose the HTTP transport">
    From the list, select **HTTP (HTTP or Server-Sent Events)** — *"Connect to a remote HTTP server that implements the MCP protocol"*.

    <img alt="VS Code MCP server type picker with 'HTTP (HTTP or Server-Sent Events)' highlighted." />
  </Step>

  <Step title="Enter the Nexudus server URL">
    Paste `https://mcp.nexudus.com` into the **Enter Server URL** field and press **Enter**.

    <img alt="VS Code prompt to enter the MCP server URL, with https://mcp.nexudus.com filled in." />
  </Step>

  <Step title="Give it a name">
    When prompted, give the server a name (for example, `nexudus`). The server appears in the MCP Servers list once registered.

    <img alt="VS Code showing the configured Nexudus MCP server with name, type 'http', and the server URL." />
  </Step>

  <Step title="Approve the authentication">
    VS Code prompts you to allow the server to authenticate. Click **Allow**.

    <img alt="VS Code dialog: 'The MCP Server Definition wants to authenticate to mcp.nexudus.com.' with Allow and Cancel buttons." />
  </Step>

  <Step title="Sign in to Nexudus">
    VS Code opens your default browser to the Nexudus login page. Enter your Nexudus email and password and approve the connection. The
    browser redirects back to VS Code and the server appears as **Connected**.

    <img alt="Nexudus sign-in page asking for email and password to authorise the MCP connection." />
  </Step>
</Steps>

## Add manually via settings

If you prefer to edit the config directly, open the command palette and run **MCP: Open User Configuration**. Add an entry:

```json theme={null}
{
  "servers": {
    "nexudus": {
      "type": "http",
      "url": "https://mcp.nexudus.com"
    }
  }
}
```

Save the file. Then run **MCP: Reload Servers** from the command palette and sign in through the browser when prompted.

## Verify it works

Open the Copilot chat panel and ask:

> *"List my Nexudus locations."*

Copilot should call the Nexudus server. The chat panel shows the tool call and the response inline.

## Things to try

* *"Generate a CSV of all bookings for last week, one row per booking."*
* *"List the meeting rooms at my main location and their hourly rates."*
* *"Create a new event called 'Community Coffee' next Friday at 10am."*

<Warning>
  Copilot can create, update, and delete real data through the connector. Read the tool call before approving it, especially for deletions and bulk
  updates.
</Warning>

## Disconnect or re-authenticate

Open the command palette and run **MCP: Manage Servers** to remove or reconnect Nexudus. After the 8-hour session expires, Copilot's tool calls
return an auth error — reconnect from the same menu.

## Common issues

| Issue                                          | Solution                                                                       |
| ---------------------------------------------- | ------------------------------------------------------------------------------ |
| **MCP: Add Server** command is missing         | Update the GitHub Copilot extension to the latest version.                     |
| Nexudus server shows but no tools appear       | Run **MCP: Reload Servers** from the command palette.                          |
| Browser does not open during sign-in           | Check VS Code's output panel for the MCP server log and open the URL manually. |
| Tool calls fail with "Authentication required" | Your 8-hour session has expired. Reconnect from **MCP: Manage Servers**.       |

For more, see [Troubleshooting](/mcp/troubleshooting).

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Connecting to the Server
Source: https://learn.nexudus.com/mcp/connecting

The Nexudus MCP server URL, prerequisites, and what to expect the first time you connect.

# Connecting to the Server

The Nexudus MCP server is a hosted service. You do not install anything locally — you point your MCP client at the server URL and log in with your Nexudus account.

## Server URL

```
https://mcp.nexudus.com
```

This is the only address you need. All client setup pages start by entering this URL.

## Prerequisites

* **A Nexudus account** with the permissions you want the AI assistant to use. The server only sees data your account can see.
* **An MCP-capable client** — Claude.ai, ChatGPT, Claude Desktop, Claude Code, or VS Code with GitHub Copilot. See [Supported clients](#supported-clients) below.
* **A web browser** for the one-time login. The first connection opens a browser window where you enter your Nexudus email and password.

## Supported clients

The Nexudus MCP server has been tested with the following clients. Each has its own setup steps:

<CardGroup>
  <Card title="Claude.ai" icon="message" href="/mcp/clients/claude-ai">
    Web chat at claude.ai.
  </Card>

  <Card title="ChatGPT" icon="message-bot" href="/mcp/clients/chatgpt">
    Web chat at chatgpt.com.
  </Card>

  <Card title="Claude Desktop" icon="desktop" href="/mcp/clients/claude-desktop">
    Anthropic's desktop app.
  </Card>

  <Card title="Claude Code" icon="terminal" href="/mcp/clients/claude-code">
    Anthropic's terminal-based AI assistant.
  </Card>

  <Card title="VS Code (GitHub Copilot)" icon="code" href="/mcp/clients/vs-code">
    GitHub Copilot's MCP extension.
  </Card>
</CardGroup>

## Technical requirements (for other clients)

If your client is not in the list above, it can still connect provided it supports:

* **OAuth 2.0 Authorization Code Flow** — used to log in with your Nexudus credentials.
* **Streamable HTTP Transport** — used by the client to send requests.
* **Tools** — the operations exposed by the server (`tools/list`, `tools/call`).

**Optional but recommended:** MCP Resources support. This lets clients fetch documentation directly without using a tool call. Support is uneven across off-the-shelf clients — the Nexudus MCP server falls back to tool-based documentation when resources are not supported.

## What happens the first time you connect

1. You add `https://mcp.nexudus.com` to your MCP client.
2. The client opens a browser window with the Nexudus login page.
3. You enter your Nexudus email and password.
4. You tick the **responsibility disclaimer** and decide whether to leave the **PII consent** box unchecked (recommended) or tick it to share real personal data with the AI assistant. See [PII redaction](/mcp/pii-redaction).
5. The client receives an access token and stores it.
6. Your AI assistant now has Nexudus tools available.

Your Nexudus password is **never stored** by the MCP server. It is used once to verify your identity, and the server keeps only a short-lived access token tied to your session.

<Tip>
  Sessions last **8 hours**. After that, your assistant will tell you the connection has expired and you can reconnect using the same steps. See
  [Sessions and re-authentication](/mcp/sessions) for details.
</Tip>

## Next steps

<CardGroup>
  <Card title="Pick your client" icon="plug" href="/mcp/clients/claude-ai">
    Start with Claude.ai, ChatGPT, or another supported client.
  </Card>

  <Card title="How authentication works" icon="key" href="/mcp/authentication">
    What the server does with your login.
  </Card>
</CardGroup>


# Good Practice
Source: https://learn.nexudus.com/mcp/good-practice

Practical do's and don'ts for using the Nexudus MCP server responsibly with AI assistants like Claude and ChatGPT.

# Good Practice

The Nexudus MCP server is powerful — your AI assistant can read, create, update, and delete data in your Nexudus account on your behalf. That power comes with responsibility.

When you sign in to the MCP server, you tick a disclaimer confirming that AI behaviour is not deterministic, that you are responsible for reviewing what the assistant does, and that Nexudus cannot be held liable for actions taken by third-party AI assistants. This page turns that disclaimer into practical guidance.

<Note>
  Use this page as a starting point, not a substitute for your own judgement. Every coworking operator handles different data, different customers, and
  different regulatory environments — adapt the advice below to your context.
</Note>

## Before you connect

### Use a scoped administrator account

The MCP server currently requires you to sign in with an **administrator** account — member-only or other non-admin logins cannot drive the server. That does not mean you have to use a full, unrestricted administrator, though.

Nexudus admin roles can be **scoped** down to specific locations, modules, or permissions. For day-to-day AI work, **consider creating a dedicated administrator account with only the locations and permissions you actually need** rather than reusing your own full-access login. For example, an admin scoped to one location and with delete permissions removed is a much safer surface for AI activity than a global administrator.

<Note>
  A generic **read-only mode** for Nexudus administrator accounts is on the roadmap. Once it ships, you will be able to sign in with a read-only admin
  and the MCP server will simply inherit that — every create, update, delete, and run-command call will fail at the API level. Until then, scope the
  administrator account as tightly as you can.
</Note>

### Leave PII redaction on by default

The PII redaction checkbox on the sign-in page is **unchecked by default for a reason**. Most operator questions — counts, summaries, occupancy trends — work perfectly well against tokenised data. Only switch redaction off when you genuinely need to see or send real personal details. See [PII redaction](/mcp/pii-redaction) for the full guidance.

## While you work

### Be specific in your prompts

Vague instructions are the single biggest source of AI mishaps. "Clean up old bookings" can mean three different things to three different assistants on three different days.

| Avoid                                      | Prefer                                                                                      |
| ------------------------------------------ | ------------------------------------------------------------------------------------------- |
| *"Clean up old bookings."*                 | *"List tentative bookings created before 1 March 2026 — I want to review before deletion."* |
| *"Fix the membership."*                    | *"Update member 12345's plan to 'Hot Desk Monthly' starting tomorrow."*                     |
| *"Send a welcome message to new members."* | *"List members whose contract started this week so I can draft a welcome email."*           |

If the assistant is about to do something irreversible (delete, bulk update, run a destructive command), **ask for a list first** and confirm the scope yourself before approving the action.

### Read every tool call before approving it

Most MCP clients show the proposed tool call — the entity, the operation, the arguments — and wait for you to approve it. Take the second to actually read it.

* For `nexudus_delete`, `nexudus_run_command`, and bulk updates, expand the arguments and check the IDs and field values.
* If anything looks wrong — wrong location ID, wrong member, wrong date range — deny it and tell the assistant what to fix.

### Keep destructive actions human-in-the-loop

Even with "Always allow" configured, **leave destructive tool calls (delete, archive, cancel, run-command) gated on manual approval**. The few extra seconds of friction is what gives you the chance to catch a wrong ID before it goes to production data.

### Check the response, not just the assistant's summary

The assistant will paraphrase the Nexudus API response into prose. The prose can be wrong even when the API call succeeded — for example, the assistant may have misread a status code, or skipped a field, or filtered the response in a way that hides relevant records.

For decisions that matter, ask to **see the raw tool response** or check the result directly in the Nexudus admin panel.

## What not to do

### Do not paste secrets into the chat

Anything you type into the chat is sent to the AI provider (Anthropic, OpenAI, etc.) under that provider's terms — **the Nexudus PII setting does not apply to your messages**. Do not paste API keys, customer passwords, or other secrets into the prompt.

### Do not assume PII redaction covers everything

PII redaction covers fields that Nexudus knows are personal — names, emails, phones, addresses, dates of birth, social handles, financial IDs, free-text bios. It does **not** sanitise:

* Your own messages to the AI.
* Names that the assistant infers from context (e.g. you mention "Sarah's booking" yourself).
* Arbitrary text fields the assistant types into the chat itself.

If you need full data minimisation, leave redaction on **and** avoid typing personal details into the prompt yourself.

### Do not run unattended workflows on production data without review

The MCP server is designed for interactive use. Scheduling an assistant to "run every hour and update memberships" without a human reviewing each batch is asking for trouble — small prompt drift or a misread record can multiply across hundreds of writes before anyone notices.

### Do not screen-share PII without redaction

If you are demoing, training, or recording the session, **make sure PII redaction is on** so customer names and emails do not leak into screenshots or videos. Reconnect with the PII checkbox unchecked first if needed — see [Switching mid-conversation](/mcp/pii-redaction#switching-mid-conversation).

## Reviewing what the assistant did

The MCP server records anonymous [telemetry](/mcp/telemetry) for its own observability, but **it does not give you an audit log of what the assistant did**. To review actions after the fact:

* Check the **Nexudus admin panel** — every create, update, and delete shows in the usual audit trail under the user account you signed in with.
* Save or export the chat transcript from your MCP client (Claude, ChatGPT, etc.) — the transcript records the assistant's tool calls and your approvals.

If something goes wrong, the combination of the chat transcript and the Nexudus audit log is what lets you reconstruct exactly what happened.

## Quick checklist

Before kicking off an AI session that will change Nexudus data:

* [ ] Signed in with an administrator account scoped to the minimum locations and permissions needed (not a global administrator).
* [ ] PII redaction left on unless I explicitly need real personal data.
* [ ] Prompt is specific about the entity, the filter, and the action.
* [ ] Destructive tool calls require my approval.
* [ ] I have a way to verify the result (raw response, admin panel, chat transcript).

## Related

<CardGroup>
  <Card title="Authentication" icon="key" href="/mcp/authentication">
    Sign-in, sessions, and the responsibility disclaimer.
  </Card>

  <Card title="PII redaction" icon="user-shield" href="/mcp/pii-redaction">
    What gets redacted and how to switch the setting.
  </Card>

  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    The operations the assistant can call on your behalf.
  </Card>
</CardGroup>


# Nexudus MCP Server
Source: https://learn.nexudus.com/mcp/overview

Connect AI assistants like Claude and ChatGPT directly to your Nexudus account using the official Nexudus MCP server.

# Nexudus MCP Server

The **Nexudus MCP Server** is a hosted service that lets AI assistants — like Claude and ChatGPT — read and update data in your Nexudus account through natural language. There is nothing to install on your computer. You connect your AI assistant to `https://mcp.nexudus.com`, log in with your Nexudus account, and start asking questions or making changes.

<Note>
  MCP stands for **Model Context Protocol** — an open standard that lets AI assistants connect to external services. The Nexudus MCP server is the
  official Nexudus implementation of this standard.
</Note>

<Note>
  The Nexudus MCP server is under active development. Its entity coverage tracks the
  [`nexudus-coworking-cli`](https://github.com/Nexudus-Ltd/nexudus-coworking-cli) repository, which is the single source of truth for entity definitions
  across the CLI, Agent Skills, and the MCP server — new entity types, commands, and improvements are picked up automatically as they ship.
  Check the [MCP server repository](https://github.com/Nexudus-Ltd/nexudus-coworking-mcp-stateful) for the latest server updates.
</Note>

## What can you do with it?

<CardGroup>
  <Card title="Ask questions in plain English" icon="comments">
    "How many visitors are expected at my London location today?" — your AI assistant answers using live data from Nexudus.
  </Card>

  <Card title="Create and update records" icon="pen-to-square">
    Add bookings, update products, archive resources, send invoices — all by describing what you want.
  </Card>

  <Card title="Works from any supported client" icon="plug">
    Claude.ai, ChatGPT, Claude Desktop, Claude Code, and VS Code with GitHub Copilot all support MCP.
  </Card>

  <Card title="Secure, account-scoped access" icon="lock">
    Each session is tied to your own Nexudus login. The server only sees the data your account can see.
  </Card>

  <Card title="PII redaction on by default" icon="user-shield">
    Member names, emails, phones, and addresses are replaced with safe tokens before any response leaves the server unless you opt in.
  </Card>
</CardGroup>

## How it compares to the Nexudus CLI

The [Nexudus CLI](/cli/overview) and the Nexudus MCP server share the same source of truth for entity definitions, so they cover the same operations. The difference is how you reach them.

| You want to…                                                                 | Use…                        |
| ---------------------------------------------------------------------------- | --------------------------- |
| Talk to your Nexudus account from claude.ai, ChatGPT, or another chat client | The MCP server (this guide) |
| Run commands from the terminal or in scripts                                 | The CLI                     |
| Embed Nexudus operations in an AI assistant that runs locally with the CLI   | The CLI with Agent Skills   |

The MCP server does not need the CLI installed. It connects directly to the Nexudus REST API on your behalf.

## Who is this for?

| Audience            | Use case                                                                                            |
| ------------------- | --------------------------------------------------------------------------------------------------- |
| Coworking operators | Pull live reports, check visitors, update products, and create bookings from a chat interface.      |
| Location managers   | Ask "what's happening at my location today?" without learning the admin panel.                      |
| Workflow automators | Drive multi-step tasks ("for every member with X status, send an invoice") through an AI assistant. |

## Supported clients

The Nexudus MCP server has been tested with these MCP clients:

| Client                          | Connect from                                               |
| ------------------------------- | ---------------------------------------------------------- |
| **Claude.ai** (web)             | [Connect from Claude.ai](/mcp/clients/claude-ai)           |
| **ChatGPT**                     | [Connect from ChatGPT](/mcp/clients/chatgpt)               |
| **Claude Desktop**              | [Connect from Claude Desktop](/mcp/clients/claude-desktop) |
| **Claude Code** (CLI)           | [Connect from Claude Code](/mcp/clients/claude-code)       |
| **VS Code with GitHub Copilot** | [Connect from VS Code](/mcp/clients/vs-code)               |

Other MCP clients can connect too — they just need to support the OAuth 2.0 authorisation code flow and the Streamable HTTP transport. See [Connecting to the server](/mcp/connecting) for details.

## Privacy and telemetry

* **PII redaction is on by default.** Customer names, emails, phones, addresses, and other personal data are replaced with safe tokens before any response leaves the server. You can opt in to seeing real PII via a checkbox on the sign-in page — see [PII redaction](/mcp/pii-redaction).
* **No customer data, account contents, or arguments to tool calls** are ever included in usage telemetry. The MCP server only records the shape of calls (which operation, success or failure, latency). See [Telemetry](/mcp/telemetry) for the full list.
* **You are responsible for AI behaviour.** When you sign in, you tick a disclaimer acknowledging that AI assistants are non-deterministic and that you review their actions. See [Good practice](/mcp/good-practice) for how to work safely.

## Next steps

<CardGroup>
  <Card title="Connect to the server" icon="plug" href="/mcp/connecting">
    Prerequisites and the server URL.
  </Card>

  <Card title="Connect from Claude.ai" icon="message" href="/mcp/clients/claude-ai">
    Step-by-step setup for Claude.ai.
  </Card>

  <Card title="Connect from ChatGPT" icon="message-bot" href="/mcp/clients/chatgpt">
    Step-by-step setup for ChatGPT.
  </Card>

  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What your AI assistant can do once connected.
  </Card>

  <Card title="PII redaction" icon="user-shield" href="/mcp/pii-redaction">
    What gets redacted by default and when to opt in.
  </Card>

  <Card title="Good practice" icon="check" href="/mcp/good-practice">
    Do's and don'ts for safe AI use.
  </Card>
</CardGroup>


# PII Redaction
Source: https://learn.nexudus.com/mcp/pii-redaction

How the Nexudus MCP server redacts personal data, when to turn it off, and how to switch the setting mid-conversation in Claude and ChatGPT.

# PII Redaction

The Nexudus MCP server can replace personally identifiable information (PII) in every tool response with safe tokens **before the response leaves the server**. With redaction on, the AI provider only ever sees tokens like `«PII:NAME:7f3a…»` — never your customers' real names, emails, phones, or addresses.

You choose whether redaction is on or off when you sign in. The default is **on**.

<Note>
  Redaction protects values that come back from Nexudus. It does **not** sanitise anything you type into the AI client yourself — that text is sent to
  the AI provider under its own terms, regardless of this setting.
</Note>

## What gets redacted

Redaction covers the same categories of data as the [Nexudus CLI's PII redaction](/cli/pii-redaction):

| Category    | Examples                                         | Token format        |
| ----------- | ------------------------------------------------ | ------------------- |
| `NAME`      | Full names, nicknames, salutations               | `«PII:NAME:…»`      |
| `EMAIL`     | Email addresses                                  | `«PII:EMAIL:…»`     |
| `PHONE`     | Mobile, landline, fax numbers                    | `«PII:PHONE:…»`     |
| `ADDRESS`   | Street, postal code, city, region, country       | `«PII:ADDRESS:…»`   |
| `DOB`       | Dates of birth                                   | `«PII:DOB:…»`       |
| `SOCIAL`    | Social handles                                   | `«PII:SOCIAL:…»`    |
| `FINANCIAL` | Bank accounts, tax IDs, VAT numbers              | `«PII:FINANCIAL:…»` |
| `ID_DOC`    | Passport numbers, national IDs                   | `«PII:ID_DOC:…»`    |
| `BIO`       | Free-text profiles or notes that may contain PII | `«PII:BIO:…»`       |

Tokens are **deterministic across calls within your session**: the same customer always maps to the same token, so the assistant can still answer questions like *"how many bookings did this person make this month?"* without ever seeing their name. The tokens are derived from a salted hash, so they cannot be reversed back to the original value.

## Choosing the setting on the login page

You see two checkboxes at the bottom of the Nexudus sign-in page. The second one controls PII redaction.

<img alt="Nexudus MCP sign-in page with the responsibility disclaimer and the PII consent checkbox at the bottom." />

| Checkbox state                                                     | What happens                                       |
| ------------------------------------------------------------------ | -------------------------------------------------- |
| **Unchecked** (default)                                            | PII is redacted before it reaches the AI provider. |
| **Checked** — "Allow the AI assistant to see member personal data" | PII is sent to the AI provider in full.            |

Your choice is signed into the access token, so it stays the same for the whole 8-hour session.

## When to leave redaction on (recommended)

Leave the box **unchecked** when:

* You only need totals, counts, breakdowns, or other aggregate answers.
* You are debugging a workflow and do not need to look at real customer data.
* You are working in a shared chat or screen-sharing the session.
* You want to keep customer PII out of the AI provider's logs and training data.
* You are not sure — the safer default is to keep redaction on and turn it off later if you genuinely need to.

The assistant can still match the same person across calls, list members, count bookings, group by location, and run almost any reporting task on tokenised data.

## When to turn redaction off

Tick the **"Allow the AI assistant to see member personal data"** box if you specifically need the assistant to:

* Show you a customer's contact details verbatim.
* Send an email or message that includes a real name.
* Compose copy or invoices that address a customer by name.
* Look at a specific customer's free-text bio or notes.

The disclaimer above the checkbox calls this out: with PII off, real values are sent to the AI provider in full, and the provider handles them under its own terms.

## Switching mid-conversation

The PII setting is signed into your access token, so it cannot be flipped without re-authenticating. The server provides two helper tools so the assistant can guide you through it:

* `nexudus_change_pii_redaction_setting` — accepts `desiredState: 'show' | 'redact'` and replies with the exact wording of which checkbox to tick or untick on the next sign-in.
* `nexudus_reauthenticate` — revokes the current session so the client falls back to its OAuth flow.

The user experience depends on your MCP client.

### Claude.ai and Claude Desktop

When you ask Claude to switch off (or on) PII redaction, it calls `nexudus_reauthenticate` and Claude asks you to confirm the tool call. Approve it.

Claude then tries the next tool call, but because the session has been revoked it shows the entry as **"Authentication required to use this tool"** with a **Connect** button next to it. You may need to **unfold the tool call entry** in the conversation to see the Connect button.

Click **Connect**. Claude opens the Nexudus sign-in page in a pop-up — flip the PII checkbox to match the new setting, sign in, and the conversation continues using the new redaction mode.

### ChatGPT

ChatGPT does not currently reconnect connectors automatically. When you ask it to switch off PII redaction, the assistant calls `nexudus_reauthenticate` to revoke the session, then replies with a short confirmation along the lines of *"Done — I signed out the Nexudus MCP session so the PII setting can be changed"* followed by step-by-step instructions for you to follow in ChatGPT's settings.

The instructions ChatGPT prints look like this:

1. Open **ChatGPT → Settings → Connectors → Nexudus**.
2. **Disconnect** the connector.
3. **Reconnect** it. ChatGPT opens the Nexudus sign-in page.
4. On the Nexudus sign-in page, **tick (or untick) the "Allow the AI assistant to see member personal data" checkbox** to match the new setting and sign in.
5. Reply **"done"** in the chat. ChatGPT picks up where you left off using the new redaction mode and usually verifies it by re-fetching a record and showing the names in their new form (real names if you switched redaction off, tokens if you switched it back on).

### Any MCP client (fallback)

If the in-chat flow does not work — the assistant does not call the reauthenticate tool, the **Connect** button does not appear, or the client does not re-open the sign-in page — you can always fall back to the manual route:

1. Open your MCP client's connector settings.
2. **Disconnect** the Nexudus connector.
3. **Reconnect** it.
4. On the Nexudus sign-in page, tick or untick the **"Allow the AI assistant to see member personal data"** checkbox to match the setting you want, then sign in.

This works in every MCP client, regardless of how well it supports the in-chat reauthentication flow.

## Why this matters

* **Customer privacy.** Member names, emails, and addresses are not exposed to the AI provider's logs, training data, or downstream services unless you opt in.
* **Compliance.** Many coworking operators are subject to data protection regulations (GDPR, CCPA, and similar). Keeping redaction on by default is a defensible posture for routine reporting work.
* **No loss of analytical power.** Counts, groupings, time ranges, and per-record questions all work identically against tokens.

## Related

<CardGroup>
  <Card title="Authentication" icon="key" href="/mcp/authentication">
    The full sign-in flow and what is stored.
  </Card>

  <Card title="Good practice" icon="check" href="/mcp/good-practice">
    Do's and don'ts for responsible AI use.
  </Card>

  <Card title="CLI PII redaction" icon="terminal" href="/cli/pii-redaction">
    The same redaction in the Nexudus CLI.
  </Card>
</CardGroup>


# Sessions and Re-authentication
Source: https://learn.nexudus.com/mcp/sessions

How long an MCP session lasts and what to do when it expires.

# Sessions and Re-authentication

A connection to the Nexudus MCP server is called a **session**. Each session is tied to your Nexudus account and lasts for a limited time.

## How long a session lasts

| Setting              | Value                                                  |
| -------------------- | ------------------------------------------------------ |
| **Session lifetime** | 8 hours from sign-in                                   |
| **Refresh tokens**   | Not used — re-authenticate fully when expired          |
| **Idle timeout**     | None — sessions expire on the clock, not on inactivity |

After 8 hours, the access token your MCP client is using becomes invalid. The next tool call returns an authentication error.

## What you see when a session expires

The first failed tool call surfaces in your AI assistant's response. The wording depends on the assistant, but you will see something like:

> *"I tried to fetch your bookings, but your Nexudus connection needs to be re-authenticated."*

or:

> *"The Nexudus tools aren't loading. Could you reconnect from your client's settings?"*

Both are signs that the 8-hour session has ended. Most clients also show a status banner next to the Nexudus connector in their settings — for example, Claude.ai displays a **Connection issue** notice with a **Connect** button that walks you back through the sign-in.

<img alt="Claude.ai 'Connection issue — Connection has expired' screen for the Nexudus MCP connector with a Connect button." />

## How to re-authenticate

The steps depend on your MCP client, but they are always the same as the first sign-in:

| Client                       | How to reconnect                                                            |
| ---------------------------- | --------------------------------------------------------------------------- |
| **Claude.ai**                | Settings → Connectors → Nexudus → **Reconnect**.                            |
| **ChatGPT**                  | Settings → Apps & Connectors → Advanced settings → Nexudus → **Reconnect**. |
| **Claude Desktop**           | Settings → Connectors → Nexudus → **Reconnect**.                            |
| **Claude Code**              | Run `/mcp` in the terminal, pick **nexudus**, choose to reauthenticate.     |
| **VS Code (GitHub Copilot)** | Command palette → **MCP: Manage Servers** → **nexudus** → **Reconnect**.    |

In every case, you sign in to Nexudus again in the browser and the session restarts for another 8 hours.

## Why sessions expire

Short-lived sessions are a security feature. If your token is ever leaked — for example, by another extension reading from the MCP client's storage — the maximum time it remains useful is 8 hours.

## Multiple clients, same account

You can connect more than one MCP client to the same Nexudus account at the same time. Each client gets its own session and token; they do not share state. Disconnecting one client does not affect the others.

## What is not preserved across sessions

The MCP server itself remembers nothing about you between sessions:

* **No chat history** — that lives in your MCP client.
* **No saved preferences** — every session starts with the same defaults.
* **No request log visible to you** — only anonymous telemetry is recorded by the server (see [Telemetry](/mcp/telemetry)).

Your Nexudus account remembers everything that was created or changed — those operations are real database writes on the Nexudus side, identical to actions taken in the admin panel.

## Next steps

<CardGroup>
  <Card title="How authentication works" icon="key" href="/mcp/authentication">
    What the server does with your login.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/mcp/troubleshooting">
    Common issues and how to fix them.
  </Card>
</CardGroup>


# Telemetry
Source: https://learn.nexudus.com/mcp/telemetry

What anonymous usage data the Nexudus MCP server collects, why, and how to ask for it to be turned off.

# Telemetry

The Nexudus MCP server records anonymous usage data so we can see which operations are useful, where things fail, and which AI assistants are connecting. Telemetry is **on by default** for the hosted server.

## What is collected

Each event captures only the **shape** of the call — never the arguments you sent or the data Nexudus returned.

| Field           | Example                             | Description                                                             |
| --------------- | ----------------------------------- | ----------------------------------------------------------------------- |
| `command`       | `nexudus_list`                      | The MCP tool that was called.                                           |
| `entity`        | `bookings`                          | The Nexudus entity, when the call had one.                              |
| `operation`     | `list`                              | The kind of operation (list, get, create, update, delete, run-command). |
| `success`       | `true`                              | Whether the call succeeded.                                             |
| `durationMs`    | `245`                               | How long the call took in milliseconds.                                 |
| `errorCategory` | `auth` / `not_found` / `validation` | A coarse classification of the error, when one occurred.                |
| `caller`        | `claude-ai/1.0.0`                   | The MCP client name and version reported during connection.             |
| `traceId`       | `abc123…`                           | A per-session identifier used to correlate calls in one session.        |
| `version`       | `5.0.0`                             | The MCP server version.                                                 |
| `os`            | `linux`                             | The operating system of the server.                                     |
| `isAgent`       | `true`                              | Always `true` — every MCP caller is an AI agent.                        |
| `type`          | `nexudus-mcp`                       | Distinguishes MCP events from CLI events in our analytics.              |

## What is **not** collected

* **No tool arguments.** Field values you send (booking dates, member names, product prices, filter values) are never logged.
* **No response payloads.** The records returned by Nexudus are never logged.
* **No personal data about you.** Your name, email, and Nexudus account ID are not in the event.
* **No business data.** Names of your locations, members, or products are never sent.

## Where data is sent

When telemetry is enabled, events are shipped to **Logz.io**, a third-party analytics platform, over HTTPS with a 3-second timeout. If the network call fails for any reason — including Logz.io being unreachable — the event is silently dropped. Telemetry never adds latency to your tool calls and never causes a tool call to fail.

## Why we collect this

| Question we answer                           | Why it matters                                       |
| -------------------------------------------- | ---------------------------------------------------- |
| Which entities and operations are used most? | Decide what to optimise or document better.          |
| Where do AI assistants pick the wrong tool?  | Improve the per-entity guides and tool descriptions. |
| Which MCP clients are most active?           | Prioritise testing on those clients.                 |
| What is the typical response time?           | Catch regressions in the server.                     |
| Which errors are most common?                | Identify field-validation gaps or auth issues.       |

## Turning telemetry off

Telemetry is configured at the server level, not per-user. If you are using the public hosted server at `https://mcp.nexudus.com` and want telemetry disabled for your traffic, contact Nexudus support — there is no in-client setting for it.

## Privacy summary

* **No sensitive data** — only the shape of calls is captured, never arguments or response data.
* **Failure-safe** — telemetry errors never affect tool calls.
* **Encrypted transmission** — all data is sent over HTTPS.
* **Aggregated reporting** — events are used to compute counts and trends, not to track individual users.

## Questions

If you have privacy concerns or want to opt out of telemetry on the hosted server, reach out to the Nexudus team or open an issue on the [project repository](https://github.com/Nexudus-Ltd/nexudus-coworking-mcp-stateful).


# Available Tools
Source: https://learn.nexudus.com/mcp/tools

The operations the Nexudus MCP server exposes to your AI assistant.

# Available Tools

The Nexudus MCP server gives your AI assistant a small set of **generic tools** that work across every entity in Nexudus, plus a few **specialist tools** that wrap common queries with friendlier parameters. You do not call these tools yourself — the assistant decides which to use based on your question.

## Generic tools

These tools cover any of the 208 entity types supported by Nexudus — bookings, products, resources, members, invoices, and so on. The assistant picks the right entity based on your question.

| Tool                                   | What it does                                                                                             |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `nexudus_list_entities`                | Lists every available entity type. Used at the start of a conversation to discover what is available.    |
| `nexudus_describe_entity`              | Returns the field schema, filter options, enum values, and the entity's usage guide for a chosen entity. |
| `nexudus_list`                         | Searches and filters records of a chosen entity, with pagination.                                        |
| `nexudus_get`                          | Fetches a single record by ID, including collection fields omitted from list responses.                  |
| `nexudus_create`                       | Creates a new record.                                                                                    |
| `nexudus_update`                       | Updates an existing record by ID.                                                                        |
| `nexudus_delete`                       | Deletes a record by ID. The assistant should confirm with you before calling this.                       |
| `nexudus_list_commands`                | Lists special operations (like archive or activate) available on an entity.                              |
| `nexudus_run_command`                  | Runs a named command (such as `Archive` or `CheckIn`) on one or more records.                            |
| `nexudus_get_skill_guide`              | Fetches the cross-cutting guide that teaches the assistant how to use the Nexudus tools.                 |
| `nexudus_get_entity_guide`             | Fetches the per-entity guide for a specific entity type.                                                 |
| `nexudus_change_pii_redaction_setting` | Tells the assistant which checkbox you need to tick on re-sign-in to switch PII redaction on or off.     |
| `nexudus_reauthenticate`               | Revokes the current session so the client re-runs the OAuth flow — used to change the PII setting.       |

## Specialist tools

Specialist tools wrap a common query against a single entity, with friendly parameter names that map to the right Nexudus filter keys. The assistant uses them when the request matches one of these flows — no schema lookup needed first, so the response is faster.

### `nexudus_fetch_bookings`

Fetches bookings with friendly parameters: `fromTime`, `toTime`, `coworkerId`, `resourceId`, `businessId` (the location), `tentative`, `invoiced`, `archived`.

Example prompt: *"List bookings at my London location between 9am and 5pm tomorrow that are still tentative."*

### `nexudus_fetch_visitors`

Fetches visitors with friendly parameters: `fullName`, `email`, `businessId` (the location), `coworkerId` (the host), `expectedFrom`, `expectedTo`, `hostApprovalStatus` (pending, approved, or declined).

Example prompt: *"Show me the pending visitor requests expected at my main location this week."*

## How the assistant chooses tools

A typical conversation looks like this:

<Steps>
  <Step title="The assistant identifies the entity">
    For an open-ended question, the assistant calls `nexudus_list_entities` once to discover what is available.
  </Step>

  <Step title="It learns the entity's shape">
    Before listing or creating, it calls `nexudus_describe_entity` to learn the filter keys, required fields, and enum values.
  </Step>

  <Step title="It runs the operation">
    Depending on your question, it calls `nexudus_list`, `nexudus_get`, `nexudus_create`, `nexudus_update`, `nexudus_delete`, or `nexudus_run_command`.
  </Step>

  <Step title="It summarises the result">
    The raw response is shaped into a human-readable answer for you.
  </Step>
</Steps>

For booking and visitor queries, the assistant often skips straight to the specialist tools above.

## Coverage

The Nexudus MCP server is **metadata-driven**: entity definitions, supported operations, fields, and filter keys are loaded from the
[`Nexudus-Ltd/nexudus-coworking-cli`](https://github.com/Nexudus-Ltd/nexudus-coworking-cli) repository at server startup. That repository is the single source
of truth for the Nexudus CLI, the public skills/reference docs, and this MCP server, so all three stay in sync. When new entities are added upstream, they
appear in the MCP server automatically.

For a complete list of entities and their supported operations (list, get, create, update, delete, run-command), see the [CLI entity reference](/cli/entity-reference) — the same entities are available through the MCP server.

## Approval prompts in your client

Every tool declares whether it is a **read** or a **write**, and whether it can have side effects. Most MCP clients use these hints to decide which calls need your explicit approval:

* **Read-only** tools (`nexudus_list_entities`, `nexudus_describe_entity`, `nexudus_list`, `nexudus_get`, `nexudus_list_commands`, `nexudus_get_skill_guide`, `nexudus_get_entity_guide`) — clients like ChatGPT can call these without asking you each time.
* **Write** tools (`nexudus_create`, `nexudus_update`) and **destructive** tools (`nexudus_delete`, `nexudus_run_command`) — clients prompt you for approval before each call.

This means you should still expect an approval prompt for anything that changes data. If your client is configured to auto-approve everything, see [Good practice](/mcp/good-practice) for why we recommend keeping destructive actions human-in-the-loop.

## Safety

The MCP server cannot do anything your Nexudus account cannot do. But within your permissions, **create, update, and delete operations are real**: they affect live data immediately and there is no undo button. Always read the proposed tool call before approving it.

<Warning>
  Vague instructions like *"clean up old bookings"* can lead the assistant to delete more than you expected. Be specific about what to keep and what to
  remove, and consider asking for a list first to confirm the scope before any deletions.
</Warning>

For a deeper checklist of safe-by-default habits, see [Good practice](/mcp/good-practice).

## Next steps

<CardGroup>
  <Card title="Good practice" icon="check" href="/mcp/good-practice">
    Do's and don'ts for responsible AI use.
  </Card>

  <Card title="PII redaction" icon="user-shield" href="/mcp/pii-redaction">
    What gets redacted and how to switch the setting.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/mcp/troubleshooting">
    Common issues and how to fix them.
  </Card>
</CardGroup>


# Troubleshooting
Source: https://learn.nexudus.com/mcp/troubleshooting

Solutions to common issues when connecting to and using the Nexudus MCP server.

# Troubleshooting

## Start of conversation tips

Most "the assistant is not using the Nexudus tools" issues come from how the conversation starts, not from a server problem. A few habits make a big difference:

### Mention Nexudus by name early

Models like Claude and ChatGPT have hundreds of connectors, tools, and built-in capabilities available. If your opening message is *"how many bookings do we have this week?"*, the model may try to answer from general knowledge or web search instead of calling the Nexudus tools.

A more reliable opening:

> *"Using the Nexudus tools, list bookings at my main location for this week."*

The word "Nexudus" and a hint at the action ("list bookings") nudge the model straight to the connector.

### Be specific from the first message

The Nexudus MCP server exposes 200+ entities through generic tools. Vague prompts force the model to guess which entity you mean, which often results in a wrong tool call or a clarifying question. Spell out:

* **The entity** — bookings, members, products, invoices, visitors, resources, plans.
* **The filter** — at which location, in which date range, with which status.
* **The action** — list, count, create, update, delete.

Compare:

| Vague                      | Specific                                                                   |
| -------------------------- | -------------------------------------------------------------------------- |
| *"Show me today's stuff."* | *"Using Nexudus, list visitors expected at my London location today."*     |
| *"Who's new?"*             | *"Using Nexudus, list members whose contract started in the last 7 days."* |
| *"Cancel that booking."*   | *"Using Nexudus, cancel booking 12345678."*                                |

### Confirm the connector is actually connected

Before troubleshooting deeper, double-check that:

* The Nexudus connector is **Connected** in your client's settings.
* In ChatGPT specifically, the connector is **toggled on** in the current chat's Developer mode tool menu — it is off by default in every new chat.
* The 8-hour session has not expired. If it has, the assistant should say so on the first tool call — reconnect from your client's settings.

### Tell the assistant to use the tools, not guess

If the assistant answers from general knowledge instead of calling a tool, you can correct it:

> *"Don't answer from memory — call the Nexudus tools to look up the current value."*

This is a common nudge with ChatGPT in particular, which sometimes treats Nexudus questions as general knowledge.

## Connection issues

### My client cannot reach `https://mcp.nexudus.com`

* Check that you typed the URL exactly: `https://mcp.nexudus.com` — no trailing slash, no extra path.
* Check your internet connection.
* Check that a firewall or proxy is not blocking outbound HTTPS connections to `mcp.nexudus.com`.

### The login window does not open

* Most MCP clients use your **default browser** to show the Nexudus login page. Make sure you have a default browser set.
* Pop-up blockers can prevent the window from opening. Disable them and retry.
* In Claude Code and VS Code, check the log output for the manual login URL — you can open it in any browser to complete sign-in.

### "Authentication required" or "Unauthorized" mid-conversation

Your 8-hour session has expired. Reconnect from your client's MCP settings — see [Sessions and re-authentication](/mcp/sessions) for the exact steps per client.

### Login redirects back to a Nexudus error page

* Your Nexudus credentials may have changed. Try signing in directly at [spaces.nexudus.com](https://spaces.nexudus.com) first.
* Your account may have been deactivated — contact your Nexudus administrator.

## Tool issues

### The AI assistant says no Nexudus tools are available

* Confirm the connector shows as **Connected** in your client's settings.
* In ChatGPT, confirm the Nexudus connector is **toggled on** in the current chat's tools menu — it must be enabled per chat.
* Restart your MCP client. Some clients only load tools at app startup.
* Disconnect and reconnect the connector.

### The assistant picks the wrong field name or filter

The assistant should call `nexudus_describe_entity` before creating or filtering, but sometimes it skips that step. Ask it to describe the entity explicitly:

> *"Before updating that, describe the 'products' entity and list its filter keys."*

This pulls in the correct field names so the next call works.

### List queries return wrong results

The Nexudus API uses specific **filter keys** (for example, `Booking_FromTime` rather than `FromTime`). The MCP server validates filter keys and returns an error listing the valid ones — the assistant should self-correct on the next attempt. If results still look wrong, ask the assistant to describe the entity and rerun the query using the listed filter keys.

### A create or update fails with a validation error

* Ask the assistant to call `nexudus_describe_entity` and check which fields are required for the entity.
* Some entities have additional rules (price minimums, contract overlaps, location-specific defaults) that the API enforces. The error message usually says which field caused the problem.

### Delete is too aggressive

If the assistant has deleted more than you intended, there is no automatic undo. Recovery options depend on the entity:

* For most entities, you would need to recreate them from a backup or from another source.
* For destructive bulk actions, always ask the assistant to **list first** so you can confirm the scope before deletion.

## PII redaction issues

### Names and emails come back as `«PII:NAME:...»` tokens

PII redaction is on for your session. This is the safer default. If you actually need to see real personal data, ask the assistant to switch the setting:

> *"Switch off PII redaction."*

The assistant calls `nexudus_reauthenticate` to revoke the session, and from there the flow is client-specific:

* **Claude.ai / Claude Desktop** — Claude shows a **Connect** button on the next pending tool call. Click it, sign in again, and tick the PII checkbox on the sign-in page.
* **ChatGPT** — ChatGPT prints manual steps: open Settings → Connectors → Nexudus, disconnect, reconnect, tick the PII checkbox on the sign-in page, then reply "done" in the chat.

See [PII redaction → Switching mid-conversation](/mcp/pii-redaction#switching-mid-conversation) for screenshots.

### I want to turn PII redaction back on

Same flow as above — ask the assistant to switch redaction on. On the next sign-in, leave the **"Allow the AI assistant to see member personal data"** checkbox unticked.

### Some names still appear even though redaction is on

Redaction covers data Nexudus returns. It does **not** sanitise:

* Text you type into the chat yourself.
* Names the assistant infers from your prompts (e.g. you say "Sarah's booking").
* Free-text fields that look like notes but contain non-PII content.

If you need full data minimisation, leave redaction on **and** avoid typing personal details into the prompt.

## Performance issues

### Calls feel slow

* The first call after connecting can take a moment as the session initialises and entity definitions are loaded.
* Long list calls take more time on large datasets. Ask the assistant to use pagination — *"show the first 25 records"* — and continue from there.

### "Session not found" errors after a long break

* The server may have restarted while your session was idle. Reconnect from your client's MCP settings — re-authenticating creates a fresh session.

## Where to get more help

* **Nexudus help centre:** [help.nexudus.com](https://help.nexudus.com)
* **MCP server repository:** [github.com/Nexudus-Ltd/nexudus-coworking-mcp-stateful](https://github.com/Nexudus-Ltd/nexudus-coworking-mcp-stateful)
* **Entity reference:** [CLI entity reference](/cli/entity-reference) — same entities are available through the MCP server.

## Next steps

<CardGroup>
  <Card title="Available tools" icon="wrench" href="/mcp/tools">
    What the AI assistant can do for you.
  </Card>

  <Card title="Good practice" icon="check" href="/mcp/good-practice">
    Do's and don'ts to keep AI work safe.
  </Card>

  <Card title="Sessions and re-auth" icon="clock" href="/mcp/sessions">
    Why sessions expire after 8 hours.
  </Card>
</CardGroup>


# Monitoring Conversations
Source: https://learn.nexudus.com/member-portal/ai/admin-panel

How to view and analyse AI conversations and their outcomes in the Nexudus administration panel.

The Nexudus administration panel gives you a full view of every AI conversation — what was said, who said it, which channel it came from, and whether it led to a business outcome. Conversations from all channels (chat, email, WhatsApp, and voice) appear in the same place. There are two places to find this information: the **AI Conversations list** under Operations, and the **Visitor record** for tour enquiries.

## AI Conversations list

Go to **Operations > AI Conversations** to see all chat sessions.

<Frame>
  <img alt="AI Conversations list showing multiple rows with Message, Conversion badges, User, and Date columns" />
</Frame>

The list shows one row per conversation session (not per individual message). The columns are:

| Column         | What it shows                                                               |
| -------------- | --------------------------------------------------------------------------- |
| **Message**    | The opening message of the conversation, truncated to 120 characters        |
| **Channel**    | The channel the conversation took place on: Chat, Email, WhatsApp, or Voice |
| **Conversion** | Colour-coded badges showing what outcome the conversation produced (if any) |
| **User**       | The identified user who had the conversation; blank for anonymous visitors  |
| **Date**       | When the conversation started, newest first                                 |

The list defaults to the 250 most recent conversations. You can search by message content or filter by chat session ID.

## Viewing a full conversation

Click any row to open the conversation detail panel. This shows the complete message thread:

* **User messages** — person icon, labelled "Visitor"
* **AI responses** — computer icon, labelled "AI agent"
* Messages are rendered as formatted text (bold, links, headings as written by the AI)
* Internal tool calls are hidden — you see only the natural-language exchange, not the underlying data requests

The same conversion badges from the list view appear at the top of the detail panel, each as a clickable link to the relevant record in Nexudus.

<Frame>
  <img alt="Conversation detail panel showing a full exchange with user and AI agent messages and a Contract created badge at the top" />
</Frame>

## Understanding conversion badges

| Badge                  | Colour   | What it means                                                 | Click to open              |
| ---------------------- | -------- | ------------------------------------------------------------- | -------------------------- |
| **Tour booked**        | Lavender | A Visitor record was created as a result of this conversation | The Visitor record         |
| **Customer created**   | Green    | A new Coworker (customer) account was created                 | The Coworker profile       |
| **Contract created**   | Blue     | A membership contract was created                             | The contract               |
| **Booking created**    | Teal     | A room booking was created through the AI                     | The Booking record         |
| **Day pass purchased** | Peach    | A day pass was purchased                                      | The CoworkerProduct record |

A single conversation can show multiple badges — for example, a new sign-up produces both "Customer created" and "Contract created".

<Frame>
  <img alt="A single conversation row showing both a Customer created and a Contract created badge" />
</Frame>

Conversations with no badges represent members asking informational questions or prospects who browsed without converting. These are still stored and searchable.

## AI conversations in Visitor records

When a prospect books a tour through the AI assistant, the full chat conversation appears directly on their **Visitor record**. This gives your team context before the visit — they can see exactly what the prospect asked about, which offices interested them, and what requirements they mentioned.

To find it:

1. Go to **Spaces > Visitors** and open the relevant visitor.
2. Scroll to the **AI Agent Conversation** section.
3. The full thread is displayed with the same user / AI agent layout as in the AI Conversations list.

This section only appears for visitors who arrived through the AI assistant. Visitors added manually will not have it.

<Frame>
  <img alt="A Visitor record with the AI Agent Conversation section showing the full conversation that led to the tour" />
</Frame>


# Room Bookings
Source: https://learn.nexudus.com/member-portal/ai/bookings

How the AI helps logged-in members create, view, modify, and cancel bookings across chat, email, WhatsApp, and voice.

The AI handles the full booking lifecycle for logged-in members. All booking operations require the member to be identified — on the chat channel this means being signed in; on email, WhatsApp, and voice the member is identified by their email address, phone number, or caller ID. The AI will prompt unidentified users to log in or provide contact details before proceeding.

## Creating a booking

The AI guides a member through booking in a three-step flow: **draft → confirm → create**.

**Step 1 — Draft.** The AI finds available rooms matching the member's request (room name or type, date, start time, duration). It returns a summary showing the room, desk, start and end time, price, and any required custom fields (such as "number of attendees"). Times are automatically rounded to the nearest 15-minute interval.

**Step 2 — Confirm.** The member reviews the draft. A short-lived confirmation token is issued. The member confirms by replying (e.g. "yes, book it") or, on voice, by saying "yes" or "confirm". The confirmation window depends on the channel — 10 minutes for chat, 1 hour for WhatsApp, 4 hours for email, and during the call for voice. See [Channels](./channels) for details.

**Step 3 — Create.** The booking is created in Nexudus. If payment is required upfront, the AI provides a link to complete payment before the booking is finalised.

<Frame>
  <img alt="Chat showing a booking creation: user requests room, AI shows draft with details, user confirms, booking confirmed with reference" />
</Frame>

<Note>
  If the room has required custom fields, the AI will ask for those values before completing the booking. The booking is not created until all required fields are provided.
</Note>

## Viewing bookings

Members can ask the AI to show their upcoming or past bookings: "what bookings do I have this week?", "show me my meetings for Thursday."

The AI returns a list of matching bookings with room name, desk, start time, and end time. Results can be filtered by date range or by room name.

<Frame>
  <img alt="Chat showing a list of upcoming bookings returned by the AI" />
</Frame>

## Modifying a booking

Members can ask to change the time, date, duration, or room of an existing booking. The AI uses the same **draft → confirm → update** flow as creation.

For relative changes ("extend my 3pm meeting by an hour"), the member can first ask the AI to retrieve the current booking details, then request the modification.

<Frame>
  <img alt="Chat showing a booking modification: move my 3pm meeting to 4pm, AI shows updated draft, member confirms" />
</Frame>

## Cancelling a booking

The AI cancels bookings after collecting a reason and confirming with the member. The flow is:

1. The AI asks the member which booking to cancel (or the member specifies it directly).
2. The AI presents a list of localised cancellation reason options.
3. The member selects a reason.
4. The AI shows a confirmation summary and asks the member to confirm.
5. On confirmation, the booking is cancelled and the reason is recorded in Nexudus.

<Frame>
  <img alt="Chat showing a cancellation: member requests cancellation, AI asks for reason with localised options, member selects, AI confirms" />
</Frame>

### Cancellation reasons

The AI records the cancellation reason as a structured value in Nexudus:

| Reason                        |
| ----------------------------- |
| No longer needed              |
| Too expensive                 |
| Bad previous experience       |
| Rebooked for a different time |
| Failed to pay upfront         |
| Other                         |

The AI maps the member's natural-language reply to the closest matching reason, supporting English, Spanish, and French.

## Conversion tracking

When a booking is created through the AI, a **"Booking created"** badge (teal colour) appears on the conversation in the [AI Conversations list](./admin-panel), with a direct link to the Booking record.

See [Conversion Tracking](./conversion-tracking) for a full explanation of how session IDs work.


# Channels
Source: https://learn.nexudus.com/member-portal/ai/channels

How the AI assistant works across chat, email, WhatsApp, and voice — and how to enable each channel.

The AI assistant supports four channels: **Chat**, **Email**, **WhatsApp**, and **Voice**. All four share the same capabilities, the same data, and the same visibility rules. The differences are in how conversations are started, how sessions are managed, and how responses are formatted.

<Frame>
  <img alt="Sequence diagram showing CLI to Browser to API flow for PII unlock" />
</Frame>

## Channel comparison

|                                | Chat                                                  | Email                                                          | WhatsApp                                                   | Voice                                                           |
| ------------------------------ | ----------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------- | --------------------------------------------------------------- |
| **How it works**               | Floating widget on the members portal                 | Members email your space's AI address                          | Members message your space's WhatsApp number               | Members call your space's phone number — links are sent via SMS |
| **Enabled by default**         | Yes                                                   | No                                                             | No                                                         | No                                                              |
| **Session duration**           | One session per chat window                           | 48 hours (same email thread)                                   | 24 hours (same phone number)                               | One session per call                                            |
| **Response format**            | Rich text with markdown, tool cards, and buttons      | Well-structured paragraphs, no markdown headers or code blocks | Concise text under 300 words, bold for emphasis, no tables | Spoken text, natural pacing, pauses for user response           |
| **Media attachments**          | Not applicable                                        | Text only — attachments are noted but not processed            | Text only — media messages are noted but not processed     | Speech-to-text input, text-to-speech output                     |
| **Confirmation window**        | 10 minutes                                            | 4 hours                                                        | 1 hour                                                     | 10 minutes (during call)                                        |
| **Requires customer identity** | Optional (logged-in members identified automatically) | Matched by email address                                       | Matched by mobile phone number                             | Matched by caller phone number                                  |

## Chat

The chat channel is the default. It is embedded in your members portal as a floating widget and is described in detail on the [Chat Experience](./chat-experience) page.

No additional setup is required — chat is available as soon as the AI assistant is enabled for your space.

## Email

The email channel lets members and prospects interact with the AI by sending an email to a dedicated address for your space. The AI processes the message, runs the same tools it would use in chat, and sends back a reply email.

### How it works

1. A member or prospect sends an email to your space's AI email address.
2. Nexudus identifies the sender by matching the email address to an existing customer record.
3. The AI processes the message and sends a reply email from your space.
4. Replies to that email continue the same conversation — no need to start over.

### Sessions

Email sessions last **48 hours**. All replies within the same email thread are part of the same session. If the sender starts a new email with a different subject line, a new session begins. After 48 hours of inactivity, a new session also starts automatically.

### Response formatting

Email responses use well-structured paragraphs without markdown headers, code blocks, or tables. Images and links are included where relevant. Each reply includes a footer identifying the response as coming from your space's AI assistant.

### Enabling the email channel

Enable the email channel in your business settings by switching on **AI Email**. You then configure your email provider to forward messages from your chosen address to the Nexudus AI inbox address.

See [Setting up the email channel](./setup-email) for the full step-by-step guide, including instructions for Gmail, Microsoft 365, and other email providers.

<Note>
  If the sender's email address matches multiple customer records, Nexudus resolves the correct one using these rules in order: default profile first, then individual records, then the most recently created record.
</Note>

## WhatsApp

The WhatsApp channel lets members and prospects interact with the AI by messaging your space's WhatsApp number. The AI processes the message and replies in the same WhatsApp conversation.

### How it works

1. A member or prospect sends a WhatsApp message to your space's number.
2. Nexudus identifies the sender by matching the phone number to an existing customer record.
3. The AI processes the message and replies via WhatsApp.
4. The conversation continues naturally in the same WhatsApp thread.

### Sessions

WhatsApp sessions last **24 hours**. All messages from the same phone number within that window are part of the same session. After 24 hours of inactivity, a new session starts automatically.

### Response formatting

WhatsApp responses are concise — under 300 words — and use **bold** for emphasis. Tables, headers, and code blocks are not used. Links are placed on their own lines for easy tapping.

### Enabling the WhatsApp channel

1. Create a Twilio account and register a WhatsApp sender.
2. Configure the Twilio webhook to point to Nexudus.
3. Switch on **AI WhatsApp** in your business settings.
4. Enter your **WhatsApp phone number** — this is the Twilio-enabled number associated with your space.

The WhatsApp number is configured per location. Each location that uses WhatsApp needs its own number so that inbound messages can be routed to the correct space.

See [Setting up the WhatsApp channel](./setup-whatsapp) for the full step-by-step guide, including Twilio account setup, Meta business verification, and webhook configuration.

<Note>
  If the sender's phone number matches multiple customer records, Nexudus resolves the correct one using the same rules as email: default profile first, then individual records, then the most recently created record.
</Note>

## Confirmation windows

When the AI performs an action that changes data — such as creating, modifying, or cancelling a booking — it asks the member to confirm before proceeding. The confirmation is valid for a limited time that depends on the channel:

| Channel  | Confirmation window |
| -------- | ------------------- |
| Chat     | 10 minutes          |
| WhatsApp | 1 hour              |
| Email    | 4 hours             |

If the member does not confirm within this window, they need to start the action again. The longer windows for email and WhatsApp account for the fact that members may not reply immediately on those channels.

## Customer identification

On each channel, the AI identifies the customer differently:

| Channel      | How the customer is identified                              |
| ------------ | ----------------------------------------------------------- |
| **Chat**     | Automatically, if the member is logged in to the portal     |
| **Email**    | By matching the sender's email address to a customer record |
| **WhatsApp** | By matching the sender's phone number to a customer record  |

If no matching customer is found, the AI still responds — but capabilities that require a logged-in member (such as viewing or managing bookings) are not available.

## Voice

The Voice channel lets members and prospects interact with the AI by calling your space's phone number. The AI processes the caller's spoken words and replies using text-to-speech, creating a natural voice conversation.

### How it works

1. A member or prospect calls your space's phone number.
2. Nexudus identifies the caller by matching the incoming phone number to an existing customer record.
3. The AI processes the caller's spoken request and replies using text-to-speech.
4. The conversation continues naturally — the caller speaks, the AI responds, just like a regular phone call.

### Sessions

Voice sessions last for the duration of a single call. When the caller hangs up, the session ends. A new call from the same number starts a new session. The full conversation is transcribed and stored in Nexudus, visible in the [AI Conversations list](./admin-panel).

### Interaction style

Voice responses are spoken aloud — they need to be concise and easy to follow. The AI uses natural pacing with brief pauses between points. Complex information (like room details or pricing) is broken into digestible chunks. If the caller needs to see information (such as a map or a list of options), the AI offers to send it via email or WhatsApp instead.

### Confirmation windows

When the AI performs an action that changes data during a voice call — such as creating or modifying a booking — it asks the caller to confirm verbally. The confirmation must be given before the call ends. If the caller hangs up without confirming, the action is not completed.

### SMS link delivery

When the AI assistant provides links or URLs during a voice conversation — such as booking confirmations, pass details, or membership plan pages — it doesn't read them aloud. Instead, it sends the links via SMS to the caller's phone number and mentions in the voice response that a text message has been sent.

This improves the caller experience because spoken URLs are difficult to remember or use. After the AI mentions that an SMS has been sent, the caller receives a text message containing:

* A short label describing each link (e.g., "Your booking confirmation")
* The full URL on a separate line for easy tapping

If multiple links are returned in a single response, they are combined into one SMS message. If the link list is very long, it may be split across multiple SMS segments.

The AI response during the call will sound something like: "I've just sent you a text message with the link to your booking confirmation."

<Note>
  SMS link delivery requires that your Twilio number has SMS capabilities enabled. If SMS is not configured, the voice channel continues to work normally — the AI will simply mention the link verbally without sending an SMS.
</Note>

<Note>
  If the caller's phone number matches multiple customer records, Nexudus resolves the correct one using the same rules as email and WhatsApp: default profile first, then individual records, then the most recently created record.
</Note>


# Chat Experience
Source: https://learn.nexudus.com/member-portal/ai/chat-experience

How members and visitors interact with the AI assistant via the chat widget in the members portal.

The chat widget is the default channel for the AI assistant — a floating button embedded on every page of the members portal. This page covers how it looks and behaves from the member's perspective. For the email, WhatsApp, and voice channels, see [Channels](./channels).

## The chat button

The **"Ask me"** button with a robot icon floats in the bottom corner of every portal page. It automatically hides when a member scrolls down a page and reappears when they scroll back up, keeping it unobtrusive on content-heavy pages.

<Frame>
  <img alt="The Ask me floating button in the bottom-right corner of the members portal" />
</Frame>

## Opening the chat

Clicking the button opens a chat modal. If it is a fresh session, the modal shows a greeting and three **suggested prompts** to help members get started quickly:

* "Book a meeting room for tomorrow at 10 AM for 1 hour."
* "Show me my upcoming bookings."
* "What are your opening times?"

Clicking a suggested prompt sends it immediately — no typing required.

<Frame>
  <img alt="The open chat modal showing the greeting and three suggested prompts" />
</Frame>

## Sending a message

Members type in the input box at the bottom and press Enter (or click Send). Pressing Shift+Enter expands the input into a multi-line text area for longer messages. Messages can be up to 4,000 characters.

<Frame>
  <img alt="The chat input box with a message being typed" />
</Frame>

## Loading and typing animation

While the AI processes the request, a loading message is shown — for example *"Thinking about the best way to assist you..."* or *"Finding your options..."*. Once the response arrives, the text types out character by character, giving the conversation a natural, back-and-forth feel.

<Frame>
  <img alt="A response typing out character by character" />
</Frame>

## Tool cards

For certain responses, the AI shows a **visual card** alongside its text reply:

| Card type         | When shown                              | What it contains                                                                                                               |
| ----------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **Booking card**  | After a booking is drafted or confirmed | Room name, desk, start and end time, price, capacity, address; action buttons (Request booking / Pay to confirm / View on map) |
| **Location card** | After a location search                 | Business logo, location name, full address, distance; Access and View on map buttons                                           |
| **Room card**     | After a room search                     | Room photo, name, location, capacity, features; Request booking button                                                         |

For day passes, membership plans, and private offices the AI renders rich formatted text with links and call-to-action buttons directly in the chat — these do not use a separate card.

<Frame>
  <img alt="A booking tool card showing room, time, price, and action buttons" />
</Frame>

<Frame>
  <img alt="A location tool card showing logo, address, and map link" />
</Frame>

## Session management

Each chat session is independent. Closing and reopening the modal starts a fresh conversation — the previous exchange is not shown again in the UI. However, it is permanently stored in Nexudus and visible to operators in the [AI Conversations list](./admin-panel).

If a member or prospect arrives at the portal with an `?aiChat` parameter in the URL — for example, from a marketing link or email — the chat window opens automatically.

<Tip>
  The AI uses the member's browser location (if they grant permission) to calculate distances when presenting rooms, locations, and offices. No location permission is required for the chat to work — distance information is simply omitted when unavailable.
</Tip>


# Conversion Tracking
Source: https://learn.nexudus.com/member-portal/ai/conversion-tracking

How Nexudus links AI conversations to tours booked, bookings made, memberships started, and day passes purchased — across all channels.

Conversion tracking connects a conversation to a real business outcome — a tour scheduled, a booking made, a membership signed, or a day pass bought. Every conversion is stored in Nexudus and visible in the [AI Conversations list](./admin-panel). Conversions are tracked across all channels: chat, email, WhatsApp, and voice.

<Frame>
  <img alt="Diagram showing: AI chat session ID embedded in links, member completes action, conversion recorded in Nexudus" />
</Frame>

## How session IDs work

Every conversation has a unique **session ID** — a long random identifier. On the chat channel, it is generated when the chat window opens. On email and WhatsApp, it is generated when a new conversation starts (see [Channels](./channels) for session duration details).

This session ID is automatically embedded in every call-to-action link the AI generates:

* Day pass purchase links
* Membership plan sign-up / checkout links
* Private office tour request links
* Booking confirmation links

When a person follows one of these links and completes the action, the session ID travels with them through checkout or the tour form. Nexudus uses it to look up the originating conversation and stores the outcome against that session's messages.

For actions completed directly through the AI — such as creating a booking via the confirmation flow on any channel — the session ID is already known and the conversion is recorded automatically without requiring a link click.

## Tours / Visitor conversions

**What triggers it:** A prospect clicks "Request a tour for \[Office]" from the AI's private office response and submits the tour request form.

**What Nexudus records:** A new **Visitor** record is created (or an existing one is updated) with the chat session ID stored in its custom fields.

**Where you see it:** The [AI Conversations list](./admin-panel) shows a **"Tour booked"** badge (lavender) linking to the Visitor record. The Visitor record itself also shows the full AI conversation that led to the tour.

## Contract / sign-up conversions

**What triggers it:** A prospect clicks "Sign up for \[Plan]" from the AI's membership plan response and completes checkout.

**What Nexudus records:**

* A **CoworkerContract** record is created and linked to the session.
* If the person was not already in Nexudus, a new **Coworker** (customer) record is also created and linked.

**Where you see it:** The conversation row shows a **"Contract created"** badge (blue) and, if applicable, a **"Customer created"** badge (green).

## Booking conversions

**What triggers it:** A member creates a booking through the AI's confirmation flow — on any channel.

**What Nexudus records:** A **Booking** record is created and linked to the session.

**Where you see it:** The conversation row shows a **"Booking created"** badge (teal) linking to the Booking record.

## Day pass conversions

**What triggers it:** A member or visitor clicks "Get a day pass" from the AI's day pass response and completes the purchase.

**What Nexudus records:** A **CoworkerProduct** record is created and linked to the session.

**Where you see it:** The conversation row shows a **"Day pass purchased"** badge (peach).

## Conversion summary

| Outcome              | Badge              | Colour   | Links to                |
| -------------------- | ------------------ | -------- | ----------------------- |
| Tour arranged        | Tour booked        | Lavender | Visitor record          |
| New customer created | Customer created   | Green    | Coworker record         |
| Membership started   | Contract created   | Blue     | CoworkerContract record |
| Booking made         | Booking created    | Teal     | Booking record          |
| Day pass bought      | Day pass purchased | Peach    | CoworkerProduct record  |

A single conversation can produce multiple badges — for example, a new prospect who signs up for a membership generates both a "Customer created" and a "Contract created" badge.

<Frame>
  <img alt="AI Conversations list showing multiple rows with all four types of conversion badge" />
</Frame>

<Note>
  Conversations with no badges are still valuable. They may represent members asking questions, or prospects who browsed but have not yet converted. Reviewing unconverted conversations can surface friction points in your sales process.
</Note>


# Day Passes
Source: https://learn.nexudus.com/member-portal/ai/day-passes

How the AI presents and sells day passes to members and visitors across all channels.

The AI can list your available day passes and provide direct purchase links. This capability works for both logged-in members and anonymous visitors — no account is required to see day passes or click the purchase link. It works on all channels: chat, email, WhatsApp, and voice. On voice, the AI describes the available passes and offers to send a purchase link via email or WhatsApp.

<Frame>
  <img alt="Chat showing a day pass enquiry with the day pass card showing name, price, description, and Get a day pass button" />
</Frame>

## What the AI shows

### Day pass products

For each eligible day pass product, the AI presents:

* Name and description
* Price (if *Show price to AI* is enabled)
* Location name and address
* Distance from the user (if location permission granted)
* A **"Get a day pass"** button linking directly to the purchase page

If the budget is mentioned in the conversation ("I'm looking for something under £30"), the AI filters results to passes at or below that amount.

### Bookable resources

In addition to day pass products, the AI also shows bookable resources of the following types:

* **Day Pass** — bookable day pass desks or areas
* **Day Office** — private offices available for day use
* **Hot Desk** — flexible hot-desking spots

For each bookable resource, the AI presents:

* Name and type
* Capacity (number of people)
* Location name and address
* Distance from the user (if location permission granted)
* Features (e.g. monitor, standing desk, quiet zone)

Up to 5 bookable resources are shown, sorted by distance (if location is available) or alphabetically by name.

## Visibility rules

| Condition                               | What the AI does                                                                                 |
| --------------------------------------- | ------------------------------------------------------------------------------------------------ |
| *Available to AI* = off                 | Pass is never mentioned                                                                          |
| *Available to AI* = on, *Visible* = on  | Full details and purchase link are shown                                                         |
| *Available to AI* = on, *Visible* = off | AI tells the user that options are available and to contact the team — no price or link is shown |
| *Show price to AI* = off                | Pass is described without a price                                                                |
| *Price for AI* is set                   | That price is shown instead of the regular price                                                 |

*Notes for AI* are used by the AI to enrich its description of the pass — they are not shown word-for-word but are incorporated naturally into the response.

Archived passes are never shown regardless of other settings.

<Frame>
  <img alt="Admin settings for a day pass product showing the AI visibility fields" />
</Frame>

## Conversion tracking

The purchase link generated by the AI contains the **session ID** of the current conversation. When the member or visitor completes the purchase, Nexudus records the link between the day pass sale and the chat session.

This conversion appears as a **"Day pass purchased"** badge (peach colour) in the [AI Conversations list](./admin-panel), with a direct link to the CoworkerProduct record.

<Frame>
  <img alt="AI Conversations list showing a row with a Day pass purchased conversion badge" />
</Frame>

See [Conversion Tracking](./conversion-tracking) for a full explanation of how session IDs work.


# Escalating to Human Support
Source: https://learn.nexudus.com/member-portal/ai/escalation

How the AI escalates conversations to your help desk when it cannot resolve a request or when the user asks for human assistance.

When the AI cannot resolve a member's question or when the user explicitly requests human assistance, it can escalate the conversation to your help desk team. This creates a support ticket with full conversation context so your team can pick up where the AI left off.

## How escalation works

Escalation is **opt-in** for location operators. When enabled, the AI monitors conversations for signals that human help is needed:

* The user explicitly asks to speak to a person ("I need to talk to someone", "this isn't working", "help desk")
* The AI determines the question is outside its knowledge or capabilities
* The AI encounters a technical issue it cannot resolve

When escalation is triggered, the AI:

1. Summarises the user's issue in its own words
2. Creates a **Help Desk ticket** in Nexudus with the conversation context
3. Informs the user that their request has been passed to the team and provides an estimated response time (if configured)

<Frame>
  <img alt="Chat showing the AI informing the user that a human agent has been notified" />
</Frame>

## Configuration

Escalation settings are found under **Settings > AI Assistants (preview) > Channels > AI escalation** in your location settings.

### Enable AI escalation to human support

Toggle this on to allow the AI to create help desk tickets when it needs to escalate. When disabled, the AI will respond with a message that it cannot connect the user to a human agent.

* **Default:** Enabled

<Frame>
  <img alt="Settings page showing the AI escalation toggle switch" />
</Frame>

### Default escalation department

Select the **Help Desk department** where escalation tickets are created by default. If left empty, the system default department is used.

This lets you route AI escalations to a specific team — for example, a "Technical Support" department or your general "Help Desk" team.

### Response time SLA message

An optional message shown to users after escalation, such as "We usually respond within 2 hours." This sets expectations and reduces follow-up messages.

Leave empty to hide the response time message entirely.

## What the help desk ticket contains

When the AI creates an escalation ticket, it includes:

* **Subject:** A concise summary of the user's issue
* **Message text:** The AI's summary of the conversation, channel, and session details
* **Link to conversation:** A direct link to the full AI conversation in **AI Channel Sessions**
* **Priority:** Normal by default, or High if the user appeared frustrated or the issue was time-sensitive

<Note>
  The full conversation transcript is stored in the **AI Channel Sessions** interface, not in the ticket itself. This avoids duplication since the session already contains all the OpenAI messages. Your team clicks the link in the ticket to access the complete conversation history.
</Note>

## Department matching

The AI can optionally suggest a department based on the conversation content. It uses a fuzzy match against department names:

| User mentions                      | AI suggests |
| ---------------------------------- | ----------- |
| Payment, invoice, pricing, billing | Billing     |
| Booking, access, facilities, room  | Operations  |
| Contract, plan, membership, tariff | Membership  |

If a match is found, the AI includes it as a hint when creating the ticket. Your configured **default escalation department** is still used as the final destination.

## Conversation history

Escalated conversations appear in the [AI Conversations list](https://dashboard.nexudus.comoperations/aiConversations/aiChannelSessions) with a **"Escalated"** badge (orange colour). The conversation record includes:

* A timeline entry showing when the escalation occurred
* A direct link to the created Help Desk ticket for quick access
* The complete conversation history accessible in the **Conversation** section

From the Help Desk ticket, your team can also link back to the full AI conversation. See [Conversion Tracking](./conversion-tracking) for a full explanation of session IDs and how conversations are tracked.

## Bidirectional links

The escalation creates a permanent two-way connection between the AI conversation and the Help Desk ticket:

**In the AI Conversations view:**

* A **"Escalated to Help Desk"** callout appears at the top of the conversation, with a link to the support ticket
* A **timeline entry** at the bottom of the conversation shows the escalation event and links to the ticket

<Frame>
  <img alt="" />
</Frame>

**In the Help Desk ticket:**

* A **"AI Conversation"** callout appears at the top of the ticket, with a link to the full AI session
* This lets your team quickly jump back to the complete conversation history when responding to the ticket

<Frame>
  <img alt="" />
</Frame>

This bidirectional linking makes it easy for your team to understand the full context without having to search for related records.


# Answering Questions
Source: https://learn.nexudus.com/member-portal/ai/faq

How the AI uses your published FAQ articles to answer member and visitor questions across chat, email, WhatsApp, and voice.

When a member or visitor asks a general question — opening hours, parking, pet policy, Wi-Fi access — the AI searches your published FAQ articles and summarises the most relevant answer. This works on all channels: chat, email, WhatsApp, and voice.

<Frame>
  <img alt="Chat showing a question answered from an FAQ article" />
</Frame>

## How the search works

The search is **semantic**, not keyword-based. The AI understands the *meaning* of the question, so a question like "can I bring my dog?" will correctly find an article titled "Pet Policy" even though the words do not match exactly. This makes the AI effective at answering questions phrased in natural, conversational language.

The AI uses a similarity threshold — if no article is close enough in meaning to the question, it says clearly that it could not find an answer rather than guessing.

## Language handling

The indexed content for each FAQ article is based on the **default language** of your location. This means the AI searches and matches against the original language text of your articles, not against any translations you may have provided.

The agent is able to understand questions and respond in different languages, but the underlying knowledge it draws from always comes from the default language version of each article. For example, if your location's default language is English and a member asks a question in French, the AI will search the English version of your FAQ articles and respond in French based on that content.

If you provide translated versions of your FAQ articles, these will not be indexed or used by the AI for search matching.

## Access control

FAQ access is controlled by the **Access > FAQs** setting in your portal configuration:

| Setting           | Who gets answers                                                                  |
| ----------------- | --------------------------------------------------------------------------------- |
| **Everyone**      | Any visitor, whether logged in or not                                             |
| **Only members**  | Members only — contacts and anonymous visitors are told they need to be a member  |
| **Only contacts** | Contacts only — members and anonymous visitors are told they need to be a contact |

This setting is shared between the FAQ page and the AI assistant. Changing it affects both.

<Frame>
  <img alt="Portal settings page showing the FAQ access control dropdown" />
</Frame>

## What to put in your FAQ articles

The AI can only answer questions that are covered by your published articles. A few tips for getting the most out of this capability:

* Write articles in plain, conversational language — the AI searches by meaning, so natural phrasing works better than formal headings.
* Cover the questions your front desk team hears most often: opening times, access, parking, printers, meeting room booking rules, guest policies, etc.
* Keep each article focused on one topic so the AI can find the most relevant match.

<Tip>
  You do not need to do anything special to make your FAQ articles available to the AI — publishing them in Nexudus is sufficient. The AI automatically indexes them.
</Tip>

## Conversion tracking

This capability is informational only — it does not produce a conversion record. FAQ interactions are still stored in the [AI Conversations list](./admin-panel) as part of the full session history.


# Locations & Rooms
Source: https://learn.nexudus.com/member-portal/ai/locations-and-rooms

How the AI presents your space locations and browsable meeting rooms and resources across all channels.

The AI can tell members and visitors where you are and what spaces are available to book. These two capabilities — location information and room details — are informational: they help people find and evaluate your space rather than directly completing a transaction. They work on all channels: chat, email, WhatsApp, and voice.

## Location information

When asked about your space — "where are you?", "what cities are you in?", "how far is your nearest location?" — the AI returns details for matching locations in your Nexudus network.

Each location result includes the name, full address, description, and (when the user has granted browser location permission on the chat or voice channel) the distance from their current position. Distance information is available on chat (via browser permission) and voice (via caller location or manual entry). On email, distance is not available. Up to five locations are shown, ordered by proximity when available.

<Frame>
  <img alt="Chat showing a location enquiry with the location card response" />
</Frame>

Location information is always public — there are no membership or contact restrictions on this capability.

## Room and resource details

Members and prospects can ask what meeting rooms, event spaces, or desks you have available: "do you have a room for 10 people?", "what facilities does the boardroom have?", "show me rooms near me."

The AI returns up to five matching resources, ordered by distance, with:

* Room name and description
* Location name and address
* Capacity
* Available features (projector, whiteboard, video conferencing, etc.)
* Available desk positions within the resource
* Distance from the user (if location permission granted)
* A "Request booking" link and map link

<Frame>
  <img alt="Chat showing a room enquiry with the room card showing photo, capacity, features, and a Request booking button" />
</Frame>

### Access control for rooms

The AI respects the standard visibility settings on each resource:

| Setting               | Effect                                       |
| --------------------- | -------------------------------------------- |
| **Visible = off**     | Resource is never shown in AI responses      |
| **Only for members**  | Resource is only shown to logged-in members  |
| **Only for contacts** | Resource is only shown to logged-in contacts |

Resources that do not meet these conditions are silently excluded — the AI does not tell the user they exist.

## Conversion tracking

Both capabilities are informational only. Browsing rooms often precedes a booking — see [Room Bookings](./bookings) for how the AI handles the actual booking step.


# Membership Plans
Source: https://learn.nexudus.com/member-portal/ai/membership-plans

How the AI presents and sells membership plans — hot desks, dedicated desks, and virtual offices — across all channels.

The AI can present your membership plans and generate direct sign-up links for prospects. This is the primary sales tool for recurring memberships and works on all channels: chat, email, WhatsApp, and voice. On voice, the AI describes the plans and offers to send a sign-up link via email or WhatsApp.

<Frame>
  <img alt="Chat showing a membership plan enquiry, AI asks for start date, then shows plan cards with pricing and sign-up button" />
</Frame>

<Frame>
  <img alt="Chat showing a membership plan enquiry, AI asks for start date, then shows plan cards with pricing and sign-up button" />
</Frame>

## Start date requirement

A start date is required to generate a valid checkout link. If the prospect has not mentioned one, the AI asks for it before presenting plans. Once a start date is provided, each plan card includes a **"Sign up for \[Plan Name]"** button that takes the prospect directly to checkout with the plan and start date pre-selected.

## What the AI shows

For each eligible plan, the AI presents:

* Name and description
* Monthly price (if *Show price to AI* is enabled)
* Sign-up fee (if applicable)
* Billing cycle
* Notice period
* Whether the plan includes time passes or booking credits
* Location name, address, and distance from the user
* A **"Sign up for \[Plan Name]"** call-to-action button

Up to five visible plans are shown per request.

## Plan types

The AI understands natural-language descriptions of plan types and maps them to the correct tariff categories in Nexudus:

| What the prospect says                               | What Nexudus searches                          |
| ---------------------------------------------------- | ---------------------------------------------- |
| Hot desk / flexible desk / coworking                 | Full-time and part-time hot desk tariffs       |
| Dedicated desk / fixed desk                          | Full-time and part-time dedicated desk tariffs |
| Virtual office / postal address / registered address | Virtual office and virtual tariffs             |

## Visibility rules

| Condition                               | What the AI does                                                       |
| --------------------------------------- | ---------------------------------------------------------------------- |
| *Available to AI* = off                 | Plan is never mentioned                                                |
| *Available to AI* = on, *Visible* = on  | Full details and sign-up link are shown                                |
| *Available to AI* = on, *Visible* = off | AI acknowledges options exist and directs the user to contact the team |
| *Show price to AI* = off                | Plan is described without a price                                      |
| *Price for AI* is set                   | That price is shown instead of the regular price                       |

*Notes for AI* are incorporated naturally into the AI's description of the plan. Archived tariffs are never shown.

<Frame>
  <img alt="AI visibility fields on a membership plan tariff in the Nexudus admin" />
</Frame>

## Conversion tracking

The sign-up link contains the **session ID**, the selected tariff ID, and the chosen start date. When the prospect completes checkout and a contract is created in Nexudus, the system records the link between that contract and the chat session.

This produces up to two conversion badges in the [AI Conversations list](./admin-panel):

* **"Customer created"** (green) — if the person was not already in Nexudus as a customer
* **"Contract created"** (blue) — for the membership contract itself

<Frame>
  <img alt="AI Conversations list showing a row with Customer created and Contract created badges" />
</Frame>

See [Conversion Tracking](./conversion-tracking) for a full explanation of how session IDs work.


# Portal Navigation
Source: https://learn.nexudus.com/member-portal/ai/navigation

How the AI shares direct links to pages in your members portal — bookings, store, profile settings, and more.

The AI can share direct links to any page in your members portal. When a member or visitor asks to "book a room", "view my invoices", "edit my billing details", or "sign up for a membership", the AI responds with a clickable link that takes them directly to the relevant page.

## How it works

The AI maintains an internal map of every available page in your portal, each with a short description and the correct URL. When the user's intent matches one of these pages, the AI returns the corresponding link.

The mapping is built from your portal configuration — page keys, descriptions, and URLs are generated from your space's home page and web address. If your portal has a contact page enabled, it is automatically included.

## Available pages

The following pages are always available:

| Page key            | Description                          |
| ------------------- | ------------------------------------ |
| `book-room`         | Book a meeting room or resource      |
| `booking-calendar`  | View the booking calendar            |
| `day-passes`        | Browse or buy day passes             |
| `store`             | Browse products and services         |
| `membership-signup` | Sign up for a membership plan        |
| `perks`             | View community perks and benefits    |
| `blog`              | Read the blog                        |
| `events`            | Browse upcoming events               |
| `courses`           | Browse courses                       |
| `book-tour`         | Book a tour of the space             |
| `login`             | Log in to your account               |
| `faq`               | Browse frequently asked questions    |
| `contact`           | Contact the team or speak to a human |

When a member is logged in, additional personal pages become available:

| Page key            | Description                          |
| ------------------- | ------------------------------------ |
| `my-invoices`       | View my invoices and payment history |
| `my-bookings`       | View my upcoming and past bookings   |
| `my-plan`           | View or manage my membership plan    |
| `help-desk`         | Submit or view support tickets       |
| `visitors`          | Manage visitor registrations         |
| `deliveries`        | View my deliveries                   |
| `booking-settings`  | Manage booking preferences           |
| `virtual-office`    | Manage virtual office settings       |
| `directory-profile` | Edit my community directory profile  |
| `personal-details`  | Edit my personal details             |
| `billing-details`   | Edit my billing and payment details  |

The AI matches the user's intent to the correct page key using semantic understanding, so it works in any language. A request like "quiero ver mis facturas" will correctly resolve to the `my-invoices` page even though the words do not match exactly.

## Link format

The AI shares links in Markdown format, for example:

> [View my invoices](https://portal.your-space.com/my-invoices)

On all channels — chat, email, WhatsApp, and voice — the link is rendered as clickable text. Members simply tap or click to navigate.

## Access control

Navigation links respect your existing portal access settings. If a page is restricted to members only, the link is still shared, but the member may be prompted to log in when they follow it.

## What the AI does not do

The navigation tool only returns a link — it does not open the page, fill in forms, or perform any action on the user's behalf. It is a way to get the user to the right place quickly, after which they interact with the portal directly.

## Conversion tracking

Navigation links embed the session ID so that follow-up actions (a booking, a purchase, a tour request) can be linked back to the conversation that generated the link. See [Conversion Tracking](./conversion-tracking) for details.


# AI Assistant
Source: https://learn.nexudus.com/member-portal/ai/overview

A conversational front-desk agent that helps members manage bookings and guides prospects toward membership — across chat, email, WhatsApp, and voice — without manual effort from your team.

<Warning>
  The AI assistant is currently in **beta**. OpenAI is the current subprocessor for AI models. Access is free of charge during the Beta phase, but pricing may change in the future.
</Warning>

The Nexudus AI assistant answers questions, helps members manage their bookings, and guides prospects toward purchasing a day pass, signing up for a membership, or scheduling a private office tour.

It works across four channels:

* **Chat** — a floating widget embedded in your members portal. *(enabled by default)*
* **Email** — members and prospects send an email to your space's AI address and receive a reply. *(requires email forwarding setup)*
* **WhatsApp** — members and prospects message your space's WhatsApp number and receive a reply. *(requires Twilio + Meta setup)*
* **Voice** — members and prospects call your space's phone number and speak with the AI. *(requires ElevenLabs + Twilio setup)*

<Warning>
  **Chat is the only channel that works immediately.** Email, WhatsApp, and Voice all require additional configuration before they can accept conversations:

  * **Email** — you need to set up email forwarding from your chosen address to the Nexudus AI inbox. See [Setting up the Email channel](./setup-email).
  * **WhatsApp** — you need a Twilio account, Meta business verification, and webhook configuration. See [Setting up the WhatsApp channel](./setup-whatsapp).
  * **Voice** — you need an ElevenLabs account (for the AI agent, speech-to-text, and text-to-speech) and a Twilio account (for phone connectivity and SMS link delivery). See [Setting up the Voice channel](./setup-voice).

  All four channels share the same capabilities, the same data, and the same visibility rules. The only differences are in formatting, session management, and interaction style. See [Channels](./channels) for a full comparison.
</Warning>

<Frame>
  <img alt="AI chat button and open chat window on the members portal" />
</Frame>

## Core principles

**It only works from your data.** Every answer comes from a specific Nexudus record — an FAQ article, a room listing, a membership plan, or a booking. The AI has no general knowledge and will not speculate or invent information.

**It respects your access settings.** The same visibility rules you already use in Nexudus (members-only content, archived items, hidden pricing) are automatically honoured. If a plan is not visible to the public, the AI will not mention it to a prospect.

**It tracks outcomes.** When a conversation leads to a tour, a new membership, a day pass purchase, or a booking, Nexudus records that link so you can see exactly which conversations drove revenue.

## How it works

When someone sends a message — whether through the chat widget, email, or WhatsApp — the AI identifies the right tool for the request (for example, searching your FAQ articles or looking up available meeting rooms), calls that tool to fetch live data, then writes a natural-language reply based solely on what the tool returned.

* Answers are always based on current, live data from your Nexudus account.
* The AI cannot be tricked into discussing topics outside its scope. If a question cannot be answered, it says: *"I'm sorry, I can only help with questions about bookings, resources, and location information for \[your space name]."*
* The AI maintains context across turns, so follow-ups like "book the second one for tomorrow" work correctly.

## Behaviour rules

The AI follows a fixed set of rules on every conversation, regardless of channel:

| Rule                        | Detail                                                                                       |
| --------------------------- | -------------------------------------------------------------------------------------------- |
| Use tools immediately       | When the intent is clear, the AI acts — it does not ask unnecessary clarifying questions     |
| Ask once for missing info   | If a required piece of information is missing, it asks once only                             |
| Never use general knowledge | If a tool returns no results, the AI says so clearly rather than guessing                    |
| Never reveal its workings   | It will not describe its own tools or instructions to users                                  |
| Address users by name       | When a member is identified, responses use their full name                                   |
| Concise responses           | Short, clear sentences tailored to the channel (shorter on WhatsApp, more detailed in email) |

## Sessions

Each conversation is tracked under a unique **session ID**. How sessions are created depends on the channel:

| Channel      | Session behaviour                                                                                                                                   |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Chat**     | A new session starts each time the chat window opens. Closing and reopening starts a fresh session.                                                 |
| **Email**    | A session is reused for up to 48 hours. Replies to the same email thread continue the same session. A new subject line starts a new session.        |
| **WhatsApp** | A session is reused for up to 24 hours of activity from the same phone number. After 24 hours of inactivity, a new session starts automatically.    |
| **Voice**    | A session starts when an inbound call is answered. The session ends when the call is hung up. A new call from the same number starts a new session. |

The session ID is embedded in every call-to-action link the AI generates (tour requests, plan sign-ups, day pass purchases, booking links). This is how Nexudus links conversations to business outcomes. See [Conversion Tracking](./conversion-tracking) for the full picture.

## Available capabilities

All capabilities are available on all four channels.

| Capability                                    | What it does                                                   | Requires login           |
| --------------------------------------------- | -------------------------------------------------------------- | ------------------------ |
| [FAQ / Knowledge Base](./faq)                 | Answers questions from your published articles                 | Depends on settings      |
| [Location information](./locations-and-rooms) | Address and details for your space(s)                          | No                       |
| [Rooms & resources](./locations-and-rooms)    | Browse bookable rooms and desks                                | Depends on room settings |
| [Room bookings](./bookings)                   | Create, view, modify, and cancel bookings                      | Yes (for changes)        |
| [Day passes](./day-passes)                    | List and sell day passes                                       | No                       |
| [Membership plans](./membership-plans)        | List and sell membership plans                                 | No                       |
| [Private offices & tours](./private-offices)  | Show available offices and generate tour links                 | No                       |
| [Visitor approvals](./visitor-approvals)      | Approve or reject pending visitor requests                     | Yes                      |
| [Escalation](./escalation)                    | Create a help desk ticket when the AI cannot resolve a request | No                       |
| [Portal navigation](./navigation)             | Share direct links to any page in your members portal          | No                       |


# Private Offices & Tours
Source: https://learn.nexudus.com/member-portal/ai/private-offices

How the AI presents available private offices and generates personalised tour request links across all channels.

The AI can show available private offices and generate tour request links for prospects interested in a dedicated office for their team. Because private offices typically involve a human conversation before signing a contract, the AI's role here is to surface options and route the prospect to a tour — not to complete the sale directly. This works on all channels: chat, email, WhatsApp, and voice. On voice, the AI describes available offices and offers to send a tour request link via email or WhatsApp.

<Frame>
  <img alt="Chat showing a private office enquiry, AI asks for requirements, then shows available offices with Request a tour button" />
</Frame>

<Frame>
  <img alt="Chat showing a private office enquiry, AI asks for requirements, then shows available offices with Request a tour button" />
</Frame>

## How the AI collects requirements

The AI gathers the prospect's needs before presenting offices:

* **Move-in date** — when they want to start
* **Team size** — minimum capacity needed
* **Monthly budget** — optional upper limit

If any of these are missing, the AI asks for them. It does not present offices until it has enough information to filter accurately.

## What the AI shows

For each matching office, the AI presents:

* Office name and description
* Capacity
* Monthly price (if *Show price to AI* is enabled)
* Floor plan location within the building
* Location name, address, and distance from the prospect
* Notes (drawn from *Notes for AI*)
* A **"Request a tour for \[Office Name]"** link

## Availability logic

The AI checks live contract data to determine each office's status and decides what to show:

| Status            | Condition                              | What the AI shows                                          |
| ----------------- | -------------------------------------- | ---------------------------------------------------------- |
| **Available now** | No active contract on the office       | Full details and tour link                                 |
| **Coming soon**   | Active contract with a known end date  | Full details, tour link, and the date it becomes available |
| **Not shown**     | Active contract with no known end date | Office is silently excluded                                |

This means the AI never presents an office that has no foreseeable availability — reducing wasted tour requests.

## Visibility rules

| Condition                | What the AI does                                      |
| ------------------------ | ----------------------------------------------------- |
| *Available to AI* = off  | Office is never mentioned                             |
| *Available to AI* = on   | Office is shown (subject to availability logic above) |
| *Show price to AI* = off | Office is described without a price                   |
| *Price for AI* is set    | That price is shown instead of the regular price      |

*Notes for AI* are incorporated naturally into the AI's description of the office.

<Frame>
  <img alt="AI visibility fields on a private office floor plan item in the Nexudus admin" />
</Frame>

## Conversion tracking

The tour request link contains the **session ID** and a summary of the prospect's stated requirements (capacity, budget, move-in date). When the prospect submits the tour request form, Nexudus creates a **Visitor** record and links it to the chat session.

This appears as a **"Tour booked"** badge (lavender colour) in the [AI Conversations list](./admin-panel), with a direct link to the Visitor record.

Additionally, the full AI conversation that led to the tour is embedded directly on the Visitor record — giving your team context before the visit. See [Monitoring Conversations](./admin-panel#ai-conversations-in-visitor-records) for details.

<Frame>
  <img alt="AI Conversations list showing a row with a Tour booked conversion badge" />
</Frame>

See [Conversion Tracking](./conversion-tracking) for a full explanation of how session IDs work.


# Setting Up the Email Channel
Source: https://learn.nexudus.com/member-portal/ai/setup-email

Step-by-step guide to enabling the AI assistant's email channel so members and prospects can interact with the AI by sending emails.

The email channel lets members and prospects interact with your AI assistant by sending an email. Instead of chatting through the portal widget, they write a regular email and receive a reply — with all the same AI capabilities running behind the scenes.

This guide walks through the full setup process: enabling the channel in Nexudus, configuring your inbox to forward messages, and verifying everything works.

## Before you start

<Check>
  Make sure the AI assistant is already enabled for your space. The email channel is an extension of the existing AI assistant — it will not work unless the base AI assistant is active.
</Check>

You need:

* **Administrator access** to your Nexudus account.
* **Access to your email provider's settings** (Gmail, Outlook, or any provider that supports automatic forwarding).

No third-party accounts or additional subscriptions are required.

## How the email channel works

When you enable the email channel, Nexudus generates a dedicated **AI inbox address** for your space. Any email sent to this address (or forwarded to it) is processed by the AI assistant, which reads the message, runs the appropriate tools, and sends a reply email back to the sender.

The reply comes from your space's AI assistant, with your space name in the sender field, so members see a branded response rather than a generic system email.

<Frame>
  <img alt="Diagram showing the email flow: member sends email to your inbox, inbox auto-forwards to Nexudus AI inbox, AI processes the message, and replies directly to the member" />
</Frame>

## Step 1 — Enable the email channel in Nexudus

<Steps>
  <Step title="Open your AI settings">
    In the Nexudus administration panel, go to [**Settings > Channels > Email**](https://dashboard.nexudus.com/settings/5/0/1).
  </Step>

  <Step title="Switch on AI Email">
    Toggle the **AI Email** setting to on. This activates the email channel for your space.
  </Step>

  <Step title="Copy your AI inbox address">
    Once enabled, Nexudus displays your space's **AI inbox address**. This is the address you will forward emails to. It looks like:

    ```
    ai+{your-business-id}@mail.nexudus.com
    ```

    Copy this address — you will need it in the next step.

    <Frame>
      <img alt="AI settings in Nexudus showing the AI Email toggle and the generated AI inbox address" />
    </Frame>
  </Step>
</Steps>

## Step 2 — Set up email forwarding

The email channel works by forwarding emails from an address you control — such as `hello@yourspace.com` or `ai@yourspace.com` — to the Nexudus AI inbox address. You can use any email address you like; it does not need to be a specific format.

<Tip>
  We recommend creating a **dedicated email address** for AI interactions (for example, `ai@yourspace.com` or `assistant@yourspace.com`) rather than forwarding your main inbox. This keeps AI conversations separate from your regular email and makes it clear to members where to write.
</Tip>

Choose your email provider below for specific forwarding instructions:

<Tabs>
  <Tab title="Gmail / Google Workspace">
    ### Set up forwarding in Gmail

    You can either forward **all incoming email** to the Nexudus AI inbox, or use a **filter** to forward only messages sent to a specific address (recommended if you are using a shared inbox).

    <Tabs>
      <Tab title="Forward all email">
        <Steps>
          <Step title="Open Gmail settings">
            In Gmail, click the **gear icon** in the top-right corner, then click **See all settings**.
          </Step>

          <Step title="Go to Forwarding and POP/IMAP">
            Click the **Forwarding and POP/IMAP** tab.
          </Step>

          <Step title="Add a forwarding address">
            Click **Add a forwarding address** and paste your Nexudus AI inbox address (`ai+{your-business-id}@mail.nexudus.com`).
          </Step>

          <Step title="Confirm the forwarding address">
            Google sends a confirmation email to the Nexudus address. Check your Nexudus AI inbox and **click the confirmation link** in that email to activate forwarding.

            <Note>
              If you don't see the confirmation email within a few minutes, check your spam or junk folder. The email comes from Google and contains a button or link to confirm the forwarding address.
            </Note>
          </Step>

          <Step title="Enable forwarding">
            Select **Forward a copy of incoming mail to** and choose your Nexudus AI inbox address from the dropdown.

            Choose **Keep Gmail's copy in the Inbox** so you retain a copy of every message.
          </Step>

          <Step title="Save changes">
            Scroll down and click **Save Changes**.
          </Step>
        </Steps>

        This approach forwards everything that arrives in the inbox to the AI. It works well when the inbox is **dedicated to AI interactions** (for example, `ai@yourspace.com`).
      </Tab>

      <Tab title="Forward with a filter (recommended)">
        Use a filter when the inbox also receives other email and you only want messages sent to a specific address to reach the AI — for example, forwarding only messages addressed to `ai@yourspace.com` while leaving other mail untouched.

        <Steps>
          <Step title="Open Gmail settings">
            In Gmail, click the **gear icon** in the top-right corner, then click **See all settings**.
          </Step>

          <Step title="Add the forwarding address first">
            Go to the **Forwarding and POP/IMAP** tab. Click **Add a forwarding address** and paste your Nexudus AI inbox address (`ai+{your-business-id}@mail.nexudus.com`).

            Google sends a confirmation email to the Nexudus address. Check your Nexudus AI inbox and **click the confirmation link** in that email to activate forwarding. You do **not** need to enable "Forward a copy of incoming mail" — the filter will handle forwarding selectively.
          </Step>

          <Step title="Go to Filters and Blocked Addresses">
            Click the **Filters and Blocked Addresses** tab, then click **Create a new filter**.
          </Step>

          <Step title="Set the filter criteria">
            In the **To** field, enter the email address you want to use for AI interactions — for example, `ai@yourspace.com`.

            Click **Create filter**.
          </Step>

          <Step title="Set the filter action">
            Tick **Forward it to** and select your Nexudus AI inbox address from the dropdown.

            Optionally, also tick **Skip the Inbox (Archive it)** if you do not want AI-bound messages cluttering the inbox, or leave it unticked to keep a copy visible.

            Click **Create filter**.
          </Step>
        </Steps>

        <Tip>
          The filter approach is ideal when you use a Google Workspace group or alias (for example, `ai@yourspace.com` as an alias on a shared inbox). Only messages addressed to that alias are forwarded to the AI, while everything else stays in the inbox as normal.
        </Tip>
      </Tab>
    </Tabs>

    <Frame>
      <img alt="Gmail forwarding settings showing the Nexudus AI inbox address configured as the forwarding destination" />
    </Frame>

    For more detail, see Google's guides: [Automatically forward Gmail messages](https://support.google.com/mail/answer/10957) and [Create rules to filter your emails](https://support.google.com/mail/answer/6579).
  </Tab>

  <Tab title="Microsoft 365 / Outlook">
    ### Set up forwarding in Microsoft 365

    <Steps>
      <Step title="Open the Microsoft 365 admin centre">
        Go to [admin.microsoft.com](https://admin.microsoft.com) and sign in with your administrator account.
      </Step>

      <Step title="Navigate to mail flow rules">
        Go to **Admin centres > Exchange > Mail flow > Rules**.
      </Step>

      <Step title="Create a new rule">
        Click **+ Add a rule > Create a new rule**.
      </Step>

      <Step title="Configure the rule">
        * **Name:** AI Assistant Forwarding
        * **Apply this rule if:** The recipient is `ai@yourspace.com` (or whichever address you are using)
        * **Do the following:** Redirect the message to your Nexudus AI inbox address (`ai+{your-business-id}@mail.nexudus.com`)
      </Step>

      <Step title="Save and enable">
        Click **Save**. The rule takes effect within a few minutes.
      </Step>
    </Steps>

    <Frame>
      <img alt="Microsoft 365 Exchange mail flow rule configured to redirect messages to the Nexudus AI inbox address" />
    </Frame>

    Alternatively, for a single mailbox, open **Outlook on the web > Settings > Mail > Forwarding** and enter the Nexudus AI inbox address. For more detail, see Microsoft's guide: [Configure email forwarding in Microsoft 365](https://learn.microsoft.com/en-us/microsoft-365/admin/email/configure-email-forwarding).
  </Tab>

  <Tab title="Other email providers">
    ### General forwarding setup

    Most email providers support automatic forwarding. The exact steps vary, but the general process is:

    <Steps>
      <Step title="Find the forwarding settings">
        Look for **Forwarding**, **Auto-forward**, or **Mail flow rules** in your email provider's settings. This is sometimes under **Filters** or **Rules**.
      </Step>

      <Step title="Add the Nexudus AI inbox address">
        Create a rule or forwarding configuration that sends a copy of all incoming messages (or messages to a specific address) to your Nexudus AI inbox address:

        ```
        ai+{your-business-id}@mail.nexudus.com
        ```
      </Step>

      <Step title="Keep a copy in your inbox">
        If your provider offers the option, choose to keep a copy of forwarded messages in the original inbox.
      </Step>

      <Step title="Save and test">
        Save the configuration and send a test email to verify it works (see Step 3 below).
      </Step>
    </Steps>

    If your email provider does not support automatic forwarding, contact your IT administrator or email hosting provider for assistance.
  </Tab>
</Tabs>

## Step 3 — Verify the setup

Once forwarding is configured, test the full flow to make sure everything works.

<Steps>
  <Step title="Send a test email">
    From a personal email address (not your forwarding address), send an email to the address you configured for AI interactions — for example, `ai@yourspace.com`. Use a simple question like:

    > What are your opening hours?
  </Step>

  <Step title="Wait for the AI reply">
    Within a few minutes, you should receive a reply from the AI assistant. The reply comes from your space's AI assistant address and includes your space name in the sender field.
  </Step>

  <Step title="Check the AI Conversations list">
    In the Nexudus administration panel, go to **Operations > AI Conversations**. You should see a new conversation with your test message. The **Channel** column will show **Email**.

    <Frame>
      <img alt="AI Conversations list showing a test email conversation with the Email channel badge" />
    </Frame>
  </Step>
</Steps>

<Warning>
  If you do not receive a reply within 5 minutes, check that forwarding is active in your email provider's settings and that you copied the Nexudus AI inbox address correctly. Also confirm that the AI Email setting is still enabled in Nexudus.
</Warning>

## Step 4 — Share the email address with your members

Once the channel is working, share the email address with your members and prospects. Common ways to do this:

* Add it to your **website contact page** alongside your other contact methods.
* Include it in your **welcome email** to new members.
* Add it to your **email signature** or auto-reply messages.
* Display it on **physical signage** in your space.

<Tip>
  You can also mention the email address in your FAQ articles. When members ask the chat assistant how to contact you by email, the AI can point them to the right address.
</Tip>

## How replies and threading work

When the AI replies to an email, the reply includes a special **Reply-To** address that embeds the session ID. This means:

* If the member replies to the AI's email, the reply is automatically routed to the same conversation session.
* The email thread in the member's inbox looks like a normal back-and-forth email conversation.
* After **48 hours** of inactivity, the session expires and the next email starts a fresh conversation.
* A new email with a different subject line also starts a new session.

The member does not need to know about any of this — threading is handled automatically.

## Frequently asked questions

<AccordionGroup>
  <Accordion title="Can I use my main inbox (e.g. hello@yourspace.com) instead of a dedicated address?">
    Technically yes — any email forwarded to the Nexudus AI inbox address is processed by the AI. However, we recommend a dedicated address to keep AI conversations separate from your regular email.
  </Accordion>

  <Accordion title="What happens if someone sends an email with attachments?">
    The AI processes the text content of the email only. Attachments are noted in the conversation (the AI acknowledges they were sent) but cannot be read or processed. The AI will inform the sender that only text messages are supported.
  </Accordion>

  <Accordion title="What if the sender's email does not match any customer record?">
    The AI still replies — but capabilities that require an identified member (such as viewing or managing bookings) are unavailable. The AI will let the sender know what it can help with.
  </Accordion>

  <Accordion title="Can I disable the email channel later?">
    Yes. Switch off **AI Email** in your business settings. Forwarded emails will no longer be processed. You should also disable the forwarding rule in your email provider to avoid sending emails to an inactive inbox.
  </Accordion>

  <Accordion title="Does this cost extra?">
    No. The email channel is included in the AI assistant feature. There are no additional charges for email-based conversations.
  </Accordion>
</AccordionGroup>


# Setting Up the Voice Channel
Source: https://learn.nexudus.com/member-portal/ai/setup-voice

Step-by-step guide to connecting the AI assistant to voice calls through ElevenLabs and Twilio, so members and prospects can interact with the AI by phone.

The Voice channel lets members and prospects interact with your AI assistant by calling your space's phone number. The AI processes the caller's spoken words using speech-to-text and replies using text-to-speech — creating a natural voice conversation, with all the same capabilities as the chat widget.

Setting up the Voice channel requires an **ElevenLabs account** and a **Twilio account** with Voice capabilities. This guide walks through the full process from account configuration to making a test call.

<Note>
  The Voice channel requires paid accounts on ElevenLabs and Twilio. Twilio charges per minute of call usage. See [Twilio's Voice pricing](https://www.twilio.com/en-us/voice/pricing) for current rates. The cost is typically low for conversational AI use cases, especially during after-hours when the AI handles routine inquiries.
</Note>

## Before you start

You need:

* **Administrator access** to your Nexudus account.
* **An ElevenLabs account** — provides the AI agent, speech-to-text (STT), and text-to-speech (TTS) engine. Sign up at [elevenlabs.io](https://elevenlabs.io).
* **A paid Twilio account** with Voice capabilities enabled (free trial accounts have limited Voice capabilities).
* **A phone number** that can receive inbound voice calls. This can be a new number purchased through Twilio or an existing number you own.

<Check>
  Make sure the AI assistant is already enabled for your space. The Voice channel is an extension of the existing AI assistant — it will not work unless the base AI assistant is active.
</Check>

## Overview

The setup involves four main stages:

<Frame>
  <img alt="Four-stage setup overview: 1. Create ElevenLabs agent, 2. Configure webhook tool, 3. Acquire Twilio number, 4. Connect to Nexudus" />
</Frame>

1. **Create an ElevenLabs agent** — Configure the AI agent with a prompt and the Nexudus webhook tool.
2. **Configure the webhook tool** — Point the agent's webhook to your Nexudus portal.
3. **Acquire a Twilio phone number** — Purchase or port a number for voice calls.
4. **Connect to Nexudus** — Link your Twilio number to the ElevenLabs agent, then enter credentials in Nexudus settings.

Each stage is covered in detail below.

***

## ElevenLabs credentials overview

The Voice channel uses **two separate credentials**, each serving a different purpose:

| Credential                       | Used for                                                                                                             | Where to find it                                                                      |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| **ElevenLabs Auth Token**        | Outbound calls — authenticates API requests when the AI initiates calls to members or prospects                      | ElevenLabs → Account Settings → API Keys                                              |
| **ElevenLabs Tool Bearer Token** | Inbound calls — a secret you create yourself to authenticate webhook requests from ElevenLabs to your Nexudus portal | [Nexudus → Settings > Channels > Voice](https://dashboard.nexudus.com/settings/5/0/3) |

The **ElevenLabs Tool Bearer Token** is required as soon as you enable the Voice channel for inbound calls. The **ElevenLabs Auth Token** is required only if you plan to use **outbound calling** — for example, when the AI proactively contacts a member about a booking confirmation, tour reminder, or follow-up.

<Note>
  Outbound calling also requires the **Agent ID** (your ElevenLabs agent's unique identifier) and the **Phone Number ID** (the ElevenLabs phone number linked to your Twilio number). These are configured in the same ElevenLabs account. See [Outbound calling](#outbound-calling) below for details.
</Note>

***

## Stage 1 — Create an ElevenLabs agent

Your AI voice agent is created in ElevenLabs. You will configure the agent with a prompt and a webhook tool that connects to your Nexudus portal.

<Steps>
  <Step title="Go to the Agents page">
    In your ElevenLabs account, navigate to [https://elevenlabs.io/app/agents](https://elevenlabs.io/app/agents).
  </Step>

  <Step title="Create a new agent">
    Click **Create Agent** and give it a name such as "Nexudus Voice Assistant" or your space's name followed by "AI Assistant".
  </Step>

  <Step title="Configure the agent prompt">
    In the agent's **Instructions** field, paste the following prompt:

    ```
    You are a helpful assistant. 
    - Forward user requests to the "nexudus" tool when you need information you have not already gathered. Do not make any answers up and always forward requests to the tool to get the proper answers.
    - Never read out links, these are sent by SMS automatically.
    ```

    This prompt instructs the agent to delegate all user requests to Nexudus through the webhook tool you will configure next.
  </Step>

  <Step title="Configure voice settings">
    Select a voice from the ElevenLabs voice library. Choose a voice that matches your brand personality — professional, friendly, or energetic.

    Adjust the **stability** and **similarity** settings to your preference. Lower stability gives more expressive speech; higher stability sounds more consistent.
  </Step>
</Steps>

***

## Stage 2 — Configure the webhook tool

The webhook tool is how your ElevenLabs agent communicates with your Nexudus portal. It sends user requests to Nexudus and receives AI responses back.

<Steps>
  <Step title="Add a tool to your agent">
    In your ElevenLabs agent configuration, go to the **Tools** section and click **Add Tool**.

    Select **Webhook** as the tool type.
  </Step>

  <Step title="Name the tool">
    Name the tool `nexudus`. This name must match the tool name referenced in your agent's prompt.
  </Step>

  <Step title="Configure the webhook settings">
    Set the following parameters:

    | Setting    | Value                                                                                                          |
    | ---------- | -------------------------------------------------------------------------------------------------------------- |
    | **Method** | `GET`                                                                                                          |
    | **URL**    | `https://{portal_sub_domain}.spaces.nexudus.com/api/public/ai/chats/elevenlabs/{eleventlabel_conversation_id}` |

    Replace `{portal_sub_domain}` with your Nexudus portal sub-domain. Go to **Settings > Website** in your Nexudus admin panel (e.g., `https://dashboard.nexudus.com/settings/2/0/0`) and copy the domain shown there. For example, if your portal is `mymembers.nexudus.com`, use `mymembers`.

    **Do not replace** `{eleventlabel_conversation_id}` — it is a path variable, not a placeholder. In the webhook tool settings below, you will map this variable to the `system__conversation_id` system variable so ElevenLabs passes the conversation ID at runtime.
  </Step>

  <Step title="Configure headers">
    Add the following header:

    | Header            | Value                      |
    | ----------------- | -------------------------- |
    | **Authorization** | `Bearer {your_secret_key}` |

    Replace `{your_secret_key}` with the value from the **Elevenlabs Tool Bearer Token** field. This is a secret you create yourself — go to [Settings > Channels > Voice](https://dashboard.nexudus.com/settings/5/0/3) in your Nexudus admin panel, type a strong secret key into the **Elevenlabs Tool Bearer Token** field, and save. Then use that same secret key here in your ElevenLabs webhook configuration. This ensures that only your Nexudus portal can verify incoming webhook requests from ElevenLabs.
  </Step>

  <Step title="Configure tool behavior">
    In the tool configuration, set the following:

    | Setting             | Value     |
    | ------------------- | --------- |
    | **Pre-tool speech** | Force     |
    | **Execution mode**  | Immediate |
  </Step>

  <Step title="Configure path parameters">
    Add the following path parameter:

    | Parameter                      | Value Type       | Variable Name             |
    | ------------------------------ | ---------------- | ------------------------- |
    | `eleventlabel_conversation_id` | Dynamic Variable | `system__conversation_id` |

    This tells ElevenLabs to substitute the conversation ID at runtime. The `system__conversation_id` is a built-in ElevenLabs variable that holds the unique ID for each conversation.
  </Step>

  <Step title="Configure query parameters">
    Add the following query parameters:

    | Parameter    | Required | Value Type       | Variable Name / Description       |
    | ------------ | -------- | ---------------- | --------------------------------- |
    | `prompt`     | Yes      | LLM Prompt       | The actual question from the user |
    | `caller_id`  | Yes      | Dynamic Variable | `system__caller_id`               |
    | `session_id` | No       | Dynamic Variable | `session_id`                      |
  </Step>

  <Step title="Add session_id variable assignment">
    In the **Dynamic Variable Assignments** section of the webhook tool configuration, add a new variable:

    | Setting           | Value        |
    | ----------------- | ------------ |
    | **Variable Name** | `session_id` |
    | **JSON Path**     | `session_id` |

    The **session\_id** variable is used to identify the caller's session context. This is separate from the query parameters section — ElevenLabs stores variable assignments in their own dedicated section in the tool configuration.
  </Step>

  <Step title="Save the tool">
    Click **Save** to add the webhook tool to your agent.
  </Step>
</Steps>

<Note>
  The webhook uses the **GET** method because ElevenLabs voice conversations send user input as query parameters. The `{portal_sub_domain}` placeholder must be replaced with your actual portal domain. The `{eleventlabel_conversation_id}` path variable is mapped to `system__conversation_id` in the webhook tool settings and is substituted at runtime by ElevenLabs.
</Note>

***

## Stage 3 — Acquire a Twilio phone number

<Steps>
  <Step title="Verify Voice capabilities">
    In the Twilio Console, go to **Account > Settings > Capabilities** and ensure that **Voice** is enabled for your account.

    If Voice is not enabled, contact Twilio support to activate it. Free trial accounts may need to be upgraded to a paid plan first.
  </Step>

  <Step title="Note your account credentials">
    In the Twilio Console, go to **Account > API keys & tokens**. You need two values:

    * **Account SID** — your account identifier
    * **Auth Token** — your account secret

    Keep these values safe. You will enter them in Nexudus later.
  </Step>
</Steps>

***

## Stage 4 — Acquire a phone number

You need a phone number that can receive inbound voice calls. You have two options:

| Option                          | Best for                                   | Details                                                                                                                                |
| ------------------------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Buy a number through Twilio** | Most operators                             | Twilio provides the number. No need to port an existing number. Go to **Phone Numbers > Manage > Buy a number** in the Twilio Console. |
| **Port your own number**        | Operators with an existing business number | You can keep your current number and port it to Twilio. This may take several business days.                                           |

<Note>
  The phone number should be able to receive inbound voice calls. Most Twilio numbers support this by default, but verify when purchasing.
</Note>

***

## Stage 4 — Connect to Nexudus

<Steps>
  <Step title="Connect Twilio to ElevenLabs">
    ElevenLabs can automatically configure all Twilio webhook settings for you:

    1. In ElevenLabs, go to  [**Deploy > Phone numbers**](https://elevenlabs.io/app/agents/phone-numbers).
    2. Click **Import Number > From Twilio**.
    3. Add a label, enter your phone number, and select or type a new **Twilio Account SID**.

    This configures all webhook settings in Twilio automatically — incoming calls will be routed to your ElevenLabs agent without any manual Twilio Console configuration.
  </Step>

  <Step title="Open your AI settings in Nexudus">
    In the Nexudus administration panel, go to [**Settings > Channels > Voice**](https://dashboard.nexudus.com/settings/5/0/3).
  </Step>

  <Step title="Switch on AI Voice">
    Toggle the **AI Voice** setting to on. This activates the voice channel for your space.
  </Step>

  <Step title="Enter your credentials and phone number">
    Enter the following values in the corresponding fields:

    * **Twilio Account ID** — your Twilio Account SID (found in the Twilio Console under **Account > API keys & tokens**)
    * **Twilio Auth Token** — your Twilio Auth Token (found in the Twilio Console under **Account > API keys & tokens**)
    * **SMS Phone Number** — the Twilio phone number in E.164 format (e.g., `+14155551234`). This number is used for SMS link delivery. See [SMS link delivery](/member-portal/ai/channels#sms-link-delivery) for details.

    <Frame>
      <img alt="AI settings in Nexudus showing the AI Voice toggle, Twilio Account ID field, Twilio Auth Token field, and SMS Phone Number field" />
    </Frame>
  </Step>
</Steps>

***

## Outbound calling

In addition to answering incoming calls, the AI can **initiate outbound calls** to members and prospects. Outbound calling is used for:

* Booking confirmations and reminders
* Tour reminders
* Follow-up inquiries
* Payment notifications

### How it works

When the AI needs to make an outbound call, it uses your ElevenLabs agent configuration to place the call through your linked Twilio phone number. The caller experiences the call the same way as an inbound call — they hear the AI's voice and can respond naturally.

### Required credentials

Outbound calling requires the following values configured in Nexudus:

| Setting in Nexudus             | Where to find it                                                                              |
| ------------------------------ | --------------------------------------------------------------------------------------------- |
| **ElevenLabs Auth Token**      | ElevenLabs → Account Settings → API Keys → New Personal API Key                               |
| **ElevenLabs Agent ID**        | ElevenLabs → Agents → click your agent → copy the Agent ID from the URL or agent details page |
| **ElevenLabs Phone Number ID** | ElevenLabs → Voice → Phone Numbers → select your number → copy the Phone Number ID            |

<Important>
  The **ElevenLabs Tool Bearer Token** (used for inbound call authentication) is a secret you create yourself in Nexudus — it is **not** an ElevenLabs API key. See [Stage 2 — Configure the webhook tool](#stage-2---configure-the-webhook-tool) for details.
  The **Agent ID** and **Phone Number ID** are unique identifiers that tell ElevenLabs which agent and phone number to use when placing outbound calls. Without these, the AI can answer inbound calls but cannot initiate outbound ones.
</Important>

### Enabling outbound calls

1. Enter the ElevenLabs credentials in [**Settings > Channels > Voice**](https://dashboard.nexudus.com/settings/5/0/3) in your Nexudus admin panel.
2. Configure calling hours in the same settings page to control when outbound calls are made.
3. Use the **Test Outbound Call** button (shown when Agent ID and Phone Number ID are both configured) to verify your setup.

<Note>
  Outbound calls respect the calling hours configured in Nexudus by default. Calls outside the calling window are automatically deferred until the next available window. You can disable this enforcement for testing purposes, but it is not recommended for production use.
</Note>

***

## Test the Voice channel

<Steps>
  <Step title="Call your space's number">
    From any phone, call your space's AI voice number. The AI should answer and greet you.
  </Step>

  <Step title="Try a simple question">
    Ask a basic question like "What are your opening hours?" or "Where are you located?" to verify the AI responds correctly.
  </Step>

  <Step title="Check the conversation">
    After the call, go to **Operations > AI Conversations** in Nexudus to verify the conversation was recorded. You should see a new entry with the Voice channel badge.
  </Step>
</Steps>

***

## Troubleshooting

| Problem                           | Possible cause                                       | Solution                                                                              |
| --------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------- |
| Call connects but no audio        | Webhook not configured correctly                     | Verify the Twilio webhook URL matches what Nexudus provides                           |
| AI doesn't understand the caller  | Speech-to-text accuracy varies with noise/background | Encourage callers to use a quiet environment; ensure the phone number has good signal |
| AI responds but caller can't hear | Text-to-speech not configured                        | Verify Twilio Voice capabilities are active; check Twilio logs for errors             |
| Wrong location's AI answers       | Multiple locations sharing a number                  | Ensure each location has its own dedicated phone number                               |

***

## What the caller can do

On the Voice channel, callers can:

* Ask about opening hours, location, and facilities
* Browse and book meeting rooms and desks
* Inquire about day passes and membership plans
* Request a tour of private offices
* View and manage their existing bookings

For complex actions (like purchasing a day pass or signing up for a membership), the AI describes the options and offers to send a link via email or WhatsApp that the caller can follow on their device.


# Setting Up the WhatsApp Channel
Source: https://learn.nexudus.com/member-portal/ai/setup-whatsapp

Step-by-step guide to connecting the AI assistant to WhatsApp through Twilio, so members and prospects can interact with the AI via WhatsApp messages.

The WhatsApp channel lets members and prospects interact with your AI assistant by sending a WhatsApp message to your space's number. The AI processes the message and replies in the same WhatsApp conversation — with all the same capabilities as the chat widget.

Setting up the WhatsApp channel requires a **Twilio account** and a **WhatsApp Business Account** through Meta. This guide walks through the full process from account creation to sending a test message.

<Note>
  The WhatsApp channel requires a paid Twilio account. Twilio charges per message sent and received. See [Twilio's WhatsApp pricing](https://www.twilio.com/en-us/whatsapp/pricing) for current rates. The cost is typically low for conversational AI use cases.
</Note>

## Before you start

You need:

* **Administrator access** to your Nexudus account.
* **A credit card** for the Twilio account (free trial accounts are too limited for production use).
* **A phone number** that is not already registered with WhatsApp. This can be a new number purchased through Twilio or an existing number you own.
* **Administrator access to a Meta Business Portfolio** (or the ability to create one).

<Check>
  Make sure the AI assistant is already enabled for your space. The WhatsApp channel is an extension of the existing AI assistant — it will not work unless the base AI assistant is active.
</Check>

## Overview

The setup involves four main stages:

<Frame>
  <img alt="Four-stage setup overview: 1. Create Twilio account, 2. Register WhatsApp sender, 3. Configure webhook, 4. Connect to Nexudus" />
</Frame>

1. **Create a Twilio account** and upgrade to a paid plan.
2. **Register a WhatsApp sender** — connect a phone number to a WhatsApp Business Account through Twilio.
3. **Configure the webhook** — point Twilio to Nexudus so inbound messages reach the AI assistant.
4. **Connect to Nexudus** — enter your Twilio credentials and phone number in Nexudus settings.

Each stage is covered in detail below.

***

## Stage 1 — Create and upgrade your Twilio account

<Steps>
  <Step title="Sign up for Twilio">
    Go to [twilio.com/try-twilio](https://www.twilio.com/try-twilio) and create an account.

    The sign-up process asks you to:

    * Verify your email address.
    * Verify your personal phone number.
    * Answer a few questions about your project (select **Messaging** as your use case).
  </Step>

  <Step title="Upgrade to a paid account">
    A free trial account can only message pre-verified numbers and has a single phone number limit — this is not suitable for a production AI assistant.

    To upgrade, in the Twilio Console, click **Upgrade** at the top of the page, or go to **Admin > Account billing** and click **Upgrade account**.

    You will need to:

    * Add a payment method (credit card).
    * Load a starting balance (the minimum depends on your region).

    <Warning>
      Do not skip the upgrade step. WhatsApp sender registration requires a paid Twilio account, and trial accounts cannot receive messages from unverified numbers.
    </Warning>
  </Step>

  <Step title="Note your account credentials">
    In the Twilio Console, go to **Account > API keys & tokens**. You need two values:

    * **Account SID** — your account identifier
    * **Auth Token** — your account secret

    Keep these values safe. You will enter them in Nexudus later.
  </Step>
</Steps>

***

## Stage 2 — Register a WhatsApp sender

A **WhatsApp sender** is a phone number connected to a WhatsApp Business Account (WABA) through Twilio. This is the number your members will message on WhatsApp.

### Choose a phone number

You have two options:

| Option                          | Best for                                   | Details                                                                                                                                                                     |
| ------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Buy a number through Twilio** | Most operators                             | Twilio provides the number. No need to port an existing number. Go to **Phone Numbers > Manage > Buy a number** in the Twilio Console.                                      |
| **Use your own number**         | Operators with an existing business number | You can register a number you already own, as long as it is not already registered with WhatsApp. The number must be able to receive an SMS or voice call for verification. |

<Note>
  If the phone number you want to use is currently registered with the regular WhatsApp or WhatsApp Business app, you must [delete that WhatsApp account](https://faq.whatsapp.com/2138515194215842) first. A number can only be registered with one WhatsApp platform at a time.
</Note>

### Register the sender via self sign-up

<Steps>
  <Step title="Open WhatsApp senders">
    In the Twilio Console, go to [**Products & Services / Numbers & senders / Overview / WhatsApp**](https://console.twilio.com/us1/develop/sms/senders/whatsapp-senders).

    Click **Create new sender**.
  </Step>

  <Step title="Select your phone number">
    Under **Select a phone number to register**, choose a Twilio phone number or enter your own non-Twilio number.

    Click **Continue**.
  </Step>

  <Step title="Link to your WhatsApp Business Account">
    Click **Continue with Facebook**. A pop-up window opens for Meta's self sign-up flow.

    <Warning>
      Complete all the following steps in the same browser. Do not share the pop-up URL. Keep both the Twilio Console and the Meta pop-up windows open throughout the process.
    </Warning>
  </Step>

  <Step title="Log in to Facebook">
    In the pop-up, log in to your Facebook account (or click **Continue as \[your name]** if already logged in).

    Review and accept the permissions that allow Twilio to manage your WhatsApp Business Account.

    Click **Get started**.
  </Step>

  <Step title="Select or create a Meta Business Portfolio">
    If your company already has a Meta Business Portfolio, select it from the dropdown. If not, create a new one.

    <Tip>
      If your company already has a Meta Business Portfolio (for example, from Facebook advertising), select the existing one. You will need administrator access with full permissions. If you cannot get access, you can create a new portfolio during this step.
    </Tip>

    Click **Next**.
  </Step>

  <Step title="Create or select a WhatsApp Business Account">
    * If this is your **first WhatsApp sender** on Twilio, create a new WABA (WhatsApp Business Account).
    * If you are adding **another sender** to an existing Twilio account, select the same WABA you used previously. Twilio requires all senders in one account to use the same WABA.

    Select **Create a new WhatsApp Business profile**.

    Click **Next**.
  </Step>

  <Step title="Set up your WhatsApp Business profile">
    Fill in the following:

    | Field            | Required    | Description                                                                                                                                                                                                   |
    | ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Display name** | Yes         | The name members see when they receive messages. Must comply with [Meta's display name guidelines](https://www.facebook.com/business/help/757569725593362). Use your space's name (e.g. "The Hub Coworking"). |
    | **Category**     | Yes         | Your business category (e.g. "Office Space", "Business Service").                                                                                                                                             |
    | **Description**  | Recommended | A short description of your space shown in your WhatsApp profile.                                                                                                                                             |
    | **Website**      | Recommended | Your space's website URL.                                                                                                                                                                                     |

    Click **Next**.
  </Step>

  <Step title="Verify the phone number">
    Meta needs to verify that you own the phone number. The process depends on the number type:

    **For a Twilio phone number (SMS-capable):**

    1. Copy the phone number from the Twilio Console window.
    2. In the Meta pop-up, select **Add a new phone number** and paste it.
    3. Select **Text message** as the verification method and click **Next**.
    4. The verification code appears in the Twilio Console — copy it.
    5. Paste the code in the Meta pop-up and click **Next**.

    **For a non-Twilio phone number:**

    1. Enter the phone number in the Meta pop-up.
    2. Choose **Text message** or **Phone call** as the verification method.
    3. Receive the code on your device and enter it in the pop-up.
  </Step>

  <Step title="Review and confirm">
    The Meta pop-up shows a summary of Twilio's access to your WABA. Review it and click **Confirm**.

    The pop-up closes and Twilio begins the registration process. This takes a few minutes. Once complete, the Twilio Console shows your new WhatsApp sender.
  </Step>
</Steps>

### Complete Meta business verification

<Note>
  If you created a new Meta Business Portfolio during the sign-up, or if your existing portfolio has not been verified, you must complete Meta business verification before you can use the WhatsApp channel in production.
</Note>

Business verification is **free** (it is not the same as Meta's paid "Meta Verified" subscription) and is required to:

* Remove the 250-message daily limit on business-initiated messages.
* Add more than two WhatsApp senders.
* Request an Official Business Account (green checkmark).

To verify:

1. Go to [Meta's Security Centre](https://business.facebook.com/settings/security).
2. Follow the steps in [How to verify your business on Meta](https://www.facebook.com/business/help/2058515294227817).

Meta's processing time varies by region and can take **several days to a few weeks**. Start this process early.

***

## Stage 3 — Configure the webhook

The webhook tells Twilio where to send inbound WhatsApp messages. You need to point it at the Nexudus API so that incoming messages reach the AI assistant.

<Steps>
  <Step title="Open your WhatsApp sender settings">
    In the Twilio Console, go to **Messaging > Senders > WhatsApp Senders**. Click **Edit Sender** on the sender you just registered.
  </Step>

  <Step title="Set the inbound message webhook URL">
    In the **Sender configuration** section, find the **A message comes in** field. Enter the Nexudus WhatsApp webhook URL:

    ```
    https://spaces.nexudus.com/api/integrations/twilio/whatsapp
    ```

    Set the HTTP method to **POST**.

    <Frame>
      <img alt="Twilio sender settings showing the webhook URL configured to point to the Nexudus WhatsApp endpoint" />
    </Frame>
  </Step>

  <Step title="Save the configuration">
    Click **Save** to apply the webhook configuration.
  </Step>
</Steps>

<Warning>
  The webhook URL must be entered exactly as shown. If the URL is incorrect, inbound WhatsApp messages will not reach Nexudus and the AI assistant will not respond.
</Warning>

***

## Stage 4 — Connect to Nexudus

Now connect your Twilio account and WhatsApp number to Nexudus.

<Steps>
  <Step title="Open your AI settings">
    In the Nexudus administration panel, go to [**Settings > Channels > WhatsApp**](https://dashboard.nexudus.com/settings/5/0/2).
  </Step>

  <Step title="Enable AI WhatsApp">
    Toggle the **AI WhatsApp** setting to on.
  </Step>

  <Step title="Enter your Twilio credentials">
    Enter the following values from your Twilio Console:

    | Field                  | Where to find it                             |
    | ---------------------- | -------------------------------------------- |
    | **Twilio Account SID** | Twilio Console > Account > API keys & tokens |
    | **Twilio Auth Token**  | Twilio Console > Account > API keys & tokens |

    <Frame>
      <img alt="Nexudus AI settings showing the Twilio Account SID and Auth Token fields" />
    </Frame>
  </Step>

  <Step title="Enter your WhatsApp phone number">
    Enter the phone number you registered as a WhatsApp sender, in international format with the country code (for example, `+14155238886` or `+442071234567`).
  </Step>

  <Step title="Save your settings">
    Click **Save**. The WhatsApp channel is now active for your space.
  </Step>
</Steps>

***

## Stage 4b — Configure outbound messaging (optional)

Outbound messaging lets you send proactive notifications to members and prospects via WhatsApp — for example, booking confirmations, payment reminders, or event announcements.

WhatsApp enforces a **24-hour messaging window**: you can send free-form messages to customers who have messaged you within the last 24 hours. Outside that window, you must send a pre-approved template message first, and the customer must reply with a keyword to confirm they want to receive your message.

<Note>
  Outbound messaging is optional. If you only need to respond to inbound messages (the default behavior), you can skip this section.
</Note>

### Configure the opt-in template

Before sending outbound messages outside the 24-hour window, you need to create a template in your Twilio account and configure the settings in Nexudus.

<Steps>
  <Step title="Create a WhatsApp template in Twilio">
    In the Twilio Console, go to **Content > Templates** and click **Create Template**.

    Create a template with the following structure:

    ```
    Hi {{1}}, this is {{2}}. We have an update for you regarding your membership. Reply **YES** to receive it.
    ```

    The template uses two variables:

    * `{{1}}` — customer's name
    * `{{2}}` — your space's name

    After creating the template, note its **Content SID** (it starts with `HX`). You'll need this value in Nexudus.
  </Step>

  <Step title="Configure outbound settings in Nexudus">
    In the Nexudus administration panel, go to [**Settings > Channels > WhatsApp**](https://dashboard.nexudus.com/settings/5/0/2) and scroll to the **Outbound messaging** section.

    Enter the following:

    | Field                    | Description                                                                                                               |
    | ------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
    | **Template Content SID** | The Content SID from your Twilio template (starts with `HX`). Required for outbound messaging outside the 24-hour window. |
    | **Opt-in keyword**       | The keyword customers must reply with to receive outbound messages (case-insensitive). Default: `yes`.                    |
  </Step>

  <Step title="Save your settings">
    Click **Save** to apply the outbound messaging configuration.
  </Step>
</Steps>

### How outbound messaging works

When you send a proactive notification via WhatsApp:

1. **If the customer messaged you within the last 24 hours** (on any WhatsApp conversation), the message is sent directly as a free-form message.
2. **If the customer has not messaged you recently**, Nexudus sends the opt-in template first. The customer must reply with the keyword (e.g., "YES") to receive your actual message. If they don't reply within 24 hours, the message expires.

This approach respects WhatsApp's policies while still allowing you to reach customers who haven't initiated contact recently.

***

## Step 5 — Test the WhatsApp channel

<Steps>
  <Step title="Send a test message">
    From your personal WhatsApp, send a message to the phone number you just configured. Try a simple question like:

    > What meeting rooms do you have?
  </Step>

  <Step title="Wait for the AI reply">
    Within a minute, you should receive a reply from the AI assistant in your WhatsApp conversation.

    <Frame>
      <img alt="WhatsApp conversation showing a test message and the AI assistant's reply" />
    </Frame>
  </Step>

  <Step title="Check the AI Conversations list">
    In the Nexudus administration panel, go to **Operations > AI Conversations**. You should see a new conversation with your test message. The **Channel** column will show **WhatsApp**.

    <Frame>
      <img alt="AI Conversations list showing a test WhatsApp conversation with the WhatsApp channel badge" />
    </Frame>
  </Step>
</Steps>

<Warning>
  If you do not receive a reply, check the following:

  * The webhook URL in Twilio is correct (`https://spaces.nexudus.com/api/integrations/twilio/whatsapp`).
  * The phone number in Nexudus settings matches the number registered in Twilio (including the country code).
  * AI WhatsApp is enabled in Nexudus.
  * Your Twilio account is upgraded (not on a free trial).
</Warning>

***

## Share the WhatsApp number with your members

Once the channel is working, let your members know how to reach the AI assistant on WhatsApp:

* **Add a WhatsApp link to your website.** Use the format `https://wa.me/{number}` (without the `+`). For example: `https://wa.me/14155238886`. This opens a WhatsApp conversation directly when tapped on a mobile device.
* **Display the number on signage** in your space, alongside a QR code that links to the WhatsApp conversation.
* **Include it in your welcome email** and member handbook.
* **Add a "Message us on WhatsApp" button** to your website. See [WhatsApp's brand guidelines](https://www.facebook.com/business/help/940953542898498) for official button assets.

<Tip>
  You can generate a WhatsApp QR code from [wa.me](https://wa.me/) by creating a link with a pre-filled message — for example, `https://wa.me/14155238886?text=Hi%2C%20I%20have%20a%20question`. When a member scans the code, WhatsApp opens with the message pre-filled and ready to send.
</Tip>

***

## Multiple locations

Each WhatsApp number is connected to a specific location. This means when a message arrives on that number, the AI knows exactly which location is being discussed and can answer questions about that location's bookings, FAQs, and details.

If you operate multiple locations and want each to have its own WhatsApp number:

1. Each location needs its own **phone number** registered as a WhatsApp sender in Twilio. All senders must be under the same WhatsApp Business Account (WABA).
2. In each location's Nexudus settings, enter that location's specific WhatsApp number.
3. Set the same webhook URL for all senders — Nexudus routes messages to the correct location based on which phone number received the message.

You can manage all your WhatsApp numbers on a single device by using the **multi-account feature** in the WhatsApp Business mobile app.

### Network locations

You can also connect a WhatsApp number to a **network location** (a parent location). When you do this, the AI has access to inventory for that location and all its children. This is ideal for operators who want a single entry point that can answer questions about bookings, FAQs, or location details across a group of locations.

### How inventory works across locations

When it comes to selling Day Passes, Private Offices, and Membership plans, the AI always searches across **all locations** regardless of which number received the message — unless the customer asks about a specific location. This means no matter which number a prospect writes to, they can get information about plans and availability at any of your locations.

***

## Costs

The WhatsApp channel incurs charges from Twilio based on WhatsApp's conversation-based pricing model:

| Cost type                | Description                                                                                                                                                                                                                            |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Phone number**         | Monthly fee for the Twilio phone number (varies by country, typically \$1–2/month)                                                                                                                                                     |
| **Conversation charges** | WhatsApp charges per 24-hour conversation window, not per message. Rates vary by country and conversation type (user-initiated vs business-initiated). See [Twilio's WhatsApp pricing](https://www.twilio.com/en-us/whatsapp/pricing). |

For a typical coworking space, expect costs in the range of a few dollars per month for moderate usage. Nexudus does not add any additional charges for the WhatsApp channel.

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Messages are not being delivered to Nexudus">
    * Verify the webhook URL in your Twilio sender settings matches `https://spaces.nexudus.com/api/integrations/twilio/whatsapp` exactly.
    * Check the [Twilio Error Logs](https://console.twilio.com/us1/monitor/logs/debugger/errors) for webhook delivery failures.
    * Make sure your Twilio account is active and has a positive balance.
  </Accordion>

  <Accordion title="The AI replies on chat but not on WhatsApp">
    * Confirm that **AI WhatsApp** is enabled in [**Settings > Channels > WhatsApp**](https://dashboard.nexudus.com/settings/5/0/2).
    * Confirm that the phone number in Nexudus matches the sender's number in Twilio (including the country code and `+` prefix).
    * Check that the Twilio Auth Token in Nexudus is correct and has not been rotated since setup.
  </Accordion>

  <Accordion title="Meta rejected my display name">
    Meta reviews the display name you set during registration. If rejected, your sender is limited to 250 business-initiated messages per day. Update your display name to comply with [Meta's guidelines](https://www.facebook.com/business/help/757569725593362) — it must clearly represent your business and not be generic or misleading.
  </Accordion>

  <Accordion title="I want to use a phone number that is already on WhatsApp">
    A phone number can only be registered with one WhatsApp platform at a time. If the number is registered with the personal WhatsApp or WhatsApp Business app, you must [delete the WhatsApp account](https://faq.whatsapp.com/2138515194215842) from that number first. If it is registered with another WhatsApp Business Platform provider, you need to migrate it — see [Twilio's migration guide](https://www.twilio.com/docs/whatsapp/migrate-numbers-and-senders).
  </Accordion>

  <Accordion title="What happens if someone sends an image or voice message?">
    The AI processes text messages only. If a member sends an image, video, document, or voice message, the AI acknowledges the attachment but informs the sender that only text messages are supported at this time.
  </Accordion>

  <Accordion title="Can I disable the WhatsApp channel later?">
    Yes. Switch off **AI WhatsApp** in [**Settings > Channels > WhatsApp**](https://dashboard.nexudus.com/settings/5/0/2). You may also want to remove or reconfigure the webhook in Twilio to stop messages from being forwarded.
  </Accordion>

  <Accordion title="Can I use the same WhatsApp number for all my locations?">
    Each WhatsApp number is connected to a specific location, so you cannot assign one number to multiple locations simultaneously. However, you can connect a number to a **network location** (parent), which gives the AI access to that location and all its children — effectively covering multiple locations with a single number.

    For selling Day Passes, Private Offices, and Membership plans, the AI searches across all locations regardless of which number received the message, so prospects can always get information about any plan at any location.

    If you prefer a separate number per location, use the multi-account feature in the WhatsApp Business mobile app to manage all numbers on a single device.
  </Accordion>
</AccordionGroup>

***

## Quick reference

| Item                             | Value                                                                                                                              |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| **Twilio sign-up**               | [twilio.com/try-twilio](https://www.twilio.com/try-twilio)                                                                         |
| **WhatsApp senders page**        | [console.twilio.com/us1/develop/sms/senders/whatsapp-senders](https://console.twilio.com/us1/develop/sms/senders/whatsapp-senders) |
| **Nexudus webhook URL**          | `https://spaces.nexudus.com/api/integrations/twilio/whatsapp`                                                                      |
| **Meta business verification**   | [business.facebook.com/settings/security](https://business.facebook.com/settings/security)                                         |
| **Meta display name guidelines** | [facebook.com/business/help/757569725593362](https://www.facebook.com/business/help/757569725593362)                               |
| **Twilio WhatsApp pricing**      | [twilio.com/en-us/whatsapp/pricing](https://www.twilio.com/en-us/whatsapp/pricing)                                                 |
| **WhatsApp link format**         | `https://wa.me/{number without +}`                                                                                                 |


# Standalone AI Chat Widget
Source: https://learn.nexudus.com/member-portal/ai/standalone-widget

Embed the Nexudus AI assistant on any website with a single script tag — no framework or login required.

The **Standalone AI Chat Widget** lets you embed the Nexudus AI assistant on any external website — your company homepage, a landing page, a blog, or any third-party site — with a single `<script>` tag. This is the same AI assistant that powers the [chat experience](/member-portal/ai/chat-experience) inside your members portal, but designed to work on sites where the portal is not available.

<Frame>
  <img alt="AI chat widget floating button and open chat modal on an external website" />
</Frame>

## When to use the standalone widget

Use the standalone widget when you want to offer AI-powered conversations on pages outside the members portal:

| Scenario                                         | Widget or Portal?                            |
| ------------------------------------------------ | -------------------------------------------- |
| Your coworking space's marketing website         | **Standalone widget**                        |
| A landing page for a specific event or promotion | **Standalone widget**                        |
| Your company's main corporate website            | **Standalone widget**                        |
| Inside the members portal itself                 | **Portal chat** (built-in, no widget needed) |

The widget provides the same capabilities as the portal chat — answering questions about your location, rooms, membership plans, and day passes, as well as helping visitors book tours and resources.

<Info>
  The standalone widget shares the same conversation data with the portal. Conversations started on your external website appear in the [AI Conversations list](/member-portal/ai/admin-panel) alongside portal conversations, so you get a unified view of all AI interactions.
</Info>

## How it works

The widget is a single JavaScript file that loads asynchronously. Once loaded, it:

1. Reads configuration from `data-*` attributes on the `<script>` tag
2. Creates a floating action button in the corner of the screen
3. Attaches a chat modal using Shadow DOM (completely isolated from your site's styles)
4. Communicates with the Nexudus AI API to process messages and return responses

No HTML elements are required on your page — the widget self-initialises and appends everything it needs to `document.body`.

## Adding the widget to your website

### Step 1: Get your API base URL

The widget needs to know which Nexudus account to connect to. Your API base URL follows this format:

```
https://{webAddress}.spaces.nexudus.com
```

Where `{webAddress}` is the **Domain** value shown in your Nexudus dashboard:

1. Log in to [dashboard.nexudus.com](https://dashboard.nexudus.com)
2. Go to **Settings > Website**
3. Find the **Domain** field — this is your `webAddress`

<Frame>
  <img alt="Settings > Website page showing the Domain field" />
</Frame>

For example, if your Domain is `myworkspace`, your API base URL is:

```
https://myworkspace.spaces.nexudus.com
```

### Step 2: Add the script tag

Place the following script tag before the closing `</body>` tag on your website:

```html theme={null}
<script
  src="https://cdn.nexudus.site/widget/nexudus-ai-chat.min.js"
  data-api-base="https://myworkspace.spaces.nexudus.com"
  data-position="right"
  data-primary-color="#6366f1"
  data-text-color="#ffffff"
  data-greeting="Hi! How can I help you today?"
  data-placeholder="Ask me anything..."
></script>
```

Replace `myworkspace` with your actual Domain value from the step above.

### Step 3: Test the widget

Open your website in a browser. You should see a floating chat button in the bottom corner. Click it to open the chat modal and send a test message.

<Tip>
  If you don't see the button, check your browser console for errors. The most common issue is a missing or incorrect `data-api-base` value.
</Tip>

## Configuration parameters

All configuration is passed through `data-*` attributes on the `<script>` tag. The only required attribute is `data-api-base`.

| Attribute            | Type                              | Default                   | Description                                                                    |
| -------------------- | --------------------------------- | ------------------------- | ------------------------------------------------------------------------------ |
| `data-api-base`      | string                            | **(required)**            | Your Nexudus API base URL (e.g. `https://myworkspace.spaces.nexudus.com`)      |
| `data-position`      | `"left"` \| `"right"`             | `"right"`                 | Which side of the screen to place the floating button                          |
| `data-primary-color` | CSS color                         | `#6366f1`                 | Button background and accent color                                             |
| `data-text-color`    | CSS color                         | `#ffffff`                 | Button icon and text color                                                     |
| `data-greeting`      | string                            | `""`                      | Initial AI message shown when the chat opens                                   |
| `data-placeholder`   | string                            | `"Ask me anything..."`    | Input field placeholder text                                                   |
| `data-button-size`   | number (px)                       | `60`                      | Floating button diameter in pixels                                             |
| `data-z-index`       | number                            | `9999`                    | CSS z-index for the widget layers                                              |
| `data-geolocation`   | `"true"` \| `"false"`             | `"true"`                  | Whether to request the user's location for proximity results                   |
| `data-open-on-load`  | `"true"` \| `"false"`             | `"false"`                 | Whether to auto-open the chat modal when the page loads                        |
| `data-locale`        | string                            | `"en"`                    | Language code for built-in UI strings                                          |
| `data-portal-url`    | string                            | (same as `data-api-base`) | Base URL for links in tool cards (e.g. "Request booking" links)                |
| `data-token`         | string                            | `""`                      | Bearer token for authenticated API calls (enables inline booking confirmation) |
| `data-theme`         | `"auto"` \| `"light"` \| `"dark"` | `"auto"`                  | Color scheme — `"auto"` follows the visitor's system preference                |

### Configuration examples

**Left position with custom colors:**

```html theme={null}
<script
  src="https://cdn.nexudus.site/widget/nexudus-ai-chat.min.js"
  data-api-base="https://myworkspace.spaces.nexudus.com"
  data-position="left"
  data-primary-color="#ff5100"
  data-text-color="#ffffff"
></script>
```

**Auto-open on page load with a greeting:**

```html theme={null}
<script
  src="https://cdn.nexudus.site/widget/nexudus-ai-chat.min.js"
  data-api-base="https://myworkspace.spaces.nexudus.com"
  data-open-on-load="true"
  data-greeting="Welcome! Ask me about our membership plans or available meeting rooms."
></script>
```

**Dark theme with custom portal URL:**

```html theme={null}
<script
  src="https://cdn.nexudus.site/widget/nexudus-ai-chat.min.js"
  data-api-base="https://myworkspace.spaces.nexudus.com"
  data-portal-url="https://myworkspace.spaces.nexudus.com"
  data-theme="dark"
></script>
```

## Controlling the widget with JavaScript

After the widget loads, it exposes a `window.nxAiChat` object that lets you control it programmatically from your website's JavaScript.

### Available methods

| Method                     | Description                                    |
| -------------------------- | ---------------------------------------------- |
| `nxAiChat.open()`          | Open the chat modal                            |
| `nxAiChat.close()`         | Close the chat modal                           |
| `nxAiChat.newSession()`    | Start a new conversation (clears chat history) |
| `nxAiChat.destroy()`       | Remove the widget completely from the page     |
| `nxAiChat.setToken(token)` | Set or update the authentication token         |

### Examples

**Open the chat when a user clicks a button on your page:**

```html theme={null}
<button onclick="window.nxAiChat.open()">Chat with us</button>
```

**Close the chat after a certain action:**

```javascript theme={null}
// Close the widget after the user completes a form
document.getElementById('contact-form').addEventListener('submit', () => {
    window.nxAiChat.close();
});
```

**Start a fresh conversation:**

```javascript theme={null}
// Reset the chat when navigating to a new section
window.nxAiChat.newSession();
```

**Remove the widget entirely (e.g. on logout):**

```javascript theme={null}
// Destroy the widget if the user logs out
window.nxAiChat.destroy();
```

**Set an authentication token after user login:**

```javascript theme={null}
// After your user authenticates on your website, pass their token to the widget
// This enables authenticated features like inline booking confirmation
window.nxAiChat.setToken('user-auth-token-here');
```

<Warning>
  The `setToken` method is only useful if your website has its own authentication system and you want to pass the user's session to the Nexudus API. For most use cases, the widget works fine without a token.
</Warning>

## Listening to widget events

The widget emits events during its lifecycle. You can subscribe to these events using `nxAiChat.on()` and unsubscribe with `nxAiChat.off()`.

### Available events

| Event               | When it fires                 | Payload                                     |
| ------------------- | ----------------------------- | ------------------------------------------- |
| `open`              | When the chat modal opens     | —                                           |
| `close`             | When the chat modal closes    | —                                           |
| `message:sent`      | When the user sends a message | `{ prompt: string }`                        |
| `message:received`  | When the AI responds          | `{ response: string, tools?: unknown[] }`   |
| `tool:displayed`    | When a tool card is shown     | `{ toolName: string, toolData: unknown }`   |
| `booking:confirmed` | When a booking is confirmed   | `{ bookingId: string, resourceId: string }` |
| `error`             | When an API error occurs      | `{ code: number, message: string }`         |
| `session:new`       | When a new session starts     | —                                           |

### Examples

**Track when a booking is confirmed:**

```javascript theme={null}
window.nxAiChat.on('booking:confirmed', (data) => {
    console.log('Booking confirmed:', data.bookingId);
    // Send to your analytics platform
    gtag('event', 'booking_confirmed', {
        booking_id: data.bookingId,
        resource_id: data.resourceId
    });
});
```

**Log all AI responses for debugging:**

```javascript theme={null}
window.nxAiChat.on('message:received', (data) => {
    console.log('AI response:', data.response);
    if (data.tools && data.tools.length > 0) {
        console.log('Tool cards:', data.tools);
    }
});
```

**Track chat open/close events:**

```javascript theme={null}
window.nxAiChat.on('open', () => {
    console.log('Chat opened');
});

window.nxAiChat.on('close', () => {
    console.log('Chat closed');
});
```

**Handle errors gracefully:**

```javascript theme={null}
window.nxAiChat.on('error', (data) => {
    console.error('Widget error:', data.code, data.message);
    // Notify your error tracking service
    Sentry.captureException(new Error(data.message), {
        tags: { widget_error_code: data.code }
    });
});
```

**Unsubscribe from an event:**

```javascript theme={null}
function onMessageSent(data) {
    console.log('User sent:', data.prompt);
}

// Subscribe
window.nxAiChat.on('message:sent', onMessageSent);

// Later, unsubscribe
window.nxAiChat.off('message:sent', onMessageSent);
```

## Style isolation

The widget uses **Shadow DOM** to mount its UI, which means:

* Your website's CSS does not affect the widget's appearance
* The widget's CSS does not leak into your website
* The widget inherits the host page's font family and base font size for a cohesive look

Colors like the button background and text are controlled via the `data-primary-color` and `data-text-color` attributes. The widget adapts to these values using CSS custom properties.

<Info>
  If you need to override additional styles, you can target the shadow host element (`#nxai-root`) and pass custom properties into the shadow root. However, this is rarely necessary — the built-in configuration options cover most use cases.
</Info>

## Session persistence

The widget stores conversation history in the browser's `localStorage`, keyed by your `data-api-base` URL. This means:

* If a visitor closes the chat and returns later, their conversation history is restored
* Sessions expire after **7 days** — older conversations are automatically discarded
* The "New chat" button in the chat header clears the session and starts fresh

## Geolocation

When `data-geolocation="true"` (the default), the widget will request the visitor's browser location on their first message. This allows the AI to calculate distances when presenting rooms, locations, and offices.

If the visitor denies the location permission, the widget continues to work normally — distance information is simply omitted from the AI's responses.

## Accessibility

The widget follows accessibility best practices:

* All interactive elements have proper ARIA roles and labels
* Focus is trapped inside the modal when it's open
* **Escape** closes the modal, **Enter** sends a message
* An `aria-live="polite"` region announces new AI messages to screen readers
* The widget respects `prefers-reduced-motion` — the typewriter animation is skipped for users who prefer reduced motion

## Size and performance

* The minified bundle is approximately **15–25KB gzipped**
* The widget loads asynchronously and does not block page rendering
* No external dependencies — everything is contained in a single file
* The AI API is only called when the user sends a message

## Troubleshooting

| Problem                      | Solution                                                                                                                      |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Widget button doesn't appear | Check that `data-api-base` is set correctly. Open browser console for errors.                                                 |
| Chat shows "API error"       | Verify your `data-api-base` URL is accessible. Check that AI is enabled in your Nexudus account.                              |
| Widget styles look broken    | Ensure the script tag is loaded after the page content (before `</body>`).                                                    |
| Multiple widgets on one page | Only one widget instance is allowed per page. The widget is idempotent — adding the script tag twice won't create duplicates. |
| Chat doesn't open on load    | Make sure `data-open-on-load="true"` (as a string, not a boolean).                                                            |
| Tool cards show broken links | Set `data-portal-url` to your correct portal URL.                                                                             |

## Comparison with portal chat

| Feature              | Standalone Widget                                            | Portal Chat                                                  |
| -------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Where it works       | Any external website                                         | Inside the members portal only                               |
| How to add           | Single `<script>` tag                                        | Built-in, no setup needed                                    |
| Authentication       | Optional (via `data-token`)                                  | Automatic (member session)                                   |
| Session persistence  | localStorage (7-day expiry)                                  | Server-side (permanent)                                      |
| Conversation history | Visible in [AI Conversations](/member-portal/ai/admin-panel) | Visible in [AI Conversations](/member-portal/ai/admin-panel) |
| Conversion tracking  | Yes                                                          | Yes                                                          |
| Customisation        | Via `data-*` attributes                                      | Via portal styling settings                                  |

## Related pages

* [AI Assistant Overview](/member-portal/ai/overview) — Learn about the AI assistant capabilities across all channels
* [Chat Experience](/member-portal/ai/chat-experience) — The built-in portal chat widget
* [Channels](/member-portal/ai/channels) — Compare chat, email, WhatsApp, and voice channels
* [Monitoring Conversations](/member-portal/ai/admin-panel) — View and analyse AI conversations in the admin panel
* [Conversion Tracking](/member-portal/ai/conversion-tracking) — Track bookings, memberships, and tours from AI conversations


# Visibility Settings
Source: https://learn.nexudus.com/member-portal/ai/visibility-settings

How to control what the AI assistant shows to different users — per item, per audience, and per channel.

You control what the AI presents using the same Nexudus records you already manage, plus a small set of AI-specific fields on products, tariffs, and private offices. You also control which channels (chat, email, WhatsApp, voice) are active for each location.

## The "AI Ready" badge

In the administration panel, any item that has **Available to AI** switched on shows an **AI Ready** badge in the list view. This makes it easy to see at a glance which of your plans, products, and offices are currently accessible to the AI without opening each record individually.

The badge appears in:

* **Billing > Plans** — for each membership plan tariff enabled for AI
* **Billing > Products** — for each day pass product enabled for AI
* **Spaces > Floor Plan > Desks & Offices** — for each private office enabled for AI

<Frame>
  <img alt="Membership plans list showing AI Ready badge on enabled plans" />
</Frame>

## AI Items settings page

The quickest way to review and manage AI settings across all your items is the dedicated **AI Items** settings page. Go to **Settings > AI > Items** to open it.

The page has three tabs — **Products**, **Plans**, and **Floor plan items** — each showing a table with every record of that type. The columns are:

| Column         | What it shows                                                     |
| -------------- | ----------------------------------------------------------------- |
| **Name**       | The item name, with the location shown underneath                 |
| **Price**      | The regular price of the item                                     |
| **Available**  | Toggle to enable or disable *Available to AI* inline              |
| **AI Notes**   | The current *Notes for AI* value, truncated. Click to edit inline |
| **Show price** | Toggle to enable or disable *Show price to AI* inline             |
| **AI Price**   | The current *Price for AI* value. Click to edit inline            |

You can search by name and filter by the *Available to AI* status. All changes are saved immediately — there is no separate save step.

<Frame>
  <img alt="AI Items settings page showing the Products tab with inline toggles and editors for each AI field" />
</Frame>

## Where to find the AI settings on individual records

On each plan, product, or private office record, the AI-specific fields are also available in a section called **"AI agent settings"**. This section is separate from the general settings for the item.

<Frame>
  <img alt="AI agent settings section on a membership plan record, showing all four AI fields grouped together" />
</Frame>

The fields for **Notes for AI**, **Show price to AI**, and **Price for AI** are disabled until **Available to AI** is switched on — you must enable the master switch before you can configure the other options.

## AI-specific fields

These four fields appear in the **AI agent settings** section on **Day Pass products**, **Membership Plans**, and **Private Office floor plan items**:

| Field                | What it does                                                                                                                                                                                                                                                                                                           |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Available to AI**  | Master switch. If off, the AI will never mention this item — even if it exactly matches what the user asked for. Enabling this is what triggers the **AI Ready** badge in the list view.                                                                                                                               |
| **Show price to AI** | If off, the AI describes the item without mentioning its price. Useful when pricing is negotiated individually. Disabled until *Available to AI* is on.                                                                                                                                                                |
| **Price for AI**     | An alternative price shown only in the AI chat. Overrides the regular price in AI responses. Useful for promotional rates. Disabled until *Available to AI* is on.                                                                                                                                                     |
| **Notes for AI**     | Private notes the AI uses when describing this item. Not shown to the user word-for-word — the AI incorporates these notes naturally into its response. Use this to add context such as *"this office has just been refurbished"* or *"available from the 1st of next month."* Disabled until *Available to AI* is on. |

The standard **Visible** flag (present on products and plans) also affects the AI: when *Available to AI* is on but *Visible* is off, the AI acknowledges the item exists and suggests contacting the team, but does not show a price or a direct link.

<Frame>
  <img alt="AI visibility fields on a day pass product in the Nexudus admin" />
</Frame>

## Which item types the AI can work with

Not every product, plan, or floor plan item is eligible for the AI. Only certain types within each category are supported:

### Day passes

Only products whose type is **Day Pass** can be made available to the AI. Other product types (extras, services, etc.) are not shown to the AI regardless of their settings.

### Membership plans

The AI supports three categories of membership plan. Each category maps to one or more underlying plan types:

| Category           | Plan types included                                |
| ------------------ | -------------------------------------------------- |
| **Dedicated Desk** | Full-time Dedicated Desk, Part-time Dedicated Desk |
| **Hot Desk**       | Full-time Hot Desk, Part-time Hot Desk             |
| **Virtual Office** | Virtual Office, Virtual                            |

Plans of any other type are not available to the AI. Archived plans are also excluded automatically.

### Private offices

Only floor plan items whose type is **Office** and that are marked as **Available** can be made available to the AI. Other floor plan item types (desks, meeting rooms, etc.) are not included.

<Note>
  If you have enabled *Available to AI* on an item but it does not appear in the AI Items settings page or in AI responses, check that the item's type matches one of the supported types listed above and that it is not archived.
</Note>

## Quick reference

| I want the AI to…                                         | Settings                                                |
| --------------------------------------------------------- | ------------------------------------------------------- |
| Show and sell this item with full details                 | Available to AI ✓, Visible ✓                            |
| Acknowledge this item exists but not show price or a link | Available to AI ✓, Visible ✗                            |
| Never mention this item at all                            | Available to AI ✗                                       |
| Describe the item without showing any price               | Available to AI ✓, Show price to AI ✗                   |
| Show a different price than the regular one               | Available to AI ✓, Show price to AI ✓, set Price for AI |
| Give the AI extra context for its descriptions            | Available to AI ✓, fill in Notes for AI                 |

<Frame>
  <img alt="Side-by-side: a day pass with full AI visibility shown to users vs one with Visible off where the AI says contact us" />
</Frame>

## Access control per capability

The AI follows exactly the same access rules as the rest of your portal. There is no separate AI-level access control — you manage it in the same places you already use.

| Capability                    | Access controlled by                                                                              |
| ----------------------------- | ------------------------------------------------------------------------------------------------- |
| **FAQ answers**               | The *Access > FAQs* setting in your portal configuration: Everyone / Only members / Only contacts |
| **Meeting rooms & resources** | The *Visible*, *Only for members*, and *Only for contacts* flags on each resource                 |
| **Location information**      | Always public — no restrictions apply                                                             |
| **Day passes**                | The *Available to AI* and *Visible* fields on each product                                        |
| **Membership plans**          | The *Available to AI* and *Visible* fields on each tariff                                         |
| **Private offices**           | The *Available to AI* field on each floor plan item                                               |

<Note>
  If your FAQ articles are set to "Members only", a prospect who is not logged in will receive a message saying they need to be a member to access that information — not the answer itself. The same applies to "Contacts only". This is handled automatically; you do not need to configure anything in the AI separately.
</Note>

## Channel settings

By default, only the chat channel is active. You can enable the email, WhatsApp, and voice channels in your business settings:

| Setting                   | What it controls                                                                                                                             |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **AI Email**              | Enables the email channel. When on, your space's AI email address accepts inbound messages.                                                  |
| **AI WhatsApp**           | Enables the WhatsApp channel. When on, your space's WhatsApp number accepts inbound messages.                                                |
| **WhatsApp phone number** | The Twilio-enabled phone number for your space's WhatsApp channel. Required when AI WhatsApp is enabled. Each location needs its own number. |
| **AI Voice**              | Enables the voice channel. When on, your space's phone number accepts inbound calls.                                                         |
| **Voice phone number**    | The Twilio-enabled phone number for your space's voice channel. Required when AI Voice is enabled. Each location needs its own number.       |

The AI-specific fields on items (Available to AI, Show price to AI, Price for AI, Notes for AI) apply uniformly across all channels. There is no way to make an item available on one channel but not another — if it is available to the AI, it is available on chat, email, WhatsApp, and voice.

See [Channels](./channels) for a full comparison of channel behaviour and setup.


# Visitor Approvals
Source: https://learn.nexudus.com/member-portal/ai/visitor-approvals

How logged-in members approve or reject their pending visitors through conversational AI across all channels.

The AI enables hosts to manage visitor approval requests conversationally. Hosts can approve or reject visitors by name, process multiple visitors at once, or approve everyone waiting with a single command. The AI works across all channels: chat, email, WhatsApp, and voice.

<Note>
  This capability requires the member to be identified — on chat this means being signed in; on email, WhatsApp, and voice the member is identified by their email address, phone number, or caller ID. The AI will prompt unidentified users to log in or provide contact details before proceeding.
</Note>

## Prerequisites

Before a host can use the AI to approve visitors:

* **Visitor approval must be enabled** for the location under **Settings → Apps and integrations → Companion apps → NexIO → Require host approval for walk-in visitors**
* The visitor must be registered via **NexIO** (walk-in self-registration) with the host assigned
* The host must be a **customer** with an active profile
* On WhatsApp and voice, the host's **mobile phone number** must match their customer profile

If the AI cannot match the phone number or email to a customer record, it asks the host to verify their contact details in their member profile.

***

## Checking for pending visitors

Hosts can ask the AI at any time if they have visitors waiting:

* "Any visitors?"
* "Who's waiting for me?"
* "Do I have any pending visitors?"

The AI lists all visitors currently awaiting the host's approval, showing:

* Visitor name
* Company (if provided)
* Expected arrival time
* Reason for visit (if provided)

If no visitors are pending, the AI confirms there's no one waiting.

***

## Approving or rejecting a visitor

### The approval flow

The AI uses a **draft → confirm → apply** flow to ensure decisions are never applied accidentally:

**Step 1 — Draft.** The host mentions a visitor by name and indicates their decision ("approve Alex", "reject Maria", "approve Bob and I'll collect him"). The AI identifies the visitor from the pending list, interprets the decision, and drafts the action. A short-lived confirmation token is issued.

**Step 2 — Confirm.** The AI presents a summary showing:

* The visitor's full name
* Expected arrival time
* The decision that will be applied

The AI asks the host to confirm. The confirmation window depends on the channel — 10 minutes for chat, 1 hour for WhatsApp, 4 hours for email, and during the call for voice. See [Channels](channels) for details.

**Step 3 — Apply.** Once the host confirms (by replying "confirm", "yes", or equivalent), the AI updates the visitor's approval status in Nexudus. Staff members with visitor notifications enabled are notified, and — if configured — the visitor is checked in automatically.

<Note>
  If the confirmation window expires, the AI tells the host and asks them to confirm again. A fresh token is issued with the same decision. No changes are saved until the host confirms.
</Note>

### Response options

The available approval options depend on your location's settings under **NexIO → Require host approval**:

| Option                            | What it means                                      | When available                                                                                   |
| --------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| **Approve, I'll collect them**    | Host will come to reception to collect the visitor | Enabled by default; can be disabled via *Host can choose to collect visitors at reception*       |
| **Approve, send to my unit/desk** | Visitor can proceed directly to the host's area    | Enabled by default; can be disabled via *Host can choose to send visitors to their unit or desk* |
| **Reject**                        | Host declines the visit; visitor is turned away    | Always available                                                                                 |

The AI adapts the decision parsing based on which options are active. If only one approval type is enabled (e.g., only "collect at reception"), the AI automatically applies that type when the host says "approve" without specifying.

### Natural language support

Hosts can reply in whatever way feels natural:

* **By name** — "approve Alex", "reject John", "approve Maria and send her to my desk", "approve Bob, I'll collect him"
* **With numbers** — if the host received the original approval message with numbered options (e.g., from WhatsApp), they can reply with `1`, `2`, or `3`
* **By state** — if there's only one pending visitor, "approve" or "reject" on its own is enough
* **With clarification** — "approve and grant access", "approve and hold", "reject"

The AI parses the intent and confirms the decision before applying it.

***

## Approving multiple visitors at once

Hosts can process several visitors in a single conversation:

* "Approve Alex but reject John"
* "Approve Alex and Maria"
* "Approve everyone"
* "Approve all"

When the host mentions multiple visitors or uses "approve all", the AI:

1. Drafts each decision individually
2. Presents a combined summary listing all visitors and the action that will be applied to each
3. Asks the host to confirm the full set
4. Applies all decisions at once only after the host confirms

For "approve all", the AI first asks which approval type to apply (collect at reception or grant access), then applies that type to every pending visitor. This makes it safe to process a busy morning of walk-ins in a single reply.

<Tip>
  If a host frequently uses "approve all", consider enabling auto-check-in under **NexIO settings → Automatically check approved visitors in** so visitors granted access are checked in without staff intervention.
</Tip>

***

## Auto check-in for approved visitors

When the host approves a visitor with the **"grant access"** option and **Automatically check approved visitors in** is enabled in NexIO settings, the visitor is checked in immediately. This reduces front-desk workload — the visitor can proceed directly to the host's area without staff intervention.

Check-in is only triggered for:

* Visitors approved with the "grant access" decision
* When auto check-in is enabled for the location

Visitors approved with "I'll collect them" are not automatically checked in — they wait at reception for the host.

***

## What happens on the visitor record

Regardless of whether the host replies via chat, email, WhatsApp, or voice, the visitor record ends up in one of these states:

| Status on visitor record           | Meaning                                            |
| ---------------------------------- | -------------------------------------------------- |
| **Requested**                      | Waiting for the host's response                    |
| **Accepted — hold for collection** | Host will come to reception to collect the visitor |
| **Accepted — grant access**        | Visitor may proceed to the host's desk or unit     |
| **Rejected**                       | Host has turned the visitor away                   |

The status is visible in the callout at the top of the visitor form in the Nexudus administration panel and in the **Status** column on the visitors list.

***

## Staff notifications

When a host approves or rejects a visitor through the AI, staff members with **Visitor registration** notifications enabled receive a system message:

* **Visitor accepted** — includes the visitor name, host name, and approval type (hold or grant access)
* **Visitor rejected** — includes the visitor name and host name

These notifications appear in the Nexudus administration panel notification feed and can be configured per user under **Profile → Notifications → Visitor registration**.

***

## Conversation examples

### Single visitor approval

**Host:** "Any visitors?"

**AI:** "You have one visitor waiting: Alex Smith (expected at 10:30). Would you like to approve or reject?"

**Host:** "Approve Alex, I'll collect them"

**AI:** "Just to confirm: approve Alex Smith (expected at 10:30), option **Approve, I'll collect them**? Reply *confirm* to apply or *cancel* to abort."

**Host:** "Confirm"

**AI:** "Done. Alex Smith has been approved and is waiting to be collected."

### Multiple visitor approval

**Host:** "Do I have any visitors?"

**AI:** "You have 3 visitors waiting: Alex Smith (10:30), Maria Garcia (11:00), and Bob Johnson (11:30)."

**Host:** "Approve Alex and Maria but reject Bob"

**AI:** "Just to confirm, these decisions will be applied:

* Alex Smith (10:30) — Approve, send to my unit/desk
* Maria Garcia (11:00) — Approve, send to my unit/desk
* Bob Johnson (11:30) — Reject

Reply *confirm* to apply or *cancel* to abort."

**Host:** "Confirm"

**AI:** "Done. Alex Smith and Maria Garcia have been approved and will be directed to your desk. Bob Johnson has been rejected."

### Approve all

**Host:** "Approve everyone"

**AI:** "You have 3 visitors waiting. Which approval type should I apply to all of them?

1. Approve, I'll collect them
2. Approve, send to my unit/desk

Please choose 1 or 2."

**Host:** "2"

**AI:** "Just to confirm, these decisions will be applied:

* Alex Smith (10:30) — Approve, send to my unit/desk
* Maria Garcia (11:00) — Approve, send to my unit/desk
* Bob Johnson (11:30) — Approve, send to my unit/desk

Reply *confirm* to apply or *cancel* to abort."

**Host:** "Confirm"

**AI:** "Done. All visitors have been approved and will be directed to your desk."

***

## Related pages

<CardGroup>
  <Card title="Visitor Approval" icon="circle-check" href="/platform/operations/visitor-approval">
    Configure the visitor approval workflow in the administration panel.
  </Card>

  <Card title="Visitor Approval on WhatsApp" icon="whatsapp" href="/platform/operations/visitor-approval-whatsapp">
    Set up the WhatsApp approval message that hosts receive when a visitor arrives.
  </Card>

  <Card title="Visitors" icon="user-plus" href="/platform/operations/visitors">
    Main visitor management — registration, check-in, and lifecycle.
  </Card>

  <Card title="Channels" icon="comments" href="channels">
    Learn about confirmation windows and how they differ across channels.
  </Card>
</CardGroup>


# Password Recovery
Source: https://learn.nexudus.com/member-portal/auth/password-recovery

The forgot password flow where members request a password reset link.

# Password Recovery

The password recovery page is step one of the password reset flow. Members enter their email address to receive a reset link.

<Frame>
  <img alt="Password Recovery page" />
</Frame>

## Flow

1. Member enters their **email address**.
2. Clicks **Reset password** (a loading spinner indicates the request is being processed).
3. A confirmation message appears confirming the email was sent.
4. **Go to Inbox** shortcuts appear for Gmail, Outlook, iCloud, and Yahoo.
5. Member clicks the reset link in their email to proceed to the [Password Reset](./password-reset) page.

A **Back to sign in** link is always visible for members who remember their password.

## Page layout

| Side      | Content                                               |
| --------- | ----------------------------------------------------- |
| **Left**  | "Forgot Password" illustration (hidden on mobile)     |
| **Right** | Email form, confirmation message, and inbox shortcuts |

The business logo and primary colour theme are applied from your location settings.


# Password Reset
Source: https://learn.nexudus.com/member-portal/auth/password-reset

The token-based password reset form where members set a new password.

# Password Reset

The password reset page is step two of the recovery flow. Members arrive here by clicking the reset link in their email. The link contains a secure token that authenticates the request.

<Frame>
  <img alt="Password Reset page" />
</Frame>

## Flow

1. Member clicks the reset link from their email — the URL contains a JWT token.
2. The page decodes the token and extracts the member's **email address**, displaying it in a read-only field.
3. Member enters a **new password** that meets strength requirements.
4. Clicks **Reset password**.
5. A success message confirms the password was changed.
6. Member navigates **Back to sign in** to log in with their new password.

## Token validation

The page performs several checks on the JWT token:

| Check                     | Behaviour if failed |
| ------------------------- | ------------------- |
| Token missing             | Redirects to login  |
| Token malformed / invalid | Redirects to login  |
| Token expired             | Redirects to login  |

If any check fails, the member is silently redirected to the sign-in page where they can start the recovery process again.

## Password requirements

The new password must meet the strength rules defined by your location's validation schema. Members see real-time feedback as they type. A show/hide toggle is available for the password field.

## Page layout

| Side      | Content                                                      |
| --------- | ------------------------------------------------------------ |
| **Left**  | "Real Time Sync" illustration (hidden on mobile)             |
| **Right** | Email display (read-only), password field, and submit button |

The business logo and primary colour theme are applied from your location settings.


# Sign In
Source: https://learn.nexudus.com/member-portal/auth/sign-in

The authentication page with email/password, magic links, OTP, and SSO options.

# Sign In

The sign-in page is the gateway to the Members Portal. It supports multiple authentication methods to suit different security and convenience needs.

<Frame>
  <img alt="Sign In page" />
</Frame>

## Authentication methods

### Email & password

The standard login flow:

| Field           | Description                                   |
| --------------- | --------------------------------------------- |
| **Email**       | Member's registered email address (validated) |
| **Password**    | Account password with show/hide toggle        |
| **Remember me** | Checkbox to extend the session to 14 days     |

A **Forgot password?** link leads to the [password recovery](./password-recovery) flow.

### Magic link

Instead of typing a password, members can request a one-time login link sent to their email. After clicking "Send magic link", the page shows a **Go to Inbox** section with quick links to popular email providers (Gmail, Outlook, iCloud, Yahoo).

### Two-factor authentication (TOTP)

If enabled, members enter a 6-digit code from their authenticator app after providing their email and password. The OTP input features:

* Auto-focus advancing between digits
* Numeric-only input
* Keyboard navigation with backspace support

### Single Sign-On (SSO)

Buttons for external identity providers appear when configured:

| Provider                   | Description                           |
| -------------------------- | ------------------------------------- |
| **Google**                 | OAuth via Google accounts             |
| **Okta**                   | Enterprise SSO via Okta               |
| **Azure Active Directory** | Enterprise SSO via Microsoft Azure AD |
| **OpenID Connect**         | Generic OpenID Connect provider       |

SSO buttons display provider names with fallback labels.

## Account creation

If signup is enabled for the location, a **Create an account** link opens a signup form as a modal overlay — members can register without leaving the login page.

## Page layout

The page uses a split layout:

| Side      | Content                                  |
| --------- | ---------------------------------------- |
| **Left**  | Illustration graphic (hidden on mobile)  |
| **Right** | Login form, SSO buttons, and signup link |

The business logo and primary colour theme are applied automatically from your location settings.

## Redirect handling

After successful login, members are redirected to their intended destination. The redirect URL is validated against a list of allowed domains to prevent open-redirect vulnerabilities.

## Configuration

| Setting        | Effect                                                |
| -------------- | ----------------------------------------------------- |
| Signup enabled | Controls whether the "Create an account" link appears |
| Google SSO     | Enables Google login button                           |
| Okta SSO       | Enables Okta login button                             |
| Azure AD SSO   | Enables Azure AD login button                         |
| OpenID Connect | Enables OpenID Connect login button                   |
| Magic link     | Built-in, always available                            |


# Booking Checkout
Source: https://learn.nexudus.com/member-portal/checkout/booking-checkout

The booking checkout flow where members create or edit resource bookings.

The booking checkout page is where members finalise a resource booking — selecting dates, desks, visitors, add-ons, and completing payment.

<Frame>
  <img alt="Booking checkout page" />
</Frame>

## What members see

The page uses a two-column layout: booking details on the left and a basket summary on the right.

### Booking details (left column)

| Section                  | Description                                                                       |
| ------------------------ | --------------------------------------------------------------------------------- |
| **Resource information** | Resource image, name, features, and selected dates                                |
| **Booking for**          | Specifies who the booking is for (self or a team member)                          |
| **Desk selection**       | Choose a specific desk if the resource supports desk-level booking                |
| **Visitors**             | Add and manage visitors who will attend                                           |
| **Add-on products**      | Select related products to include with the booking (e.g. catering, AV equipment) |
| **Custom fields**        | Fill in any custom fields your space requires for bookings                        |
| **Notes**                | Add optional booking notes or comments                                            |
| **Payment method**       | Choose how to pay for the booking                                                 |

### Basket summary (right column)

A running total showing line items, taxes, and the final amount. Updates in real time as the member adds or removes items.

## Key features

* **Create or edit** — the same page handles both new bookings and modifications to existing ones.
* **Resource switching** — members can change the selected resource via a modal without leaving checkout.
* **Recurring bookings** — set recurrence patterns for regular bookings.
* **Real-time pricing** — the basket recalculates as options change.
* **Desk picker** — visual desk selection for resources with assigned desks.
* **Visitor tracking** — add visitor names and details directly during checkout.

## Configurable sections

Every section of this page can be independently shown or hidden from the Page Editor:

| Setting               | Default | Effect                             |
| --------------------- | ------- | ---------------------------------- |
| Show resource image   | On      | Display the resource photo         |
| Show resource details | On      | Display resource features and info |
| Show desk selection   | On      | Enable desk picker                 |
| Show visitors         | On      | Show visitor management fields     |
| Show add-on products  | On      | Allow product add-ons              |
| Show custom fields    | On      | Display custom field inputs        |
| Show notes            | On      | Show the notes field               |
| Show payment method   | On      | Show payment method picker         |
| Show basket summary   | On      | Show the cost summary sidebar      |
| Show back button      | On      | Show back navigation               |

<Tip>If your space doesn't use desk-level bookings or visitor tracking, turn those sections off to keep the checkout flow simple and focused.</Tip>


# Cart
Source: https://learn.nexudus.com/member-portal/checkout/cart

The multi-item shopping cart where customers review, manage, and check out multiple items at once.

The cart allows customers to collect multiple items — bookings, products, events, and courses — and purchase them together in a single checkout.

<Frame>
  <img alt="Cart page showing items ready for checkout" />
</Frame>

## How the cart works

Customers can add items to their cart from any checkout page (bookings, products, events, or courses) using the **Add to Cart** button. Once they have collected everything they need, they can review and pay for all items in one go.

The cart is persistent — items are saved in the browser for 30 minutes, so customers won't lose their selections if they navigate away.

### What customers see

The cart page uses a two-column layout:

| Section                   | Description                                                                   |
| ------------------------- | ----------------------------------------------------------------------------- |
| **Item list** (left)      | Each item in the cart shown with its details, price, and a remove button      |
| **Order summary** (right) | Running totals including subtotal, taxes, applied credits, and discount codes |
| **Proceed to checkout**   | Button to move to the payment step                                            |
| **Continue shopping**     | Link back to the store to add more items                                      |

### Item types supported

The cart can hold any combination of:

* **Bookings** — resource reservations with date, time, and resource details
* **Products** — store items with adjustable quantities
* **Events** — event registrations
* **Courses** — course enrolments

### Quantity controls

For products, customers can adjust the quantity directly from the cart using the + and − buttons. Other item types (bookings, events, courses) have a fixed quantity of one.

## Conflict detection

If a booking in the cart becomes unavailable (e.g. another customer booked the same time slot), the cart automatically detects this and shows an alert. Customers can remove the conflicting booking and continue with the rest of their order.

## Order summary

The order summary sidebar shows:

* **Subtotal** — total before tax
* **Tax** — applicable taxes
* **Applied credits** — any booking credits or benefits automatically applied
* **Discount codes** — customers can enter a discount code before checkout
* **Total** — final amount due

## Cart checkout

When the customer clicks **Proceed to checkout**, they are taken to the payment page.

<Frame>
  <img alt="Cart payment page" />
</Frame>

The payment page shows the full order summary and offers the available payment methods configured for your location:

| Payment method                   | Description                                |
| -------------------------------- | ------------------------------------------ |
| **Credit/debit card (Stripe)**   | Pay immediately with a saved or new card   |
| **Credit/debit card (Spreedly)** | Alternative card payment gateway           |
| **PayPal**                       | Redirect to PayPal for payment             |
| **Invoice**                      | Place the order and pay later (if enabled) |

<Info>
  The available payment methods depend on your location's payment gateway configuration. If no payment is required (e.g. credits cover the full amount), the order is placed immediately without a payment step.
</Info>

### After payment

Once payment is complete:

1. The cart is automatically cleared
2. The customer is redirected to a confirmation page
3. All items are processed (bookings confirmed, event registrations created, etc.)

## Guest checkout

Customers who are not logged in can also use the cart. They will be prompted to either log in or continue as a guest before payment. Guest checkout is available when a card payment gateway (Stripe, Spreedly, or PayPal) is enabled.

## Localisation

<Note>
  In British English locales, the cart is labelled as "Basket" throughout the portal. All other English locales use "Cart".
</Note>


# Course Checkout
Source: https://learn.nexudus.com/member-portal/checkout/course-checkout

The checkout flow for enrolling in a course.

The course checkout page lets members enrol in and pay for a course in a single step.

<Frame>
  <img alt="Course checkout page" />
</Frame>

## What members see

A two-column layout with course details on the left and a basket summary on the right.

### Course information

* **Course title and featured image**
* **Instructor / host name**
* **Number of lessons**
* **Price** displayed in the location's currency
* **Collapsible description** — full course details rendered from markdown

### Payment & summary

* **Payment method selector** — choose how to pay
* **Basket summary** — total cost including any taxes

## Key features

* **One-step enrolment** — members review the course details and purchase in a single flow.
* **Localised pricing** — prices are formatted in the location's currency.
* **Analytics tracking** — enrolment initiation is tracked for reporting.

## Configurable sections

| Setting                 | Default | Effect                             |
| ----------------------- | ------- | ---------------------------------- |
| Show back button        | On      | Show back navigation               |
| Show basket summary     | On      | Display the cost summary sidebar   |
| Show course image       | On      | Display the course featured image  |
| Show course description | On      | Show the expandable course details |

<Tip>After enrolling, members can track their course progress from the [My Courses](../dashboard/my-courses) activity page.</Tip>


# Dynamic Pricing
Source: https://learn.nexudus.com/member-portal/checkout/dynamic-pricing

How dynamic pricing adjusts booking costs based on demand, availability, and last-minute bookings — and how members see it in the portal.

Dynamic pricing automatically adjusts booking prices based on predicted demand, remaining availability, and how close to the booking start time a reservation is made. When enabled, members see real-time price indicators directly in the booking calendar and time selectors.

<Frame>
  <img alt="Close-up of day cells with price percentage indicators" />
</Frame>

## How members see dynamic pricing

### Calendar day prices

When a member opens the booking date picker, each day in the calendar displays a percentage indicator showing how the price for that day compares to the base rate.

| Indicator         | Meaning                                         |
| ----------------- | ----------------------------------------------- |
| **+10%** (orange) | Price is above the base rate due to high demand |
| **-15%** (green)  | Price is below the base rate due to low demand  |
| No indicator      | No dynamic adjustment — base rate applies       |

<Frame>
  <img alt="Calendar showing dynamic pricing annotations on each day" />
</Frame>

### Time selector prices

When a member opens the start or end time dropdown, each time slot shows the calculated price alongside the percentage adjustment.

* **Start time dropdown** — shows the price for a booking of the same duration starting at each time slot.
* **End time dropdown** — shows the price for a booking starting at the selected start time and ending at each time slot.

<Frame>
  <img alt="Time selector dropdown showing prices next to each time slot" />
</Frame>

## How pricing is calculated

Dynamic pricing is applied per hour of a booking. Each hour is evaluated independently, and the final price is the sum of all hourly prices after adjustments.

### Demand-based pricing

The system predicts demand for each hour using a machine learning model trained on:

* **Historical booking data** — past occupancy patterns by hour, day of week, and season.
* **Holiday calendars** — public holidays and location-specific closures.
* **Forecasted bookings** — already-confirmed future bookings that reduce remaining capacity.

Each hour is classified into a demand level — **high**, **average**, or **low** — and a corresponding price factor is applied.

### Availability-based pricing

When availability drops below certain thresholds, additional adjustments can be applied:

| Remaining availability | Effect                                                |
| ---------------------- | ----------------------------------------------------- |
| Less than 50%          | Applies the configured factor for \< 50% availability |
| Less than 25%          | Applies the configured factor for \< 25% availability |
| Less than 10%          | Applies the configured factor for \< 10% availability |

The system checks the most restrictive threshold first. Only one availability factor is applied per hour.

### Last-minute pricing

Bookings made close to the start time can receive an additional adjustment. Two modes are available:

* **Fixed** — a flat percentage adjustment applied when the booking is made within the configured last-minute period.
* **Gradual** — the adjustment increases as the booking time approaches. A booking made 5 minutes before start receives a larger adjustment than one made 2 hours before.

The last-minute period and adjustment percentage are configurable at both the location and resource rate levels.

## Adjustment priority

When multiple pricing rules could apply, the system follows a strict priority order:

1. **Previously charged bookings** — if a booking has already been charged, its original pricing factors are preserved. Editing a charged booking does not recalculate dynamic pricing.
2. **Resource rate overrides** — if the resource rate used for pricing has its own demand or last-minute factors configured, those take precedence over location-level settings.
3. **Location-level settings** — global demand and last-minute factors apply when no resource rate override exists.

Availability-based pricing is evaluated separately and can stack on top of demand-based adjustments.

## Configuration

### Enabling dynamic pricing

Dynamic pricing requires two conditions:

1. The location subscription must have billing available (For example, the Workplaces product does not include billing and therefore cannot use the Dynamic Pricing module).
2. The Dynamic Pricing must must be turned on in your Admin Panel.

If either condition is not met, no dynamic pricing indicators appear in the portal and no adjustments are applied.

### Location-level settings

| Setting                     | Description                                                      |
| --------------------------- | ---------------------------------------------------------------- |
| High demand factor          | Percentage adjustment for high-demand hours                      |
| Average demand factor       | Percentage adjustment for average-demand hours                   |
| Low demand factor           | Percentage adjustment for low-demand hours                       |
| Last-minute factor          | Percentage adjustment for last-minute bookings                   |
| Last-minute period          | How many minutes before booking start qualifies as "last minute" |
| Last-minute adjustment type | Fixed, Gradual, or Disabled                                      |
| Apply dynamic pricing from  | Date from which dynamic pricing takes effect                     |

### Availability threshold settings

| Setting              | Description                                       |
| -------------------- | ------------------------------------------------- |
| Less than 10% factor | Adjustment when less than 10% of capacity remains |
| Less than 25% factor | Adjustment when less than 25% of capacity remains |
| Less than 50% factor | Adjustment when less than 50% of capacity remains |

### Resource rate overrides

Each resource rate can override the location-level factors:

| Setting                     | Description                                            |
| --------------------------- | ------------------------------------------------------ |
| High demand factor          | Overrides the location's high demand percentage        |
| Average demand factor       | Overrides the location's average demand percentage     |
| Low demand factor           | Overrides the location's low demand percentage         |
| Last-minute factor          | Overrides the location's last-minute percentage        |
| Last-minute period          | Overrides the location's last-minute period in minutes |
| Last-minute adjustment type | Overrides Fixed / Gradual for this rate                |

<Info>
  Resource rate overrides are useful when some resources (e.g. premium meeting rooms) should have different pricing sensitivity than others (e.g. hot desks).
</Info>

## Portal behaviour

* Prices are fetched lazily — only when the date picker is open and only for the visible month.
* Time slot prices load when the start or end time dropdown is opened.
* Prices update automatically when the selected start or end time changes, since the booking duration affects the total cost.
* Changing the selected day does not trigger a full recalculation — cached prices are reused for days already fetched.
* All price data comes from the `POST /api/public/bookings/price` endpoint, which returns the total price and individual adjustment components for a given time range.

<Warning>
  Dynamic pricing applies to the price shown at checkout. Members on plans with booking credits or time allowances may see a price that differs from what they are ultimately charged, depending on how credits are applied.
</Warning>


# Event Checkout
Source: https://learn.nexudus.com/member-portal/checkout/event-checkout

The checkout flow for purchasing event tickets.

The event checkout page handles ticket purchases for events, including multi-ticket orders with per-attendee information.

<Frame>
  <img alt="Event checkout page" />
</Frame>

## What members see

A two-column layout with event and ticket details on the left and a basket summary on the right.

### Event information

* **Event name, image, and date/time range**
* **Location and venue address** with a map link
* **Host / organiser name**
* **Collapsible description** — full event details that expand on demand

### Ticket selection

Multiple ticket types can be listed, each showing:

* **Ticket name and price**
* **Tickets remaining** — or a "Sold out" badge
* **Quantity dropdown** — select how many of each ticket type to purchase

### Attendee information

For each ticket purchased, members fill in:

* **Attendee name**
* **Attendee email address**

A responsive table lets members enter details for all tickets at once, with real-time validation.

### Waiting list

If all ticket types are sold out, members can optionally register for a waiting list.

## Key features

* **Multi-ticket checkout** — buy different ticket types in a single order.
* **Per-attendee capture** — collect individual attendee details for every ticket.
* **Live availability** — ticket counts update to reflect remaining inventory.
* **Waitlist support** — keep demand visible even when tickets are sold out.

## Configurable sections

| Setting                | Default | Effect                            |
| ---------------------- | ------- | --------------------------------- |
| Show back button       | On      | Show back navigation              |
| Show basket summary    | On      | Display the cost summary sidebar  |
| Show event image       | On      | Display the event featured image  |
| Show event description | On      | Show the expandable event details |


# Guest Checkout
Source: https://learn.nexudus.com/member-portal/checkout/guest-checkout

How guest checkout works and when it is available to customers who are not logged in.

Guest checkout lets customers complete a purchase without creating an account. When available, the checkout page shows a **Continue as guest** button that takes the customer straight to the payment step.

## When is guest checkout available?

Guest checkout is offered automatically when **all** of the following conditions are met:

| Condition                                              | Why it matters                                                                                                                                                              |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Stripe, Spreedly, or PayPal is enabled                 | Guest checkout requires one of these gateways. GoCardless (direct debit) is not supported for guest checkout because it requires a linked bank account and customer record. |
| The order total is greater than zero                   | Free orders are handled through a different confirmation flow.                                                                                                              |
| No required registration fields beyond address details | If your location requires extra profile fields (e.g. company name, tax ID), the customer must create an account so those fields can be collected.                           |
| The product has no benefits attached                   | Products that grant benefits (such as booking credits or access) need a customer account to be applied to.                                                                  |
| The basket does not contain a course                   | Courses track progress and completions, which require a customer account.                                                                                                   |

<Info>If **any** of the conditions above is not met, the guest checkout option is hidden and the customer is prompted to create an account instead.</Info>

## What the customer sees

When a customer who is not logged in reaches the checkout page, the flow depends on whether guest checkout is available.

### Guest checkout available

1. A banner invites the customer to **log in** for faster checkout and special pricing.
2. A link to **create an account** is shown for customers who want to provide invoice or company details.
3. A **Continue as guest** button skips registration and goes straight to the payment method selection.

### Guest checkout not available

1. The same log-in banner is shown.
2. A **Create an account** button opens a registration form. The customer must complete it before proceeding to payment.

## How registration fields affect guest checkout

Your location's checkout field configuration controls whether guest checkout is offered. The portal fetches the required fields for the items in the basket and checks whether any required fields fall outside the standard address group (address, post code, city, state, and country).

* If only address fields are required — guest checkout **is** available, because those fields are collected during payment.
* If any other fields are required — guest checkout **is not** available, and the customer must register first.

<Tip>Review your checkout field requirements in the Nexudus dashboard. Removing unnecessary required fields makes guest checkout available to more customers and can reduce cart abandonment.</Tip>

## Payment methods during guest checkout

Once a guest customer clicks **Continue as guest**, they see the same payment method options as any other customer — credit/debit card, PayPal, hosted payment providers, and so on. The available options depend on which payment gateways are enabled for your location.

<Note>The **Pay via Invoice** option is only available to logged-in customers with an active booking or event, so guest customers will not see it.</Note>

## What happens after payment

When a guest customer completes payment, the system automatically creates a customer record and an invoice on their behalf. The exact sequence depends on the payment gateway, but the overall outcome is the same: the guest ends up with a customer profile in your location and a paid invoice.

### Automatic customer creation

The system creates a new customer record using the details the payment provider collects during checkout. The information pulled from each gateway is:

| Field                               | Stripe                                  | PayPal                                  | Spreedly                           |
| ----------------------------------- | --------------------------------------- | --------------------------------------- | ---------------------------------- |
| **Full name**                       | Billing name from the checkout form     | Payer's given name and surname          | Cardholder full name               |
| **Email**                           | Email entered during checkout           | Payer's email address                   | Email from payment method          |
| **Address, city, post code, state** | Billing address from the checkout form  | Payer's address                         | Address from payment method        |
| **Country**                         | Looked up from the billing country code | Looked up from the payer's country code | Defaults to the location's country |

If the customer is already logged in, the existing account is used instead of creating a new one.

### How the order is processed

Regardless of which payment gateway is used, the experience is the same for both customers and operators:

<Steps>
  <Step title="Customer pays">
    The guest completes payment through the chosen gateway.
  </Step>

  <Step title="Payment is confirmed">
    The system verifies the payment with the gateway.
  </Step>

  <Step title="Customer record is created">
    A new customer profile is created in your location using the details collected by the payment provider.
  </Step>

  <Step title="Invoice is issued">
    An invoice is generated, assigned a number, and marked as paid. This is the first time the invoice becomes visible to the customer and to operators in the dashboard.
  </Step>
</Steps>

<Note>No invoice is visible — to the customer or in the Nexudus dashboard — until payment has been confirmed by the payment provider. You will never see an unpaid guest checkout invoice.</Note>

### Automatic refunds on failure

If something goes wrong after payment but before the invoice can be created (for example, a product becomes unavailable), the system automatically refunds the customer:

* **Stripe** — the payment intent is refunded in full and the session is marked as refunded.
* **PayPal** — the captured payment is refunded and the session is marked as refunded.
* **Spreedly** — because Spreedly processes the card directly in the portal, a failed transaction is detected immediately. The session is cancelled and no invoice number is ever assigned, so the customer is not charged in the first place. There is nothing to refund.

The customer is never left with a charge and no corresponding invoice.

### Card storage

After a guest checkout, card details may be stored depending on your location's payment settings:

* **Stripe** — a Stripe customer ID is created and linked to the new customer record. If the *Enable subscriptions* setting is on, the payment method is saved for future off-session charges.
* **Spreedly** — card details are retained based on the *Keep card details for contacts* and *Keep card details for members* settings in the Nexudus dashboard. Only the last four digits and a token are stored.
* **PayPal** — no card details are stored. Each transaction is independent.

## After checkout — account creation prompt

Once a guest customer completes their purchase, the confirmation page invites them to create an account. This is optional — their order is already confirmed and paid regardless.

The confirmation page shows:

* A summary of the transaction (ID, date, payment method, total amount).
* The purchased items.
* A **Create an account** button (only shown to guests who are not logged in).
* A **Continue** link to return to the home page.

When the customer clicks **Create an account**, a confirmation dialog explains the benefits:

> *Creating an account will allow you to place bookings faster, manage all your bookings and purchases, view invoices, and much more. We will send you an email with your login details.*

If the customer confirms, an account is created from the invoice details and they are automatically logged in and taken to their personal dashboard. If they choose not to create an account, their order is unaffected — they can simply continue or close the page.

<Tip>Guest customers who create an account after checkout are linked to the customer record that was already created during payment. They will see their invoice and any bookings or event registrations in their dashboard straight away.</Tip>


# Guest Invoice Payment
Source: https://learn.nexudus.com/member-portal/checkout/guest-invoice-payment

How to send a payment link for an existing invoice so customers can pay without logging in.

Guest invoice payment lets you share a direct payment link with a customer so they can pay an outstanding invoice without needing to log in to the Members Portal. This is useful when a customer does not have an account, has forgotten their credentials, or when you want to send a quick payment reminder via email or messaging.

## How it works

When you view an unpaid invoice in the Nexudus dashboard, a **Payment link** field appears in the Payments section. Copy this link and send it to your customer through any channel — email, WhatsApp, SMS, or your CRM.

<Frame>
  <img alt="Sequence diagram showing CLI to Browser to API flow for PII unlock" />
</Frame>

When the customer opens the link, they see:

1. A summary of the invoice (items, amounts, due balance).
2. The available payment methods for your location.
3. An option to log in if they are already a member (for faster checkout and saved payment methods).

No account or password is required to complete the payment.

<Info>The payment link is only shown for locations running the latest version of the Members Portal.</Info>

## Invoice notification links

When invoice notifications are sent, Nexudus selects the link automatically based on whether the customer has portal access:

* **Customer has portal access**: the email includes a magic log-in link so they can sign in and access the invoice in their account.
* **Customer does not have portal access**: the email includes the guest invoice payment link, so they can pay directly without logging in.

<Tip>You do not need to choose this manually. Nexudus decides which link to include for each customer.</Tip>

## Payment methods available

The guest invoice payment page supports the same payment gateways as your regular checkout:

| Gateway                      | Supported                           |
| ---------------------------- | ----------------------------------- |
| **Stripe**                   | Yes                                 |
| **Spreedly** (card payments) | Yes                                 |
| **PayPal**                   | Yes                                 |
| **GoCardless**               | No — requires a linked bank account |

<Note>At least one of the supported gateways must be enabled in your location settings for the payment link to work.</Note>

## Security

The payment link contains two unique identifiers (the customer's internal ID and the invoice's internal ID). Both must match for the page to load. This means:

* The link cannot be guessed or enumerated.
* It only works for the specific invoice it was generated for.
* Once the invoice is paid, the page shows a confirmation message and the link can no longer be used for payment.

<Warning>Treat payment links like any other sensitive URL. Only share them with the intended recipient.</Warning>

## What the customer sees

### Before payment

The customer sees a summary of the invoice including line items, total amount, and due balance. Below the summary, they choose a payment method and complete the transaction — no login required.

If the customer is already a member, a banner invites them to **log in** for a faster experience with saved payment methods and special pricing.

### After payment

Once payment is confirmed, the customer is taken to a confirmation page showing:

* Transaction ID (invoice number)
* Date
* Payment method used
* Total amount paid
* Items purchased
* A link to download the invoice as PDF
* A **Continue** button to return to the portal home page

<Tip>Unlike the regular guest checkout, the guest invoice payment confirmation page does not show a "Create an account" prompt — since the customer already has a record in your system.</Tip>

## Downloading the invoice PDF

The confirmation page includes a **Download invoice** button that works without authentication. The customer can download their invoice PDF directly from the confirmation page without needing to log in.

## Where to find the payment link

In the Nexudus dashboard:

<Steps>
  <Step title="Open the invoice">
    Go to **Finance → Invoices** and open the unpaid invoice you want to share.
  </Step>

  <Step title="Find the Payment link">
    Scroll down to the **Payments** section. The **Payment link** field shows the URL with a copy button.
  </Step>

  <Step title="Share the link">
    Click the copy button and send the link to your customer.
  </Step>
</Steps>

<Note>The Payment link only appears for unpaid invoices on locations running the latest portal version.</Note>

## Frequently asked questions

<AccordionGroup>
  <Accordion title="What happens if the invoice is already paid?">
    The payment page shows a message confirming the invoice has already been paid. No further action is required.
  </Accordion>

  <Accordion title="Can I use this for draft or voided invoices?">
    No. The payment link only works for issued (non-draft, non-void) invoices with an outstanding balance.
  </Accordion>

  <Accordion title="Does the customer need to create an account?">
    No. The customer can pay without any account. However, if they are already a member, the page suggests they log in for a better experience.
  </Accordion>

  <Accordion title="Which payment confirmation does the customer receive?">
    After payment, the standard payment confirmation email is sent (if enabled in your email templates). The customer also sees an on-screen confirmation immediately after paying.
  </Accordion>

  <Accordion title="Can I regenerate or invalidate a payment link?">
    The link is based on the invoice itself — it cannot be regenerated independently. If you void the invoice, the link will stop working. Creating a new invoice generates a new link.
  </Accordion>
</AccordionGroup>


# Payment Methods
Source: https://learn.nexudus.com/member-portal/checkout/payment-methods

The payment methods available to customers during checkout, and when each one is offered.

During checkout, customers are presented with one or more payment methods depending on your location's configuration and the specifics of the transaction. Payment methods appear in both the **plan signup checkout** (when purchasing a membership plan) and the **booking/product/event checkout** (when making a booking, buying a product, or registering for an event).

## How payment methods are determined

The portal evaluates several factors to decide which payment options to show:

1. **Billing availability** — whether your Nexudus plan includes billing features (not available on the "Workplaces" product version)
2. **Location payment settings** — which gateways you have enabled in the Nexudus dashboard
3. **Customer type** — whether the customer is a member (active contract) or a contact, and whether GoCardless payments are enabled for their account specifically
4. **Transaction amount** — whether there is anything to pay
5. **Invoice state** — whether an invoice has been issued or the transaction is still at the preview/proposal stage
6. **Team billing** — whether the charges are billed to a team instead of the individual
7. **Checkout type** — some payment methods are only available for specific checkout types (e.g. bookings)

<Note>When billing is not available (Workplaces product version), only a "Confirm your subscription" option is shown. The location will contact the customer with instructions to complete payment externally.</Note>

***

## Available payment methods

### Spreedly (card payments)

Spreedly allows customers to pay by credit or debit card. It supports multiple payment gateways under the hood and provides a card entry form directly within the checkout page.

<AccordionGroup>
  <Accordion title="When is Spreedly available?">
    **In plan signup checkout**, Spreedly is offered when **all** of the following are true:

    * Billing is available for the location
    * Spreedly is enabled in your location settings
    * The customer type matches your configuration (enabled for members, enabled for contacts, or both)
    * There is an amount due (the total is greater than zero)
    * An invoice has been generated for the transaction (not just a preview)
    * The customer is paying for themselves (not via a team)

    **In booking/product/event checkout**, Spreedly is offered when **all** of the following are true:

    * Spreedly is enabled and the customer type matches your configuration
    * The order total is greater than zero
    * The customer is not paying via a team
    * At least one payment gateway is configured
  </Accordion>
</AccordionGroup>

***

### Stripe Checkout

Stripe Checkout redirects customers to a Stripe-hosted payment page to complete their card payment securely, then returns them to the portal once done.

<AccordionGroup>
  <Accordion title="When is Stripe Checkout available?">
    **In plan signup checkout**, Stripe Checkout is offered when **all** of the following are true:

    * Billing is available for the location
    * Stripe Checkout is enabled in your location settings
    * A valid Stripe public key is configured
    * There is an amount due (the total is greater than zero)
    * An invoice has been generated for the transaction (not just a preview)
    * The customer is paying for themselves (not via a team)

    **In booking/product/event checkout**, Stripe Checkout is offered when **all** of the following are true:

    * Stripe Checkout is enabled and a valid Stripe public key is configured
    * The order total is greater than zero
    * The customer is not paying via a team
    * At least one payment gateway is configured
  </Accordion>
</AccordionGroup>

***

### PayPal

PayPal allows customers to pay using their PayPal account or a card via the PayPal payment flow. Customers are redirected to PayPal to authorise the payment.

<AccordionGroup>
  <Accordion title="When is PayPal available?">
    **In plan signup checkout**, PayPal is offered when **all** of the following are true:

    * Billing is available for the location
    * PayPal Standard REST is enabled in your location settings
    * There is an amount due (the total is greater than zero)
    * An invoice has been generated for the transaction (not just a preview)
    * The customer is paying for themselves (not via a team)

    **In booking/product/event checkout**, PayPal is offered when **all** of the following are true:

    * PayPal is enabled in your location settings
    * The order total is greater than zero
    * The customer is not paying via a team
    * At least one payment gateway is configured
  </Accordion>
</AccordionGroup>

***

### GoCardless (direct debit)

GoCardless lets customers pay via direct debit from their bank account. Customers may need to link their bank account the first time they use this method. Payments are processed securely through GoCardless and can take several days to clear depending on the customer's bank.

<AccordionGroup>
  <Accordion title="When is GoCardless available?">
    GoCardless is only available in the **plan signup checkout** and is offered when **all** of the following are true:

    * Billing is available for the location
    * GoCardless is enabled in your location settings
    * The customer has GoCardless payments enabled on their account, **or** the relevant customer-type setting is turned on:
      * If the customer is a member: "Enabled for members" must be on
      * If the customer is a contact (or does not yet have a profile): "Enabled for contacts" must be on
    * The customer is paying for themselves (not via a team)
    * The proposal has not already been paid
  </Accordion>
</AccordionGroup>

<Note>If the customer has not yet linked their bank account, they will be prompted to do so through a secure GoCardless popup before they can complete payment.</Note>

***

### Forte (ACH / eCheck payments)

Forte allows customers to pay via ACH bank transfer (eCheck) directly from their bank account. Payments are processed securely through Forte's payment platform.

<AccordionGroup>
  <Accordion title="When is Forte available?">
    **In plan signup checkout**, Forte is offered when **all** of the following are true:

    * Billing is available for the location
    * Forte ACH payments (`Forte.eCheckPayments`) or Forte credit card payments (`Forte.CreditCardPayments`) are enabled in your location settings
    * There is an amount due (the total is greater than zero)
    * An invoice has been generated for the transaction (not just a preview)
    * The customer is paying for themselves (not via a team)

    **In booking/product/event checkout**, Forte is offered when **all** of the following are true:

    * Forte is enabled in your location settings
    * The order total is greater than zero
    * The customer is not paying via a team
    * At least one payment gateway is configured
  </Accordion>
</AccordionGroup>

<Note>You can configure Forte to use sandbox servers for testing via the `Forte.UseSandBoxServers` setting before going live.</Note>

***

### Pay via invoice (pay later)

This option allows customers to complete checkout without paying immediately. An invoice is generated and the location contacts them with instructions to settle payment.

<AccordionGroup>
  <Accordion title="When is pay via invoice available?">
    **In plan signup checkout**, pay via invoice is offered when **all** of the following are true:

    * Billing is available for the location
    * There is an amount due (the total is greater than zero)
    * The transaction is still at the preview stage (an invoice has **not** yet been issued)
    * The customer is paying for themselves (not via a team)
    * The proposal has not already been paid

    **In booking/event checkout**, pay via invoice is offered when **all** of the following are true:

    * The customer is logged in
    * The order total is greater than zero
    * The customer is not paying via a team
    * At least one payment gateway is configured

    **And** at least one of the following conditions is met:

    * GoCardless is enabled for the customer
    * The checkout is for a **booking** and the "Cancel unpaid bookings after" setting is configured to at least 60 minutes
    * The checkout is for an **event** and the "Cancel unpaid tickets" setting is enabled
  </Accordion>
</AccordionGroup>

<Warning>When paying via invoice for a booking, the booking will be automatically cancelled if payment is not received within the configured time window. For events, unpaid tickets are cancelled after 15 minutes. Customers are shown this deadline before confirming.</Warning>

<Note>When a customer selects this option during plan signup, their account may not be activated until payment is completed offline.</Note>

***

### Nothing to pay

When the transaction total is zero — for example, if a discount, credit, or promotion covers the full amount — customers see a confirmation step with no payment form.

<AccordionGroup>
  <Accordion title="When is nothing to pay shown?">
    **In plan signup checkout**, this option appears when **either** of the following is true:

    * The due amount on the invoice is zero or negative (fully covered by credits or discounts)
    * The proposal has already been paid previously

    **In booking/product/event checkout**, a simple "Complete order" or "Place booking" button is shown (without any payment gateway) when:

    * The order total is zero
    * The customer is logged in
  </Accordion>
</AccordionGroup>

***

### Pay via team

When a customer belongs to a team and their charges are billed to a paying team member, they see this option instead of the standard payment gateways. No payment is collected from the individual — the charges go to their team's account.

<AccordionGroup>
  <Accordion title="When is pay via team shown?">
    **In plan signup checkout**, pay via team appears when:

    * Billing is available for the location
    * The generated invoice is assigned to a different customer (the team's paying member) rather than to the individual checking out

    **In booking/product/event checkout**, when the invoice is assigned to a team's paying member:

    * All payment gateways are hidden
    * A simple "Complete order" or "Place booking" button is shown instead
    * The customer sees a message explaining that their team will pay for the order
  </Accordion>
</AccordionGroup>

***

## Hosted payment providers

In addition to the built-in gateways above, you can configure up to three custom hosted payment providers. These redirect customers to an external payment page and are displayed by their configured name.

<AccordionGroup>
  <Accordion title="When are hosted providers available?">
    **In plan signup checkout**, each hosted provider appears when:

    * Billing is available for the location
    * The provider is enabled in your location settings
    * There is an amount due (the total is greater than zero)
    * An invoice has been generated for the transaction (not just a preview)
    * The customer is paying for themselves (not via a team)

    **In booking/product/event checkout**, each hosted provider appears when:

    * The provider is enabled in your location settings
    * The order total is greater than zero
    * The customer is not paying via a team
  </Accordion>
</AccordionGroup>

***

## No payment methods available

If no payment gateways are configured and the transaction requires payment, customers see a warning message with options to contact the location or open a support ticket.

<Tip>Make sure at least one payment gateway is enabled in your Nexudus dashboard to allow customers to complete purchases online.</Tip>

## Summary

| Payment method         | Requires gateway config | Requires amount due | Requires issued invoice | Restricted by customer type | Available in signup | Available in booking/product/event |
| ---------------------- | ----------------------- | ------------------- | ----------------------- | --------------------------- | ------------------- | ---------------------------------- |
| Spreedly               | Yes                     | Yes                 | No                      | Yes (members/contacts)      | Yes                 | Yes                                |
| Stripe Checkout        | Yes                     | Yes                 | No                      | No                          | Yes                 | Yes                                |
| PayPal                 | Yes                     | Yes                 | No                      | No                          | Yes                 | Yes                                |
| GoCardless             | Yes                     | Yes                 | Yes                     | Yes (members/contacts)      | Yes                 | Yes (via invoice)                  |
| Forte                  | Yes                     | Yes                 | Yes (signup only)       | No                          | Yes (via invoice)   | Yes (via invoice)                  |
| Pay via invoice        | No                      | Yes                 | No (preview only)       | No                          | Yes                 | Yes                                |
| Nothing to pay         | No                      | No (zero amount)    | No                      | No                          | Yes                 | Yes                                |
| Pay via team           | No                      | N/A                 | No                      | No                          | Yes                 | Yes                                |
| Hosted providers (1–3) | Yes                     | Yes                 | Yes (signup only)       | No                          | Yes                 | Yes                                |


# Product Checkout
Source: https://learn.nexudus.com/member-portal/checkout/product-checkout

The checkout page for purchasing a single product.

The product checkout page handles the purchase of an individual product — whether it's a one-time purchase or a recurring add-on to a membership.

<Frame>
  <img alt="Product checkout page" />
</Frame>

## What members see

A two-column layout with product details on the left and a basket summary on the right.

### Product details

* **Product name, description, and image**
* **Price** displayed in the location's currency
* **Quantity selector** — adjust how many units to purchase
* **Purchase type** — choose between a one-time purchase or adding the product to a membership plan (if the product supports it)
* **Stock availability** — an out-of-stock indicator prevents purchase when inventory is depleted

### Payment & summary

* **Payment method selector** — choose how to pay
* **Basket summary** — shows the total cost including taxes

## Key features

* **Stock management** — the page respects inventory levels and prevents overselling.
* **Flexible purchase types** — supports both standalone purchases and plan-linked recurring products.
* **Analytics tracking** — checkout initiation is tracked for reporting.

## Configurable sections

| Setting             | Default | Effect                               |
| ------------------- | ------- | ------------------------------------ |
| Show basket summary | On      | Display the cost summary sidebar     |
| Show title          | On      | Show the "Your item" section heading |
| Show payment method | On      | Show payment method picker           |
| Show back button    | On      | Show back navigation                 |

<Tip>Products are created in the Nexudus dashboard under the Products module. Set stock levels there to control availability in the portal.</Tip>


# Store
Source: https://learn.nexudus.com/member-portal/checkout/store

The browsable product catalogue where members discover and select products.

# Store

The store page is a browsable catalogue of all products available for purchase — memberships, time passes, add-on services, and physical goods.

<Frame>
  <img alt="Store page" />
</Frame>

## What members see

Products are displayed in a responsive grid. Each product card shows:

* **Product image**
* **Product name and description**
* **Price** (in the location's currency)
* **Out-of-stock badge** when inventory is depleted

Clicking a product card navigates to the individual [Product Checkout](./product-checkout) page.

## Filtering

| Filter           | Description                                                       |
| ---------------- | ----------------------------------------------------------------- |
| **Product type** | Filter by category — memberships, passes, products, add-ons, etc. |
| **Location**     | Filter by business location (multi-site setups)                   |

The store URL supports type-based routing (`/store/all`, `/store/:type`) so you can link directly to a filtered view.

## Key features

* **AI-assisted recommendations** — an optional AI prompt suggests products based on the member's needs.
* **Authentication awareness** — unauthenticated visitors see login/signup prompts. Non-members see relevant guidance.
* **Dynamic pricing** — prices respect location billing settings and hide when billing is not enabled.
* **Responsive grid** — card sizes adapt to screen width with configurable minimum widths and gaps.

## Configurable sections

| Setting                | Default | Effect                                     |
| ---------------------- | ------- | ------------------------------------------ |
| Show filters           | On      | Display the filter bar                     |
| Show product types     | On      | Show the product type dropdown             |
| Show location selector | On      | Show the location filter                   |
| Show description       | On      | Show product descriptions on cards         |
| Show price             | On      | Show pricing on cards                      |
| Show image             | On      | Show product images                        |
| Grid gap               | 1.5rem  | Spacing between cards                      |
| Min card width         | 300px   | Minimum card width for the responsive grid |

***

## Recommended image sizes

Products use a single image that is requested at different sizes depending on context.

| Where it appears          | Requested size | Aspect ratio |
| ------------------------- | -------------- | ------------ |
| **Store listing cards**   | 600 × 540 px   | \~1.11 : 1   |
| **Product detail page**   | 600 × 540 px   | \~1.11 : 1   |
| **Checkout confirmation** | 600 × 540 px   | \~1.11 : 1   |
| **Basket thumbnail**      | 220 × 220 px   | 1 : 1        |

<Tip>
  For the best results, upload a product image of at least **600 × 540 px** (nearly square). This covers the largest requested size without cropping. Keep the subject centred so it looks good when cropped to square for basket thumbnails.
</Tip>


# Community Announcements
Source: https://learn.nexudus.com/member-portal/dashboard/community-announcements

Announcements from your space displayed on the member dashboard.

Community announcements let operators share news, updates, and promotions directly on the member dashboard. Each announcement appears as a card banner at the top of the personal dashboard.

<Frame>
  <img alt="Community Announcements banner" />
</Frame>

## What members see

Each announcement is displayed as a card with the following elements:

| Element       | Description                                                    |
| ------------- | -------------------------------------------------------------- |
| **Title**     | The announcement name                                          |
| **Body**      | A preview of the announcement text, truncated to two lines     |
| **Image**     | Optional image displayed on the right side of the card         |
| **View more** | Button to open the full announcement in a modal                |
| **Dismiss**   | Button to permanently hide the announcement from the dashboard |

When multiple announcements are active, they are displayed as separate cards stacked on the dashboard.

### Full announcement view

Clicking **View more** opens a modal with:

* The full announcement image
* The complete body text rendered with Markdown formatting
* An optional call-to-action button that opens an external link in a new tab

<Frame>
  <img alt="Community Announcements modal" />
</Frame>

## Dismissing announcements

Members can click **Dismiss** to permanently hide an announcement from their dashboard. Dismissed announcements do not reappear unless the member clears their browser data.

## Audience targeting

Operators can target announcements to specific audience segments:

| Audience          | Who sees it                          |
| ----------------- | ------------------------------------ |
| **All customers** | Both members and contacts            |
| **Members only**  | Customers with an active contract    |
| **Contacts only** | Customers without an active contract |

## Scheduling

Announcements support scheduled publishing. Operators can set a **Publish from** and **Publish until** date so announcements appear and disappear automatically.

## Configurable sections

| Setting            | Default | Effect                                            |
| ------------------ | ------- | ------------------------------------------------- |
| Show announcements | On      | Display the announcements banner on the dashboard |

<Tip>Announcements are created in the Nexudus dashboard under Community > Announcements. Use the scheduling options to time announcements for maximum visibility.</Tip>


# FAQ
Source: https://learn.nexudus.com/member-portal/dashboard/faq

The searchable FAQ knowledge base for members.

The FAQ page provides a searchable knowledge base of frequently asked questions for your members.

<Frame>
  <img alt="FAQ page" />
</Frame>

## What members see

A table of FAQ articles with the following columns:

| Column             | Description                          |
| ------------------ | ------------------------------------ |
| **Question title** | The FAQ question (truncated if long) |
| **Summary**        | A brief excerpt of the answer        |
| **Category**       | Colour-coded category badge          |
| **Read more**      | Button to open the full article      |

### Full article view

Clicking "Read more" opens a modal with the complete answer rendered from HTML, displayed at a comfortable reading size.

### Supported HTML formatting in FAQ articles

FAQ articles support rich HTML formatting. When creating or editing an FAQ article, you can use the following HTML elements and attributes:

#### Allowed HTML tags

Basic text formatting: `<p>`, `<br>`, `<strong>`, `<b>`, `<em>`, `<i>`, `<u>`, `<s>`, `<code>`, `<pre>`, `<h1>` – `<h6>`, `<blockquote>`, `<ul>`, `<ol>`, `<li>`, `<dl>`, `<dt>`, `<dd>`, `<table>`, `<thead>`, `<tbody>`, `<tfoot>`, `<tr>`, `<th>`, `<td>`, `<hr>`, `<div>`, `<span>`

Rich media: `<a>`, `<img>`, `<video>`, `<iframe>`

#### Allowed attributes

**Links** (`<a>`): `href`, `title`, `target`, `rel`

**Images** (`<img>`): `src`, `alt`, `title`, `width`, `height`, `style`

**Videos** (`<video>`): Standard HTML5 video attributes

**Embedded content** (`<iframe>`): `src`, `width`, `height`, `allow`, `frameborder`, `allowfullscreen`, `style` (YouTube videos are supported)

***

## Filtering & search

| Filter       | Description                                                              |
| ------------ | ------------------------------------------------------------------------ |
| **Search**   | Real-time search across question titles and summaries (case-insensitive) |
| **Category** | Dropdown to filter by FAQ category, with an "All" option                 |

## Key features

* **Direct linking** — append `?faq_id=123` to the URL to open a specific article automatically.
* **AI integration** — can trigger an AI chat assistant for answers not covered in the FAQ.
* **Empty state** — shows a "No results" message when no articles match the current filters.

## Configurable sections

| Setting         | Default | Effect                                   |
| --------------- | ------- | ---------------------------------------- |
| Show title      | On      | Display the section heading              |
| Show filter bar | On      | Show search and category filter controls |

<Tip>FAQ articles are created in the Nexudus dashboard. Organise them into categories to help members find answers faster.</Tip>


# Help Desk
Source: https://learn.nexudus.com/member-portal/dashboard/help-desk

The support ticket system where members submit and track help requests.

The Help Desk page provides a built-in support ticket system so members can request assistance and track the progress of their enquiries.

<Frame>
  <img alt="Help Desk page" />
</Frame>

## What members see

### Quick actions

| Button           | Description                                                      |
| ---------------- | ---------------------------------------------------------------- |
| **Help Me Find** | Opens an AI chat assistant for self-service answers (if enabled) |
| **Request Help** | Opens a form to submit a new support ticket                      |

### Ticket list

A table of submitted tickets with the following columns:

| Column      | Description                            |
| ----------- | -------------------------------------- |
| **Subject** | Ticket subject line (truncated)        |
| **Opened**  | Date and time the ticket was created   |
| **Status**  | Red badge = Open, Green badge = Closed |

Members can filter tickets by **Open** or **Closed** status.

### Ticket detail

Clicking **Manage** on a ticket opens a detail modal where members can:

* View the full conversation history
* Read staff responses
* Add comments and replies
* Close or reopen the ticket

<Frame>
  <img alt="Help Desk details" />
</Frame>

### Creating a ticket

The "Request Help" button opens a modal form. Support for deep linking is built in — append `?action=create&subject=X&message=Y` to the URL to pre-populate the form (useful for contextual help links).

## Key features

* **AI-powered self-service** — the "Help Me Find" button uses AI to answer common questions before creating a ticket.
* **Threaded conversations** — staff and members can exchange messages within each ticket.
* **Deep-link support** — pre-fill ticket subject and message from URL parameters.
* **Analytics** — AI chat usage is tracked for reporting.

## Module requirements

| Requirement          | Effect                                                        |
| -------------------- | ------------------------------------------------------------- |
| Help desk enabled    | The entire page is gated by the help desk module being active |
| New messages enabled | Controls whether members can create new tickets               |

## Configurable sections

| Setting                  | Default | Effect                                                                  |
| ------------------------ | ------- | ----------------------------------------------------------------------- |
| Show title               | On      | Display the section heading                                             |
| Show filter bar          | On      | Show the status filter                                                  |
| Show Help Me Find button | On      | Display the AI assistant button (also requires feature flag)            |
| Show Request Help button | On      | Display the new ticket button (also requires help desk module settings) |

<Tip>Combine the Help Desk with the FAQ page to deflect common questions — members can search the FAQ before submitting a ticket.</Tip>


# My Bookings
Source: https://learn.nexudus.com/member-portal/dashboard/my-bookings

Where members view and manage their past and upcoming resource bookings.

The bookings page shows all of a member's resource reservations — upcoming and past — with status tracking and quick actions.

<Frame>
  <img alt="My Bookings page" />
</Frame>

## What members see

A list of bookings grouped by date. Each row shows:

| Column               | Description                                                            |
| -------------------- | ---------------------------------------------------------------------- |
| **Resource name**    | The booked resource (room, desk, etc.)                                 |
| **Resource image**   | A thumbnail of the resource (optional)                                 |
| **Desk / location**  | Specific desk or area within the resource                              |
| **Business name**    | The location where the resource belongs                                |
| **Start & end time** | Booking date and time range in human-readable format                   |
| **Price**            | Booking cost (shown for individual bookings, hidden for team bookings) |
| **Status**           | Colour-coded badge                                                     |

### Status badges

| Status                | Colour | Meaning                      |
| --------------------- | ------ | ---------------------------- |
| Confirmed             | Green  | Booking is confirmed         |
| Cancelled             | Red    | Booking was cancelled        |
| Awaiting confirmation | Yellow | Tentative — pending approval |
| Awaiting payment      | Red    | Payment required to confirm  |

## Actions

| Action             | Description                                                                                      |
| ------------------ | ------------------------------------------------------------------------------------------------ |
| **Modify booking** | Opens the booking edit page to change dates, desks, or details. Disabled for cancelled bookings. |
| **Make a Booking** | Quick-action button to start a new booking                                                       |

## Configurable sections

| Setting                      | Default | Effect                                |
| ---------------------------- | ------- | ------------------------------------- |
| Show title                   | On      | Display the section heading           |
| Show filter bar              | On      | Show the filter controls              |
| Show team bookings           | Off     | Include bookings made by team members |
| Show modify button           | On      | Show the edit booking link            |
| Show resource image          | On      | Display resource thumbnails           |
| Show booking settings button | On      | Show management options               |
| Show Make a Booking button   | On      | Display the quick book action         |


# My Courses
Source: https://learn.nexudus.com/member-portal/dashboard/my-courses

Where members track their enrolled courses and completion progress.

The courses activity page lists all courses a member is enrolled in and tracks their progress.

<Frame>
  <img alt="My Courses page" />
</Frame>

## What members see

A list of enrolled courses grouped by enrolment date. Each row shows:

| Column             | Description                                    |
| ------------------ | ---------------------------------------------- |
| **Course title**   | Name of the course                             |
| **Course image**   | Thumbnail (optional)                           |
| **Provider**       | The business or instructor offering the course |
| **Progress badge** | Colour-coded completion percentage             |

### Progress badges

| Colour         | Meaning     |
| -------------- | ----------- |
| Red (0%)       | Not started |
| Yellow (1–99%) | In progress |
| Green (100%)   | Completed   |

## Actions

| Action              | Description                                         |
| ------------------- | --------------------------------------------------- |
| **Go to Course**    | Opens the course content for the member to continue |
| **See All Courses** | Link to the course catalogue                        |

## Configurable sections

| Setting                     | Default | Effect                         |
| --------------------------- | ------- | ------------------------------ |
| Show title                  | On      | Display the section heading    |
| Show course image           | On      | Display course thumbnails      |
| Show progress badge         | On      | Show the completion percentage |
| Show See All Courses button | On      | Link to the course catalogue   |


# My Deliveries
Source: https://learn.nexudus.com/member-portal/dashboard/my-deliveries

Where members track package deliveries and manage pickups.

The deliveries page lets members track packages that have been received at the space and manage their pickup.

<Frame>
  <img alt="My Deliveries page" />
</Frame>

## What members see

A list of deliveries grouped by reception date. Each row shows:

| Column                   | Description                            |
| ------------------------ | -------------------------------------- |
| **Recipient name**       | The member the package is addressed to |
| **Package name**         | Description of the delivery            |
| **Storage location**     | Where the package is being held        |
| **Received date & time** | When the package arrived               |
| **Status**               | Colour-coded badge                     |

### Status badges

| Status    | Meaning                                               |
| --------- | ----------------------------------------------------- |
| Pending   | Waiting for the member to collect                     |
| Collected | Member has picked up the package                      |
| Expired   | Package was not collected within the retention period |

Members can filter between **Pending** and **Completed** deliveries.

## Actions

| Action     | Description                                                                                                |
| ---------- | ---------------------------------------------------------------------------------------------------------- |
| **Manage** | Opens a detail modal where the member can view full delivery information and mark the package as collected |

<Frame>
  <img alt="Manage my Deliveries" />
</Frame>

## Configurable sections

| Setting            | Default | Effect                            |
| ------------------ | ------- | --------------------------------- |
| Show title         | On      | Display the section heading       |
| Show filter bar    | On      | Show the status filter            |
| Show manage button | On      | Show the delivery management link |

<Tip>Deliveries are logged by your staff from the Nexudus dashboard. Members are then notified and can track pickup from this page.</Tip>


# My Events
Source: https://learn.nexudus.com/member-portal/dashboard/my-events

Where members manage their event registrations and tickets.

The events activity page shows all events a member has registered for, with ticket management actions.

<Frame>
  <img alt="My Events page" />
</Frame>

## What members see

A list of event tickets grouped by date. Each row shows:

| Column                | Description                                  |
| --------------------- | -------------------------------------------- |
| **Event name**        | Linked to the full event details page        |
| **Event image**       | A thumbnail of the event (optional)          |
| **Registered email**  | The email address associated with the ticket |
| **Start date & time** | When the event takes place                   |
| **Status**            | Confirmed badge (green)                      |

Members can toggle between **Upcoming** and **Past** events using the filter dropdown.

## Actions

| Action             | Description                                                                                                        |
| ------------------ | ------------------------------------------------------------------------------------------------------------------ |
| **Send Tickets**   | Emails the ticket to the registered email address. A confirmation dialog shows the recipient email before sending. |
| **Cancel Tickets** | Cancels the event registration. A warning dialog shows the event name and attendee name before confirming.         |
| **See All Events** | Link to the main events catalogue                                                                                  |

## Configurable sections

| Setting                    | Default | Effect                               |
| -------------------------- | ------- | ------------------------------------ |
| Show title                 | On      | Display the section heading          |
| Show filter bar            | On      | Show the time filter (upcoming/past) |
| Show event card            | On      | Display event images                 |
| Show ticket action buttons | On      | Enable send/cancel ticket actions    |
| Show See All Events button | On      | Link to the events catalogue         |


# My Invoices
Source: https://learn.nexudus.com/member-portal/dashboard/my-invoices

Where members view, filter, download, and pay their invoices.

The invoices page gives members a complete view of their billing history — invoices, credit notes, payment status, and quick actions.

<Frame>
  <img alt="My Invoices page" />
</Frame>

## What members see

A paginated table of all invoices and credit notes grouped by date, with the following columns:

| Column             | Description                              |
| ------------------ | ---------------------------------------- |
| **Invoice number** | The unique invoice identifier            |
| **Date**           | When the invoice was issued              |
| **Total**          | The invoice amount in localised currency |
| **Status**         | Visual badge showing the current state   |

### Status badges

Invoices display colour-coded status badges:

| Status             | Meaning                         |
| ------------------ | ------------------------------- |
| Paid               | Fully paid                      |
| Unpaid             | Payment outstanding             |
| Due                | Payment is due                  |
| Draft              | Invoice not yet finalised       |
| Void               | Invoice cancelled               |
| Sent / Not sent    | Whether the invoice was emailed |
| Processing         | Payment is being processed      |
| Partially paid     | Some payment received           |
| Partially refunded | Partial refund issued           |
| Refunded           | Fully refunded                  |
| Cancelled          | Invoice cancelled               |
| Credited           | Offset by a credit note         |

## Filtering

| Filter             | Description                        |
| ------------------ | ---------------------------------- |
| **Payment status** | Filter by Paid or Unpaid           |
| **Document type**  | Filter by Invoices or Credit Notes |

## Actions

| Action                   | Description                                                          | Requires                  |
| ------------------------ | -------------------------------------------------------------------- | ------------------------- |
| **Download PDF**         | Download the invoice as a PDF file                                   | Billing print permission  |
| **Pay Invoice**          | Navigate to the payment checkout for an unpaid invoice               | Billing access permission |
| **Download statement**   | Download a PDF statement summarising all invoices                    | Billing print permission  |
| **Preview next invoice** | Preview the upcoming invoice as a PDF before it is officially issued | Billing print permission  |

The **Download statement** and **Preview next invoice** links appear below the invoices table when the billing print permission is enabled.

## Configurable sections

| Setting              | Default | Effect                                 |
| -------------------- | ------- | -------------------------------------- |
| Show title           | On      | Display the section heading            |
| Show download button | On      | Enable PDF downloads                   |
| Show filter bar      | On      | Show the filter dropdowns              |
| Show pay button      | On      | Show payment links for unpaid invoices |

<Tip>Members can only see invoices for their own account. Team managers may see team-level invoices depending on their permissions.</Tip>


# My Plans
Source: https://learn.nexudus.com/member-portal/dashboard/my-plans

Where members view their active plans, benefits, booking credits, and purchased products.

The plans page gives members a complete view of their membership, including plan details, benefits, credits, and purchased products.

<Frame>
  <img alt="My Plans page" />
</Frame>

## What members see

The page is divided into several sections:

### My Plans

Lists the member's active membership plans with details and features. If plan signup is enabled, a **Join a Plan** button lets members browse and upgrade.

### My Benefits (Personal)

Displays benefits tied directly to the member's own plan:

| Benefit type        | Description                                                      |
| ------------------- | ---------------------------------------------------------------- |
| **Booking credits** | Available credit balance and usage history for resource bookings |
| **Time passes**     | Active time-based passes for coworking access                    |
| **Extra services**  | Add-on services included with the plan                           |

This section only appears if the member has personal benefits.

### Team Benefits

If the member belongs to a team with shared benefits, a separate section shows team-level entitlements with the same structure as personal benefits (booking credits, time passes, extra services).

### My Products

Lists any products the member has purchased, including details and expiration dates.

## Configurable sections

| Setting                     | Default | Effect                                     |
| --------------------------- | ------- | ------------------------------------------ |
| Show title                  | On      | Display section headings                   |
| Show Join Plan button       | On      | Allow members to browse and join new plans |
| Show plans section          | On      | Display active plans                       |
| Show benefits section       | On      | Display benefits overview                  |
| Show products section       | On      | Display purchased products                 |
| Show booking credit section | On      | Display booking credits subsection         |
| Show booking time section   | On      | Display time passes subsection             |
| Show passes section         | On      | Display passes subsection                  |

<Tip>
  Members use this page to understand exactly what their plan includes. Make sure your plans are configured with clear descriptions and benefit
  allocations in the dashboard.
</Tip>


# My Visitors
Source: https://learn.nexudus.com/member-portal/dashboard/my-visitors

Where members register, manage, and track visitors coming to the space.

The visitors page lets members register guests who will be visiting the coworking space and manage existing visitor registrations.

<Frame>
  <img alt="My Visitors page" />
</Frame>

## What members see

A list of registered visitors grouped by expected arrival date. Each row shows:

| Column                  | Description                                                      |
| ----------------------- | ---------------------------------------------------------------- |
| **Full name**           | Visitor's name                                                   |
| **Email**               | Clickable mailto link                                            |
| **Phone**               | Clickable tel link                                               |
| **Business / location** | The location the visitor is expected at                          |
| **Expected arrival**    | Scheduled date and time (or "Not specified")                     |
| **Notes**               | Any custom notes about the visit, displayed with a visual accent |

Members can toggle between **Upcoming** and **Past** visitors.

## Actions

| Action                   | Description                                                                                                |
| ------------------------ | ---------------------------------------------------------------------------------------------------------- |
| **Register New Visitor** | Opens a modal form to add a new visitor with name, email, phone, expected arrival, and notes               |
| **Delete Visitor**       | Removes a visitor registration. Blocked if the visitor has already arrived or the arrival date has passed. |
| **Reinvite Visitor**     | Resends the visitor notification                                                                           |

### Deep linking

Appending `?action=create` to the URL automatically opens the visitor registration form — useful for linking from other pages or emails.

## Configurable sections

| Setting                      | Default | Effect                               |
| ---------------------------- | ------- | ------------------------------------ |
| Show title                   | On      | Display the section heading          |
| Show Register Visitor button | On      | Show the add visitor action          |
| Show filter bar              | On      | Show the time filter (upcoming/past) |
| Show delete button           | On      | Enable visitor deletion              |
| Show reinvite button         | On      | Enable resending invitations         |

<Tip>Visitor registration can integrate with access control systems so your front desk or smart locks know to expect the guest.</Tip>


# Personal Dashboard
Source: https://learn.nexudus.com/member-portal/dashboard/personal-dashboard

The member's personalised home screen with bookings, announcements, and quick actions.

The personal dashboard is the first page members see after signing in. It provides a personalised summary of their activity and quick access to common actions.

<Frame>
  <img alt="Personal Dashboard" />
</Frame>

## What members see

The dashboard is assembled from configurable sections:

| Section                 | Description                                                                                                                         |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **Header**              | Personalised greeting using the member's first name, plus a "Make a Booking" quick-action button                                    |
| **Announcements**       | A banner displaying location-specific announcements you have posted                                                                 |
| **Onboarding**          | Guided steps for new members to complete their profile and explore the portal                                                       |
| **My Benefits**         | A summary card showing the member's available booking credits, extra services, and time passes                                      |
| **Upcoming activity**   | A visual calendar showing the member's bookings, visitors, and events for the current week, with an option to include team bookings |
| **Upcoming bookings**   | Cards summarising the member's next resource bookings with key details                                                              |
| **Predictive bookings** | AI-suggested booking slots based on the member's usage patterns                                                                     |
| **Featured articles**   | Latest articles from your location                                                                                                  |
| **Featured events**     | Upcoming events displayed as a card gallery                                                                                         |

## Key features

* **Personalised greeting** — addresses the member by first name.
* **Quick booking** — the header button sends members straight to the booking flow.
* **Announcement visibility** — post location news and it appears automatically on every member's dashboard.
* **Onboarding guidance** — helps new members complete setup steps (can be dismissed once done).
* **My Benefits summary** — displays the member's available booking credits, extra services, and time passes at a glance, combining both personal and team benefits.
* **Predictive bookings** — AI analyses past behaviour to suggest likely booking times.
* **Team bookings** — members can toggle to include team bookings in their upcoming activity calendar, with booking owner names visible.
* **Quick actions** — when no activity is scheduled, members see quick-action buttons to book a room, book a desk, register a visitor, or view events.

## Configurable sections

All sections can be toggled on or off from the **Page Editor**:

| Setting                  | Effect                                                |
| ------------------------ | ----------------------------------------------------- |
| Show announcements       | Display the announcements banner                      |
| Show onboarding          | Display the guided onboarding section                 |
| Show my benefits         | Display the member's benefits summary card            |
| Show weekly calendar     | Display the upcoming activity calendar                |
| Show team bookings       | Allow members to toggle team bookings in the calendar |
| Show team member details | Display booking owner names on team bookings          |
| Show upcoming bookings   | Display upcoming booking summary cards                |
| Show suggested bookings  | Display AI-suggested booking suggestions              |
| Show featured articles   | Display latest articles                               |
| Show featured events     | Display upcoming event cards                          |

<Tip>
  Use announcements to broadcast important news — maintenance schedules, new amenities, or community events. Every member sees them on their
  dashboard.
</Tip>


# Communicating with Customers
Source: https://learn.nexudus.com/member-portal/migration/communication

A suggested timeline and guidance for communicating the Members Portal version 5 migration to your customers.

# Communicating with Customers

When you migrate to version 5 of the Members Portal, your customers should not be surprised. A clear communication plan builds confidence and reduces support requests. This page provides a suggested timeline and guidance you can adapt to your space.

## General guidance

Strike a balance between sharing enough information and giving your customers a chance to explore. Most people will skim at least one message, so use a staggered approach over a couple of weeks rather than a single announcement.

Lead with **why** you are relaunching, followed by **what will change** for them.

## Assess what to communicate

Before drafting any message, walk through the new portal yourself and note:

* Is your branding changing, and if so, how visibly?
* Are any features new to your customers (guest checkout, team management, dynamic pricing)?
* Have existing flows changed — for example, how customers find and book resources, or where they access invoices?
* Has the login process changed, or will customers need to reset passwords?

<Info>
  Customer credentials (email and password) do not change when migrating to version 5. Customers sign in with the same account.
</Info>

Once you have these answers, tailor your communications to what actually affects your customers rather than sending a generic announcement.

## Suggested timeline

### Two weeks before — Heads-up announcement

Use an [announcement](https://help.nexudus.com/v3/docs/announcements) in the current portal to let customers know a change is coming.

**What to include:**

* A clear title communicating that the portal is being updated
* A short summary of what customers will gain (easier bookings, a smarter dashboard, a more modern experience)
* The go-live date
* A help desk link or point of contact for questions

Keep it positive and high-level. The goal is to avoid surprise, not to explain everything up front.

### One week before — Detailed reminder

Send a [reminder](https://help.nexudus.com/v3/docs/reminders) with more specific information about the change.

**What to include:**

* Any URL or login changes (typically none — credentials stay the same)
* A summary of the key areas: dashboard, bookings, invoices, team management
* Screenshots or a short video walkthrough of the new portal
* Any action customers need to take before or after go-live

### Go-live day — Confirmation announcement

Post another [announcement](https://help.nexudus.com/v3/docs/announcements) confirming the new portal is live.

**What to include:**

* Confirmation that the new portal is live and ready
* One or two key areas to explore first
* A help desk link or email address for anything that is not working as expected

### One week after — Follow-up and feedback

Check in using a [survey](https://help.nexudus.com/v3/docs/surveys) to gather feedback and surface any issues early.

**What to include:**

* A thank-you for trying the new portal
* A short feedback form (3–5 questions maximum)
* A reminder of the help desk link for any unresolved issues

## What to highlight for your customers

Rather than listing every page, focus on the areas that directly affect what customers do day to day:

### Personal dashboard

After signing in, customers land on a personal dashboard with upcoming bookings, announcements, and quick actions. Let them know this is their home base.

### Booking resources

The resource list is how customers find and reserve meeting rooms, desks, and other spaces. If the layout or filtering has changed, call this out specifically — it is one of the most-used parts of the portal. Cover:

* How to search and filter resources
* Whether pricing is displayed differently (dynamic pricing, if enabled)
* How to manage, modify, or cancel existing bookings

### Account and billing

Customers manage personal information, billing details, and security settings under their profile. If anything has changed — particularly payment methods or invoice history — communicate it clearly. Cover:

* Where to find invoices
* Where to update billing details
* Where to change passwords or security settings

### Team management

Customers who manage teams have access to a dedicated team section covering team bookings, attendance, member lists, and permissions. Cover:

* Where to find the team section after signing in
* How to view bookings made by any team member
* How to manage team member permissions

## Next steps

<CardGroup>
  <Card title="Step-by-step migration" icon="list-check" href="/member-portal/migration/steps">
    Technical instructions for previewing, switching, and configuring DNS.
  </Card>

  <Card title="Rollback and troubleshooting" icon="rotate-left" href="/member-portal/migration/rollback">
    How to revert to the previous version and resolve common issues.
  </Card>
</CardGroup>


# Migrating to Portal Version 5
Source: https://learn.nexudus.com/member-portal/migration/overview

Everything you need to know before migrating your Members Portal from version 4 (or earlier) to version 5.

# Migrating to Portal Version 5

Version 5 of the Members Portal is a complete redesign of the member-facing experience. It introduces a modern interface, a drag-and-drop page editor, improved performance, and new features such as guest checkout, dynamic pricing, and team management.

This guide walks you through the entire migration process — from previewing the new portal, to going live, to rolling back if needed.

## Who should read this

This guide is for **coworking-space operators** currently running version 4 or earlier of the Members Portal who want to upgrade to version 5.

## What changes for your customers

Most of the underlying data — bookings, invoices, plans, events — remains exactly the same. What changes is **how customers interact with that data**:

| Area                    | What changes                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------- |
| **Look and feel**       | Fully redesigned interface with a modern, responsive layout                           |
| **Navigation**          | Reorganised menu structure with clearer categories                                    |
| **Dashboard**           | New personal dashboard with upcoming bookings, announcements, and quick actions       |
| **Bookings**            | Improved resource search with filters, map views, and dynamic pricing                 |
| **Team management**     | Dedicated section for team bookings, attendance, members, and permissions             |
| **Profile and billing** | Streamlined account pages for personal info, invoices, and payment methods            |
| **Page editor**         | New [drag-and-drop editor](/editor/overview) for customising every page without code  |
| **Custom code**         | `app.js`, `styles.css`, and `head.js` [continue to work](/editor/custom-web-injector) |

<Info>
  Customer credentials (email and password) do not change. Members sign in with the same account they use today.
</Info>

## Migration at a glance

<Steps>
  <Step title="Preview the new portal">
    See exactly what your customers will experience before making any changes.
  </Step>

  <Step title="Customise the portal">
    Use the page editor and custom code injection to match your branding and layout preferences.
  </Step>

  <Step title="Communicate with your customers">
    Send a series of announcements so members know what to expect and when.
  </Step>

  <Step title="Go live">
    Switch to version 5 from your dashboard. The change takes effect immediately.
  </Step>

  <Step title="Monitor and follow up">
    Check in with members after launch and use the rollback option if needed.
  </Step>
</Steps>

## Next steps

<CardGroup>
  <Card title="Step-by-step migration" icon="list-check" href="/member-portal/migration/steps">
    Detailed technical instructions for previewing, switching, and configuring DNS.
  </Card>

  <Card title="Communicating with customers" icon="bullhorn" href="/member-portal/migration/communication">
    A suggested timeline and templates for keeping your members informed.
  </Card>

  <Card title="Rollback and troubleshooting" icon="rotate-left" href="/member-portal/migration/rollback">
    How to revert to the previous version and resolve common issues.
  </Card>
</CardGroup>


# Rollback and Troubleshooting
Source: https://learn.nexudus.com/member-portal/migration/rollback

How to revert to the previous portal version and resolve common issues during migration.

# Rollback and Troubleshooting

If you encounter issues after migrating to version 5 of the Members Portal, you can revert to your previous version at any time. This page explains how to roll back and addresses common migration issues.

## Rolling back to the previous version

To roll back to version 4, contact **[support@nexudus.com](mailto:support@nexudus.com)**. The support team will revert your portal and confirm once the change is active.

If you updated your DNS records as part of the migration, you will also need to revert them to point back to `spaces.nexudus.com` once the rollback is confirmed. This ensures your custom domain continues to resolve correctly with the previous version.

<Info>
  Rolling back does not affect your data. Bookings, invoices, customer accounts, and all other data remain intact regardless of which portal version is active.
</Info>

## Common issues

### Custom CSS or JavaScript is not applied

Custom files (`app.js`, `styles.css`, `head.js`) must be opened and saved at least once in the Web Template Editor before they take effect in version 5.

**Solution:** Go to **[Settings > Website > Web Template Editor > Built-in Files](https://dashboard.nexudus.com/settings/editor/templates)**, open each file, and click **Save**. See [Custom Code and Fonts](/editor/custom-web-injector) for details.

### CSS overrides from version 4 look wrong

Version 5 uses different class names and a new layout structure. CSS selectors targeting version 4 elements may no longer match.

**Solution:** Review your `styles.css` file and update selectors to match the new portal markup. Use your browser's developer tools to inspect the current elements.

### Old links or bookmarks no longer work

Old links that were distributed before the migration — in emails, bookmarks, or documents — are automatically redirected to the corresponding page on the new portal. If you are not using a custom domain, the old address (ending in `.spaces.nexudus.com`) also redirects automatically to the new one (ending in `.nexudus.site`).

**Solution:** Redirects are handled automatically. If a specific link is not redirecting, clear your browser cache and try again. If the issue persists, contact support.

### Email notification links point to the old portal

While previewing the portal (before going live), email notifications continue to link to the current active version. After you go live, notification links update automatically.

**Solution:** If links still point to the old portal after going live, clear your browser cache and wait a few minutes for the change to propagate.

### Custom domain shows a certificate warning

After updating DNS records, SSL certificates need time to be issued and propagated.

**Solution:** Verify that your DNS records match exactly what is shown in **[Settings > Website > Domain](https://dashboard.nexudus.com/settings/2/0/0)**. Certificate generation typically completes within a few minutes once DNS records are verified, but DNS propagation itself can take up to 48 hours.

### Customers cannot sign in

Customer credentials do not change during migration. If a customer reports sign-in issues, the cause is usually a cached version of the portal.

**Solution:** Ask the customer to clear their browser cache, or try signing in using an incognito/private window.

### Portal is slow to load after migration

The first load after migration may be slightly slower as the browser caches new assets.

**Solution:** This is temporary and resolves after the initial load. If performance issues persist, check your custom JavaScript (`app.js`) for heavy operations that may conflict with the new portal.


# Step-by-step Migration
Source: https://learn.nexudus.com/member-portal/migration/steps

Technical instructions for previewing, switching to, and configuring your Members Portal version 5.

# Step-by-step Migration

This page covers every technical step involved in moving from version 4 (or earlier) to version 5 of the Members Portal.

## Step 1 — Preview the new portal

Before making any changes, you can preview exactly what your customers will see on version 5.

<Steps>
  <Step title="Find your portal domain">
    Open **[Settings > Website > Domain](https://dashboard.nexudus.com/settings/2/0/0)** in your Nexudus dashboard. Note the value in the **Domain** field — for example, `kalkio`.
  </Step>

  <Step title="Open the preview URL">
    Append `.nexudus.site` to your domain value and open it in your browser. For example, if your domain is `kalkio`, open:

    ```
    https://kalkio.nexudus.site
    ```

    This is a live preview of your portal running on version 5 with your current data and configuration.
  </Step>

  <Step title="Walk through the portal">
    Sign in with your own credentials and explore the key areas:

    * **Dashboard** — check that announcements, bookings, and quick actions display correctly
    * **Resources** — verify that rooms, desks, and other resources appear with the right names, images, and pricing
    * **Events and courses** — confirm that upcoming events display correctly
    * **Profile and billing** — review that invoices, payment methods, and personal details are accurate
    * **Team management** — if you use teams, verify the team section
  </Step>
</Steps>

<Warning>
  While previewing the portal, links from email notifications (booking confirmations, invoice reminders, etc.) will continue to point to your current portal, not the preview. This is expected and will update automatically after you go live.
</Warning>

## Step 2 — Customise the portal

Before going live, take the opportunity to adjust the portal to match your branding and preferences.

### Page editor

The new [drag-and-drop page editor](/editor/overview) lets you customise every page visually — rearrange sections, add components, show or hide content for different audiences, and create entirely new pages.

Access it at `https://your-portal-url/admin/editor` while signed in as an operator.

### Custom code

If you use custom CSS, JavaScript, or head elements in your current portal, these continue to work in version 5 through the [Web Template Editor](/editor/custom-web-injector).

<Warning>
  Each custom file (`app.js`, `styles.css`, `head.js`) must be **opened and saved at least once** in the Web Template Editor before it becomes active in the new portal. Go to **[Settings > Website > Web Template Editor > Built-in Files](https://dashboard.nexudus.com/settings/editor/templates)**, open each file, and click **Save**.
</Warning>

<Tip>
  If your current `styles.css` includes overrides for version 4 elements, review and update them. Version 5 uses different class names and a new layout structure.
</Tip>

## Step 3 — Update DNS (custom domains only)

If you use a **custom domain** for your portal (e.g., `members.yourcompany.com`), you need to update your DNS records and issue new SSL certificates after migrating.

<Steps>
  <Step title="Open domain settings">
    Go to **[Settings > Website > Appearance](https://dashboard.nexudus.com/settings/2/0/0)** and locate the DNS configuration section.
  </Step>

  <Step title="Remove old DNS records">
    In your DNS provider, remove any **A** or **CNAME** records that currently point to `spaces.nexudus.com`.
  </Step>

  <Step title="Add new DNS records">
    Add the new DNS records displayed in the domain settings page. These typically include:

    | Record type | Name / Host                      | Value                                |
    | ----------- | -------------------------------- | ------------------------------------ |
    | **CNAME**   | Your subdomain (e.g., `members`) | Value provided in the dashboard      |
    | **A**       | `@` or your apex domain          | IP address provided in the dashboard |
  </Step>

  <Step title="Issue new SSL certificates">
    Follow the instructions on the domain settings page to issue new SSL certificates for your custom domain. The system handles certificate generation automatically once your DNS records are verified.
  </Step>

  <Step title="Verify">
    After DNS propagation (which can take up to 48 hours), visit your custom domain to confirm the portal loads correctly over HTTPS.
  </Step>
</Steps>

<Warning>
  DNS changes can take time to propagate. During this period, some customers may temporarily see a certificate warning or be unable to reach the portal via the custom domain. Consider scheduling the DNS change during a low-traffic window.
</Warning>

## Step 4 — Go live

When you are ready to switch:

<Steps>
  <Step title="Open the portal settings">
    Navigate to **[Settings > Website > Domain](https://dashboard.nexudus.com/settings/2/0/0)** in your Nexudus dashboard.
  </Step>

  <Step title="Switch to version 5">
    Use the migration option on this page to activate version 5 for your portal. The switch takes effect immediately — all customers accessing your portal will see the new version.
  </Step>
</Steps>

<Info>
  You can roll back to the previous version at any time from the same settings page. See [Rollback and troubleshooting](/member-portal/migration/rollback) for details.
</Info>

### What happens to old links and URLs

After going live:

* **Old links are redirected automatically.** Any links previously distributed to customers — in emails, bookmarks, documents, or notifications — that pointed to the old portal will automatically redirect to the corresponding page on the new version. No action is required from you or your customers.
* **Old default domain redirects to the new one.** If you are not using a custom domain, anyone accessing the old address (ending in `.spaces.nexudus.com`) will be automatically redirected to the new one (ending in `.nexudus.site`).

## Step 5 — Verify everything

After going live, run through this checklist:

* [ ] Portal loads correctly at your primary URL
* [ ] Customers can sign in with existing credentials
* [ ] Dashboard displays upcoming bookings and announcements
* [ ] Resource booking flow works end to end
* [ ] Invoices and payment history are visible
* [ ] Custom CSS and JavaScript are applied
* [ ] Email notification links point to the new portal
* [ ] Custom domain resolves correctly (if applicable)

## Next steps

<CardGroup>
  <Card title="Communicating with customers" icon="bullhorn" href="/member-portal/migration/communication">
    Suggested timeline and guidance for keeping members informed.
  </Card>

  <Card title="Rollback and troubleshooting" icon="rotate-left" href="/member-portal/migration/rollback">
    How to revert to the previous version and resolve common issues.
  </Card>
</CardGroup>


# Member Portal Overview
Source: https://learn.nexudus.com/member-portal/overview

A guide to all the sections and pages your members see in the Nexudus Members Portal.

# Member Portal Overview

The Members Portal is the member-facing web application that comes with every Nexudus location. It is the primary touchpoint between your coworking space and the people who use it — prospective visitors browsing your site, members managing bookings, and teams coordinating resources.

<Frame>
  <img alt="Members Portal overview" />
</Frame>

This documentation walks through **every page and section** of the portal so you know exactly what your members experience, what each page does, and how your Nexudus dashboard settings control the behaviour.

## Portal sections at a glance

| Section                       | What it covers                                                                                       |
| ----------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Public / Landing**          | Home page, events, courses, articles, contact, community board, directory, perks                     |
| **Checkout / Purchase**       | Booking, product, event, and course checkout flows                                                   |
| **User Dashboard & Activity** | Personal dashboard, invoices, bookings, events, courses, visitors, deliveries, plans, FAQ, help desk |
| **User Profile & Settings**   | Personal info, billing, professional profile, integrations, security, account settings               |
| **Team Management**           | Team bookings, attendance, members, and permissions                                                  |
| **Virtual Office**            | Multi-step virtual office onboarding                                                                 |
| **Authentication**            | Sign in, forgot password, password reset                                                             |

<Tip>
  Every portal page is fully customisable from the Nexudus dashboard using the Page Editor. You can show, hide, and reorder sections without writing
  any code.
</Tip>

## How configuration flows to the portal

Settings you configure in the Nexudus admin dashboard — products, resources, events, branding, permissions — automatically appear in the portal. There is no manual syncing. When you update a resource name or add a new event, members see the change immediately.

## Portal configuration

<CardGroup>
  <Card title="Custom Domain Setup" icon="globe" href="/operators/portal-configuration/custom-domain-setup">
    Use your own domain name for the Members Portal instead of the default Nexudus subdomain.
  </Card>

  <Card title="Widget Embedding" icon="code" href="/operators/portal-configuration/widget-embedding">
    Embed the Members Portal directly into your existing marketing website.
  </Card>
</CardGroup>

## Next steps

Pick a section from the sidebar to learn what each page does and how to make the most of it.


# Account Settings
Source: https://learn.nexudus.com/member-portal/profile/account-settings

The central settings hub for bookings, notifications, language, integrations, and security.

The account settings page is a tabbed interface that gives members access to several configuration areas from a single location.

<Frame>
  <img alt="Account Settings page" />
</Frame>

## Settings tabs

The URL parameter `:section` determines which tab is active. Each tab loads a dedicated settings page:

| Tab               | URL                                    | Description                                                                  |
| ----------------- | -------------------------------------- | ---------------------------------------------------------------------------- |
| **Bookings**      | `/user/profile/settings/bookings`      | Configure booking preferences and prediction settings                        |
| **Notifications** | `/user/profile/settings/notifications` | Manage email notifications and digest preferences                            |
| **Language**      | `/user/profile/settings/language`      | Choose the preferred language for the portal                                 |
| **Integrations**  | `/user/profile/settings/integrations`  | Calendar sync and feed management (same as the standalone Integrations page) |
| **Security**      | `/user/profile/settings/security`      | Password and PIN management (same as the standalone Credentials page)        |

## Key features

* **Tab-based navigation** — members switch between settings areas without page reloads.
* **Deep linking** — each tab has a unique URL, so you can link members directly to a specific settings section.
* **Shared components** — the Integrations and Security tabs render the same components as their standalone pages, ensuring consistency.

<Tip>
  You can link members to a specific settings tab from onboarding emails, e.g. `/user/profile/settings/notifications` to set up their notification
  preferences.
</Tip>


# Billing Information
Source: https://learn.nexudus.com/member-portal/profile/billing-information

Where members manage their billing details and electronic invoicing setup.

The billing information page lets members update their invoicing details and manage electronic invoicing identifiers.

<Frame>
  <img alt="Billing Information page" />
</Frame>

## What members see

The page is split into two sections:

### Billing Details

| Field            | Description                             |
| ---------------- | --------------------------------------- |
| **Billing name** | Name that appears on invoices           |
| **Tax ID**       | Tax identification number for invoicing |

Members can edit and save these details independently.

### E-Invoicing (conditional)

This section only appears if **Storecove** (electronic invoicing) is enabled for your location. It lets members manage their e-invoice identifiers for automated invoice delivery.

| Action                | Description                                    |
| --------------------- | ---------------------------------------------- |
| **View identifiers**  | Table listing configured e-invoice identifiers |
| **Add identifier**    | Form to add a new e-invoicing identifier       |
| **Edit identifier**   | Modify an existing identifier                  |
| **Delete identifier** | Remove an identifier                           |

## Key features

* **Split layout** — billing details and e-invoicing are independent sections that can be toggled separately.
* **Conditional rendering** — e-invoicing only shows when the Storecove integration is active.
* **Analytics** — billing updates are tracked ("billing\_details\_updated" event).

<Tip>If you use Storecove for electronic invoicing, make sure the E-Invoicing section is visible so members can configure their identifiers.</Tip>


# Credentials & Security
Source: https://learn.nexudus.com/member-portal/profile/credentials

Where members manage their password and access PINs.

The credentials page lets members manage their account security — changing passwords and viewing access PINs.

<Frame>
  <img alt="Credentials & Security page" />
</Frame>

## What members see

### PIN codes

A read-only section displaying the member's access PINs with copy-to-clipboard buttons:

| PIN                     | Description                                                                                      |
| ----------------------- | ------------------------------------------------------------------------------------------------ |
| **Check-in PIN**        | Used for signing in at the space (e.g. kiosks)                                                   |
| **Internet access PIN** | Used for Wi-Fi or network authentication                                                         |
| **Print release PIN**   | Used for releasing print jobs (shown if different from internet PIN — e.g. PaperCut integration) |

### Change password

A form to update the member's account password:

| Field                | Description                     |
| -------------------- | ------------------------------- |
| Current password     | Verify identity before changing |
| New password         | Must meet strength requirements |
| Confirm new password | Re-enter to confirm             |

Password strength is validated in real time. If the current password is incorrect, a specific error message is shown.

### Request new password

An alternative to manual password changes — sends a password reset link to the member's email address. This is useful when the member has forgotten their current password but is still signed in.

## Configurable sections

| Setting                      | Default | Effect                              |
| ---------------------------- | ------- | ----------------------------------- |
| Show PIN section             | On      | Display the access PINs             |
| Show password section        | On      | Display the change password form    |
| Show request password button | On      | Display the email reset link option |

<Tip>PINs are automatically generated. If you use PaperCut for printing, the print release PIN is displayed separately.</Tip>


# Integrations
Source: https://learn.nexudus.com/member-portal/profile/integrations

Where members connect calendar services and manage booking feeds.

The integrations page lets members connect their calendar services and subscribe to booking feeds so they can see their coworking schedule alongside personal and work commitments.

<Frame>
  <img alt="Integrations page" />
</Frame>

## What members see

### Calendar integrations

Direct two-way sync with external calendar providers:

| Provider              | Description                                                    |
| --------------------- | -------------------------------------------------------------- |
| **Google Calendar**   | Sync bookings to Google Calendar                               |
| **Microsoft Outlook** | Sync bookings to Outlook                                       |
| **Zoom**              | Connect Zoom for meeting room bookings (only shown if enabled) |

Members can connect and disconnect each provider independently.

### Calendar feeds (iCal)

One-way iCal feeds that members paste into their preferred calendar app. Supported providers:

| Provider            | Description                      |
| ------------------- | -------------------------------- |
| **Google Calendar** | iCal feed URL for Google         |
| **Outlook**         | iCal feed URL for Outlook        |
| **Apple Calendar**  | iCal feed URL for Apple Calendar |

Feed URLs are displayed with copy-to-clipboard buttons for easy setup.

### Resource feeds

Per-resource iCal feeds that show bookings for individual rooms, desks, or spaces. Members can subscribe to specific resources they frequently use.

## Key features

* **Two-way sync** — calendar integrations push and pull events between Nexudus and the external calendar.
* **One-way feeds** — iCal feeds are read-only subscriptions that update automatically.
* **Per-resource tracking** — resource feeds let members monitor availability for specific spaces.
* **Copy-to-clipboard** — feed URLs can be copied with one click.

## Configuration

Calendar providers are conditionally shown based on your location settings:

| Setting      | Effect                                       |
| ------------ | -------------------------------------------- |
| Show Google  | Display Google Calendar integration and feed |
| Show Outlook | Display Outlook integration and feed         |
| Show Apple   | Display Apple Calendar feed                  |
| Zoom enabled | Show Zoom integration option                 |

<Tip>
  Calendar integrations are a popular feature — encourage members to set them up during onboarding so their bookings automatically appear in their
  personal calendars.
</Tip>


# Payment Methods
Source: https://learn.nexudus.com/member-portal/profile/payment-methods

Where members manage their stored payment methods for Stripe, Spreedly, and GoCardless.

The payment methods page allows members to add, update, and view their stored payment information across multiple payment providers. This page only displays sections for payment providers that are enabled in your location settings.

<Frame>
  <img alt="Payment Methods page" />
</Frame>

## What members see

The page displays up to three conditional sections based on which payment providers you have enabled:

### Stripe Payment Methods

Appears when **Stripe Checkout** is enabled in your payment settings.

| Feature              | Description                                                      |
| -------------------- | ---------------------------------------------------------------- |
| **View saved cards** | Lists all payment methods saved to the member's Stripe account   |
| **Add new card**     | Opens Stripe's embedded checkout in setup mode to add a new card |
| **Card details**     | Shows card brand, last 4 digits, and expiration date             |
| **Auto-refresh**     | List automatically refreshes after adding a new card (2s delay)  |

Members can add multiple payment methods. The embedded Stripe Checkout interface handles all security and validation.

### Payment Card (Spreedly)

Appears when **Spreedly** is enabled in your payment settings.

| Feature              | Description                                                                         |
| -------------------- | ----------------------------------------------------------------------------------- |
| **Current card**     | Shows last 4 digits of the stored card (e.g., •••• •••• •••• 1234)                  |
| **Add/Update card**  | Opens inline card form to tokenize and store a new card                             |
| **Single card only** | Spreedly supports one card per member — adding a new card replaces the existing one |

The card number is stored in the `CardNumber` field of the member's profile and displays only the last 4 digits.

### Bank Account (GoCardless)

Appears when **GoCardless** is enabled in your payment settings.

| Feature            | Description                                                       |
| ------------------ | ----------------------------------------------------------------- |
| **Link status**    | Shows whether a bank account is currently linked                  |
| **Link/Update**    | Opens popup flow to connect or update bank account via GoCardless |
| **Status refresh** | Account status refreshes after popup closes (1.5s delay)          |

The GoCardless flow opens in a popup window. After the member completes the authorization, the page automatically refreshes to show the updated status.

## Key features

* **Conditional rendering** — only shows sections for enabled payment providers.
* **Provider-specific UI** — each provider has its own optimized interface:
  * Stripe uses embedded checkout for maximum security
  * Spreedly uses inline tokenization forms
  * GoCardless uses popup-based OAuth flows
* **Auto-refresh** — payment methods automatically refresh after updates.
* **Consistent styling** — all cards use the same bordered card design (`p-3 border rounded`).
* **Support notice** — informational alert directs members to contact support to remove payment methods.

## Payment provider settings

Each section is controlled by these location settings:

| Provider            | Setting                                   |
| ------------------- | ----------------------------------------- |
| **Stripe Checkout** | `MODULES.payments.stripeCheckout.enabled` |
| **Spreedly**        | `MODULES.payments.spreedly.enabled`       |
| **GoCardless**      | `MODULES.payments.goCardless.enabled`     |

<Info>If all payment providers are disabled, only the support contact notice will be visible to members.</Info>

## Removing payment methods

Members cannot remove payment methods directly through the portal. The page displays an informational alert instructing members to contact your support team for removal. This is a security measure to prevent accidental removal of active payment methods linked to subscriptions or recurring payments.

<Tip>
  **For operators**: Payment methods should be removed through the admin dashboard after verifying the member's request and confirming there are no active subscriptions or pending payments that depend on them.
</Tip>

## Technical details

### Backend requirements

* **Stripe**: Requires `POST /api/public/payments/stripe/createSetupSession` endpoint to generate setup sessions.
* **Spreedly**: Requires `PUT /api/public/payments/spreedly/store` endpoint to store tokenized cards.
* **GoCardless**: Uses existing callback flow at `/Callbacks/GoCardlessPre/`.

### Data storage

| Provider   | Storage location                       | Field content                            |
| ---------- | -------------------------------------- | ---------------------------------------- |
| Stripe     | Stripe API                             | Payment method objects with full details |
| Spreedly   | `Coworker.CardNumber`                  | Last 4 digits only                       |
| GoCardless | `Coworker.HasGoCardlessContractNumber` | Boolean flag indicating linked status    |


# Personal Information
Source: https://learn.nexudus.com/member-portal/profile/personal-information

Where members manage their personal details, avatar, and contact information.

The personal information page lets members view and update their profile data, including photos, contact details, and custom fields.

<Frame>
  <img alt="Personal Information page" />
</Frame>

## What members see

### Profile images

| Element                      | Specification                      |
| ---------------------------- | ---------------------------------- |
| **Banner / cover image**     | Minimum 1200 × 300 px, under 10 MB |
| **Avatar / profile picture** | 400 × 400 px                       |

Members can upload and change both images directly from this page.

### Editable fields

The form can include any of the following fields, depending on how your location is configured:

| Field                        | Description                                   |
| ---------------------------- | --------------------------------------------- |
| Full name                    | First and last name                           |
| Billing name & company       | Company or billing entity name                |
| Tax ID / registration number | Tax or company registration number            |
| Date of birth                | Member's date of birth                        |
| Address                      | Street, postal code, city, state, country     |
| Mobile phone                 | Mobile number                                 |
| Landline phone               | Landline number                               |
| Gender                       | Gender selection                              |
| Salutation                   | Title / salutation                            |
| Custom fields                | Any additional fields configured per business |

### Address lookup

The address field includes **location autocomplete** — members can type an address and select from suggestions rather than filling in every field manually.

## Key features

* **Dynamic form** — only the fields you enable in the dashboard appear on the page.
* **Custom fields** — add business-specific fields tailored to your operations.
* **Image handling** — failed image loads automatically reset to a placeholder.
* **Validation** — fields are validated in real time before saving.
* **Analytics** — profile updates are tracked ("profile\_updated" event).

<Tip>
  Decide which fields are visible and required in your Nexudus dashboard location settings. Only show fields that are relevant to your operations to
  keep the form short.
</Tip>


# Professional Profile
Source: https://learn.nexudus.com/member-portal/profile/professional-profile

Where members build their directory profile with skills, social links, and professional details.

The professional profile page lets members create a public-facing profile for the Members Directory, including industry details, social networks, and skills.

<Frame>
  <img alt="Professional Profile page" />
</Frame>

## What members see

### Professional details

| Field                    | Description                              |
| ------------------------ | ---------------------------------------- |
| Company name             | Member's company or business name        |
| Job position / role      | Current role or title                    |
| Industry / business area | The industry they operate in             |
| Website / portfolio URL  | Link to their website                    |
| Professional summary     | A bio or description (supports markdown) |

### AI-generated profile

If your location has **OpenAI** integration enabled (both `OpenAI.Enabled` and `OpenAI.AutoProfile.Enabled`), members can click a button to auto-generate a professional summary from their existing profile data.

### Skills & tags

Members select from a list of configurable skills and tags defined in your business settings. Tags are displayed as multi-select checkboxes.

### Social networks

Members can add URLs for up to **11 social platforms**:

LinkedIn, Facebook, Twitter, Instagram, GitHub, Skype, Telegram, Pinterest, Vimeo, Flickr, Blogger

All URLs are validated before saving.

### Directory visibility

If the Directory module is enabled, a toggle lets members choose whether their profile appears publicly in the Members Directory or remains private.

## Key features

* **AI profile generation** — auto-creates a compelling summary from profile data (optional, per-location setting).
* **Skills/tags** — customisable per location to match your community's industries and interests.
* **Privacy control** — members decide whether they appear in the directory.
* **URL validation** — all website and social URLs are validated.

<Tip>
  Configure relevant skills and tags in your dashboard to help members categorise themselves. This makes the Members Directory more useful for
  networking.
</Tip>


# Articles
Source: https://learn.nexudus.com/member-portal/public/articles

How members browse articles, read content, and engage through comments.

# Articles

The articles section gives your space a content marketing channel directly inside the portal. Publish articles about community news, industry insights, or space updates.

<Frame>
  <img alt="Article listing page" />
</Frame>

## Article listing page

The listing page shows all published articles in a card grid.

### What each card shows

* **Title and summary excerpt**
* **Featured image**
* **Author / "posted by" name**
* **Publication date**
* **Category tag**

### Filtering & search

| Filter       | What it does                                    |
| ------------ | ----------------------------------------------- |
| **Category** | Filter posts by their assigned category         |
| **Search**   | Free-text search across post titles and content |

Pagination loads 9 posts per page with previous/next navigation.

### Featured posts

On the first page, a **Featured Posts** section highlights articles you have marked as featured.

### Newsletter signup

A **Newsletter** subscription section appears at the bottom of the listing page so visitors can opt in to email updates.

***

## Article details page

Clicking a post opens the full article view.

<Frame>
  <img alt="Article details page" />
</Frame>

### Information displayed

* **Full article content** — HTML / markdown rendered with formatting preserved
* **Author and publication date**
* **Category**
* **Hero image**

### Comments

Members can leave comments with a title, body, and star rating. Authors can delete their own comments. The comments section can be enabled or disabled from the Page Editor.

### Related articles

A **Related Articles** section shows similar posts by category. This section is toggleable from the Page Editor.

***

## Recommended image sizes

Articles use two images: a **large image** and a **small image**. Each is requested at different sizes depending on context.

### Large image

| Where it appears           | Requested size | Aspect ratio |
| -------------------------- | -------------- | ------------ |
| **Detail page hero**       | 1280 × 520 px  | \~2.46 : 1   |
| **Featured posts section** | 1280 × 520 px  | \~2.46 : 1   |

### Small image

| Where it appears            | Requested size | Aspect ratio |
| --------------------------- | -------------- | ------------ |
| **Listing cards**           | 600 × 540 px   | \~1.11 : 1   |
| **Featured section (grid)** | 600 × 540 px   | \~1.11 : 1   |
| **Related articles**        | 600 × 540 px   | \~1.11 : 1   |

<Tip>
  For the best results, upload a **large image** of at least **1280 × 520 px** (landscape, \~2.5:1 ratio) and a **small image** of at least **600 × 540 px** (nearly square). This avoids cropping in all areas of the portal.
</Tip>


# Automation Tiles
Source: https://learn.nexudus.com/member-portal/public/automation-tiles

How automation tiles let customers perform actions by scanning a QR code or tapping an NFC tile in the Members Portal.

Automation Tiles connect the physical space to Nexudus. Customers perform actions — check in, unlock a door, book a resource, and more — by tapping their phone on an NFC tile or scanning its QR code. The Members Portal handles executing the tile action and displaying the result.

## How it works

1. A customer scans or taps an automation tile placed in your space.
2. The portal opens a dedicated full-page URL for that tile (`tiles/:tileId/execute`).
3. The portal calls the API to execute the tile's configured action.
4. The customer sees the result — a success message, an error, or is redirected to a URL.

## What customers see

### Loading state

While the action is being processed, a loading indicator is shown with a "Please wait…" title.

### Success

If the action completes successfully, a success alert is displayed along with the tile name.

### Error

If the action fails, an error alert is shown. When the API returns a specific error message, that message is displayed. Otherwise a generic "Sorry, this tile does not seem to work" message appears.

### Redirect

Some tile actions (e.g. `RedirectUrl`) send the customer to an external URL instead of showing a result on the page.

## Tile actions

The action performed when a tile is scanned depends on how the tile is configured in the Nexudus dashboard. Common actions include:

| Action               | Description                                  |
| -------------------- | -------------------------------------------- |
| **Check In**         | Checks the customer into the space           |
| **Check Out**        | Checks the customer out of the space         |
| **Booking Check In** | Checks the customer into a specific booking  |
| **Event Check In**   | Checks the customer into a specific event    |
| **Unlock Door**      | Unlocks an access-controlled door            |
| **Book Resource**    | Opens a booking flow for a specific resource |
| **Book Desk**        | Opens a booking flow for a desk              |
| **Redirect URL**     | Redirects to an external URL                 |
| **Request URL**      | Sends a request to an external URL           |
| **Resource Cleaned** | Marks a resource as cleaned                  |

<Tip>
  Automation Tiles are managed from the Nexudus dashboard under **Settings → Automation Tiles**. Each tile has a unique ID and a configurable action.
</Tip>

## API endpoint

The portal executes tile actions via:

```
GET /api/tiles/execute/{tileId}
```

### Response

| Field                  | Type    | Description                                                |
| ---------------------- | ------- | ---------------------------------------------------------- |
| `tileName`             | string  | Display name of the tile (optional)                        |
| `result.WasSuccessful` | boolean | Whether the action completed successfully                  |
| `result.Message`       | string  | Human-readable message from the server (optional)          |
| `result.RedirectURL`   | string  | If present, the customer is redirected to this URL instead |

## Route

The tile execution page is available at:

```
/:webAddress/tiles/:tileId/execute
```

This page uses the `FullPageLayout` — a minimal layout without the main navigation — so the customer sees only the action result.


# Community Board
Source: https://learn.nexudus.com/member-portal/public/community-board

The discussion forum where members post topics and interact with each other.

The Community Board is a built-in discussion forum that lets members start conversations, share ideas, and engage with the community.

<Frame>
  <img alt="Community Board page" />
</Frame>

## What members see

* **Discussion thread list** — a feed of community-posted topics with author name, date, and preview text.
* **Start Discussion button** — members can create new threads visible to the whole community.
* **Filter bar** — filter and sort discussions to find relevant topics.

## Key features

| Feature                  | Description                                                              |
| ------------------------ | ------------------------------------------------------------------------ |
| **Threaded discussions** | Members post topics that others can view and respond to                  |
| **Start Discussion**     | A call-to-action button for creating new threads (can be toggled on/off) |
| **Filtering & sorting**  | Organise discussions by date or relevance                                |
| **Title toggle**         | Optionally show or hide the page heading                                 |

## How to configure

From the **Page Editor** in the dashboard you can:

* Show or hide the **filter bar**
* Show or hide the **Start Discussion** button
* Toggle the page **title**

<Tip>The community board helps build a sense of belonging. Use it for member introductions, event recaps, or informal Q\&A.</Tip>


# Contact Us
Source: https://learn.nexudus.com/member-portal/public/contact

The contact page where visitors can reach your coworking space.

The Contact Us page provides a simple way for visitors and members to get in touch with your space.

<Frame>
  <img alt="Contact Us page" />
</Frame>

## Page sections

The page is built from three configurable sections:

| Section            | Description                                                             |
| ------------------ | ----------------------------------------------------------------------- |
| **Contact header** | An introductory heading and branding area at the top of the page        |
| **Contact form**   | A form visitors fill in to send you a message — fields are configurable |
| **Contact map**    | An embedded map showing your business location                          |

Each section can be independently shown or hidden from the Page Editor.

## Key features

* **Configurable form fields** — decide which fields appear and which are required.
* **Embedded location map** — automatically uses your business address.
* **Fixed navigation bar** — the header stays visible as visitors scroll.
* **Responsive layout** — optimised for both desktop and mobile devices.
* **SEO metadata** — page title set automatically for search engines.

<Tip>
  If you have multiple locations, the map section shows the primary business address. You can also direct visitors to specific locations through the
  home page Locations section.
</Tip>


# Courses
Source: https://learn.nexudus.com/member-portal/public/courses

How members browse courses and view course content, lessons, and enrollment information.

The courses section lets you offer structured learning content — multi-lesson programmes that members can enrol in and track their progress through.

<Frame>
  <img alt="Courses listing page" />
</Frame>

## Courses listing page

The listing page displays all published courses in a card grid with filtering.

### What each card shows

* **Course title and description**
* **Course image**
* **Instructor / host name**
* **Lesson count**
* **Category tag**

### Filtering & search

| Filter       | What it does                                          |
| ------------ | ----------------------------------------------------- |
| **Category** | Dropdown to filter courses by their assigned category |
| **Search**   | Free-text search across course titles and content     |

Pagination loads 9 courses per page with previous/next navigation.

### Featured courses

On the first page, a **Featured Courses** section highlights courses marked as featured in the dashboard.

***

## Course details page

Clicking a course card opens the full details view.

<Frame>
  <img alt="Course details page" />
</Frame>

### Information displayed

* **Course title and hero image**
* **Instructor / host name**
* **Full description** rendered from markdown
* **Overview text**
* **Pricing** — the course tariff displayed in the location's currency
* **Lesson count**

### Lessons

The course curriculum is displayed as expandable panels — one per lesson. Each panel shows:

* **Lesson number and title**
* **Lesson summary** (markdown formatted)

Members can expand and collapse individual lessons to browse the syllabus before enrolling.

### Supported HTML formatting in course and lesson content

Course descriptions and lesson content support rich HTML formatting. When creating or editing course or lesson content, you can use the following HTML elements and attributes:

#### Allowed HTML tags

Basic text formatting: `<p>`, `<br>`, `<strong>`, `<b>`, `<em>`, `<i>`, `<u>`, `<s>`, `<code>`, `<pre>`, `<h1>` – `<h6>`, `<blockquote>`, `<ul>`, `<ol>`, `<li>`, `<dl>`, `<dt>`, `<dd>`, `<table>`, `<thead>`, `<tbody>`, `<tfoot>`, `<tr>`, `<th>`, `<td>`, `<hr>`, `<div>`, `<span>`

Rich media: `<a>`, `<img>`, `<video>`, `<iframe>`

#### Allowed attributes

**Links** (`<a>`): `href`, `title`, `target`, `rel`

**Images** (`<img>`): `src`, `alt`, `title`, `width`, `height`, `style`

**Videos** (`<video>`): Standard HTML5 video attributes

**Embedded content** (`<iframe>`): `src`, `width`, `height`, `allow`, `frameborder`, `allowfullscreen`, `style` (YouTube videos are supported)

***

### Enrollment

An **Enrol** button allows members to start the checkout flow for the course.

***

## Recommended image sizes

Courses use two images: a **large image** and a **small image**. Each is requested at different sizes depending on context.

### Large image

| Where it appears             | Requested size | Aspect ratio |
| ---------------------------- | -------------- | ------------ |
| **Detail page hero**         | 1280 × 520 px  | \~2.46 : 1   |
| **Featured courses section** | 1280 × 520 px  | \~2.46 : 1   |
| **Checkout detail**          | 800 × 300 px   | \~2.67 : 1   |

### Small image

| Where it appears            | Requested size | Aspect ratio |
| --------------------------- | -------------- | ------------ |
| **Listing cards**           | 600 × 540 px   | \~1.11 : 1   |
| **Featured section (grid)** | 600 × 540 px   | \~1.11 : 1   |
| **Student course home**     | 600 × 540 px   | \~1.11 : 1   |
| **Completion page**         | 600 × 540 px   | \~1.11 : 1   |
| **Basket thumbnail**        | 220 × 220 px   | 1 : 1        |

<Tip>
  For the best results, upload a **large image** of at least **1280 × 520 px** (landscape, \~2.5:1 ratio) and a **small image** of at least **600 × 540 px** (nearly square). The large image is used as the hero and in checkout — a wider aspect ratio works best. The small image appears in card grids and should look good when cropped close to square.
</Tip>


# Members Directory
Source: https://learn.nexudus.com/member-portal/public/directory

A searchable directory where members showcase their professional profiles.

The Members Directory lets members discover and connect with other people and businesses in your coworking community.

<Frame>
  <img alt="Members Directory page" />
</Frame>

## What members see

The directory displays member and company profiles as cards. Each card can show:

* **Company name**
* **Home / primary location**
* **Professional tags and categories** (industry, specialty)
* **View Profile button** — opens the full member profile
* **Message button** — contact the member directly

## Filtering & search

| Filter           | Description                                  |
| ---------------- | -------------------------------------------- |
| **Tag filter**   | Narrow results by industry or specialty tags |
| **Order / sort** | Sort members by name, date joined, etc.      |
| **Search box**   | Free-text search by member or company name   |

All filter controls can be individually toggled from the Page Editor.

## How to configure

From the **Page Editor** you can control:

| Setting             | Effect                                   |
| ------------------- | ---------------------------------------- |
| Show title          | Toggle the page heading                  |
| Show filter bar     | Show or hide the full filter row         |
| Show tag filter     | Enable tag-based filtering               |
| Show order filter   | Enable sort options                      |
| Show search box     | Enable free-text search                  |
| Show company name   | Display company name on cards            |
| Show home location  | Display the member's primary location    |
| View profile button | Add a button linking to the full profile |
| Message button      | Add a button to contact the member       |

<Tip>
  Encourage members to complete their **Professional Profile** (under Profile & Settings) so the directory is useful and engaging. Members can control
  their visibility from their own profile settings.
</Tip>


# Events
Source: https://learn.nexudus.com/member-portal/public/events

How members browse, filter, and view events in the Members Portal.

The events section lets members discover upcoming happenings at your coworking space — workshops, networking sessions, socials, and more. It includes a listing page and a detail page for each event.

<Frame>
  <img alt="Events listing page" />
</Frame>

## Events listing page

The listing page shows all published events with powerful filtering and two view modes.

### View modes

| Mode              | Description                                                                 |
| ----------------- | --------------------------------------------------------------------------- |
| **List view**     | Events displayed as cards in a responsive grid — 9 per page with pagination |
| **Calendar view** | Monthly calendar showing events on their scheduled dates                    |

Members can switch between views using the toggle in the top-right corner.

### Filtering & search

| Filter                     | What it does                                                                              |
| -------------------------- | ----------------------------------------------------------------------------------------- |
| **Category**               | Dropdown of your event categories — members pick one to narrow results                    |
| **Search**                 | Free-text search across event titles and descriptions (auto-triggers after a short delay) |
| **Date range**             | Start/end date pickers to find events within a window                                     |
| **Location**               | Filter by business location (useful for multi-site setups)                                |
| **Past / Upcoming toggle** | Switch between future events and events that have already happened                        |

### Featured events

On the first page of results, a dedicated **Featured Events** section highlights events you have marked as featured in the dashboard. This section does not appear on subsequent pages.

***

## Event details page

When a member clicks an event, they see the full details.

<Frame>
  <img alt="Event details page" />
</Frame>

### Information displayed

* **Event name, date, and time range**
* **Location and venue** with map link
* **Host / organiser** name
* **Full description** rendered from rich text / markdown
* **Tickets** — each ticket type shows its price and remaining availability. When tickets sell out, a "Sold out" badge appears.
* **Waiting list** — if enabled, members can join a waiting list for sold-out events.

### Comments

Members can leave comments with a text body and a star rating. Comment authors can delete their own comments. You can enable or disable the comments section from the Page Editor.

### Related events

A "Related Events" section shows similar events based on category, encouraging members to discover more. This section can also be toggled on or off.

***

## Recommended image sizes

Events use two images: a **large image** and a **small image**. Each is requested at different sizes depending on context.

### Large image

| Where it appears            | Requested size | Aspect ratio |
| --------------------------- | -------------- | ------------ |
| **Detail page hero**        | 1280 × 520 px  | \~2.46 : 1   |
| **Featured events section** | 1280 × 520 px  | \~2.46 : 1   |

### Small image

| Where it appears            | Requested size | Aspect ratio |
| --------------------------- | -------------- | ------------ |
| **Event listing cards**     | 600 × 540 px   | \~1.11 : 1   |
| **Featured section (grid)** | 600 × 540 px   | \~1.11 : 1   |
| **Related events**          | 600 × 540 px   | \~1.11 : 1   |
| **Checkout confirmation**   | 600 × 540 px   | \~1.11 : 1   |
| **Basket thumbnail**        | 220 × 220 px   | 1 : 1        |

<Tip>
  For the best results across all contexts, upload a **large image** of at least **1280 × 520 px** (landscape, \~2.5:1 ratio) and a **small image** of at least **600 × 540 px** (nearly square). This avoids cropping in all areas of the portal.
</Tip>


# Home Page
Source: https://learn.nexudus.com/member-portal/public/home

The landing page of your Members Portal — hero section, plans, featured events, and locations.

The home page is the first thing visitors see when they navigate to your Members Portal. It provides an overview of your coworking space and is designed to convert visitors into members.

<Frame>
  <img alt="Members Portal home page" />
</Frame>

## What members see

The home page is built from configurable sections that you can toggle on or off from the Page Editor:

| Section             | Description                                                                                             |
| ------------------- | ------------------------------------------------------------------------------------------------------- |
| **Hero**            | Large banner area with headline text, sub-text, and a search box for quickly finding resources or plans |
| **Plans**           | Displays your membership plans and time passes so visitors can compare options at a glance              |
| **Featured Events** | Shows up to three upcoming events to drive attendance                                                   |
| **Locations**       | Lists your business locations — useful for multi-site operators                                         |

## Key features

* **Transparent navigation bar** — the top navigation overlays the hero image for a clean visual effect.
* **Configurable hero content** — set the main heading, supporting text, and call-to-action directly from the dashboard.
* **Plan display** — plans are pulled automatically from your configured tariffs and time passes, including pricing.
* **SEO metadata** — the page title is automatically set to your business name for search-engine optimisation.

## How to configure

All sections are optional. Use the **Page Editor** in the Nexudus dashboard to:

1. Show or hide the hero, plans, events, and locations sections.
2. Change heading text and sizes.
3. Adjust section spacing and layout.

<Tip>If you operate multiple locations, the Locations section helps visitors find the site nearest to them.</Tip>


# Perks
Source: https://learn.nexudus.com/member-portal/public/perks

Member perks, benefits, and partner offers displayed in the portal.

The Perks page showcases exclusive benefits, discounts, and partner offers available to your members.

<Frame>
  <img alt="Perks page" />
</Frame>

## What members see

Perks are displayed in a browsable grid. Each perk card shows:

* **Perk name and description**
* **Partner / provider company**
* **Discount or benefit details**
* **How to redeem**

<Frame>
  <img alt="Perks page" />
</Frame>

### Supported HTML formatting in perk details

Perk details support rich HTML formatting. When creating or editing a perk, you can use the following HTML elements and attributes:

#### Allowed HTML tags

Basic text formatting: `<p>`, `<br>`, `<strong>`, `<b>`, `<em>`, `<i>`, `<u>`, `<s>`, `<code>`, `<pre>`, `<h1>` – `<h6>`, `<blockquote>`, `<ul>`, `<ol>`, `<li>`, `<dl>`, `<dt>`, `<dd>`, `<table>`, `<thead>`, `<tbody>`, `<tfoot>`, `<tr>`, `<th>`, `<td>`, `<hr>`, `<div>`, `<span>`

Rich media: `<a>`, `<img>`, `<video>`, `<iframe>`

#### Allowed attributes

**Links** (`<a>`): `href`, `title`, `target`, `rel`

**Images** (`<img>`): `src`, `alt`, `title`, `width`, `height`, `style`

**Videos** (`<video>`): Standard HTML5 video attributes

**Embedded content** (`<iframe>`): `src`, `width`, `height`, `allow`, `frameborder`, `allowfullscreen`, `style` (YouTube videos are supported)

***

## Filtering

Members can filter perks by category or search by name and description. Advanced filtering options are also available if enabled.

## How to configure

From the **Page Editor** you can:

* Show or hide the page **title**
* Show or hide **filters**
* Enable **advanced filtering** options

Perks themselves are created and managed from the Nexudus dashboard under the Perks module.

<Tip>
  Partner with local businesses to offer member discounts — coffee shops, gyms, or software tools. It adds tangible value to your memberships.
</Tip>


# Resource List
Source: https://learn.nexudus.com/member-portal/public/resource-list

How members browse, filter, and book meeting rooms and desks in the Members Portal.

The Resource List page is where members discover and book available resources — meeting rooms, desks, offices, and other bookable spaces across your coworking locations. It supports multiple view modes and powerful filtering to help members find the right space quickly.

<Frame>
  <img alt="Resource List page" />
</Frame>

## What members see

Resources are displayed as cards in a responsive grid. Each card can show:

* **Resource name and image**
* **Capacity** (number of seats / people)
* **Price** per booking unit
* **Availability status** indicator
* **Instant book button** — book a resource directly from the card without navigating away

## View modes

The Resource List supports multiple ways to browse available spaces:

| Mode                | Description                                                                           |
| ------------------- | ------------------------------------------------------------------------------------- |
| **List view**       | Resources displayed as cards in a responsive grid — the default browsable view        |
| **Calendar view**   | Visual calendar showing resource availability across days and time slots              |
| **Floor plan view** | Interactive floor plan where members can see and select resources on a spatial layout |
| **Map view**        | Map-based view showing resource locations — useful for multi-site setups              |

Members can switch between available views using the view selector controls.

## Filtering & search

| Filter             | What it does                                                                    |
| ------------------ | ------------------------------------------------------------------------------- |
| **Category**       | Filter resources by type — meeting rooms, desks, offices, etc.                  |
| **Capacity**       | Find resources that fit a minimum number of people                              |
| **Amenities**      | Narrow results by available amenities — projector, whiteboard, video call, etc. |
| **Day & duration** | Quick shortcuts to filter by date and booking duration                          |
| **Custom fields**  | Additional filters based on custom fields configured for your resources         |

## Key features

* **Instant booking** — members can book a resource directly from the listing without opening a separate checkout page.
* **Real-time availability** — resource cards show current availability status so members know what is free right now.
* **Multi-location support** — resources from all your locations are browsable in a single view.
* **Responsive layout** — the grid adapts to screen size for a consistent experience on desktop and mobile.

## How to configure

From the **Page Editor** you can control:

| Setting               | Effect                                         |
| --------------------- | ---------------------------------------------- |
| Show filters          | Toggle the full filter bar                     |
| Show grid             | Display resources in the card grid layout      |
| Show price            | Show or hide pricing on resource cards         |
| Show instant booking  | Enable the quick-book button on cards          |
| Show calendar view    | Allow members to switch to the calendar view   |
| Show floor plan view  | Allow members to switch to the floor plan view |
| Show map view         | Allow members to switch to the map view        |
| Show category filter  | Enable filtering by resource category          |
| Show capacity filter  | Enable filtering by capacity                   |
| Show amenities filter | Enable filtering by amenities                  |

<Tip>Enable **Instant Booking** to let members reserve spaces in one click — it significantly reduces friction and increases booking rates.</Tip>

## Multi-location booking behaviour

When your network lists resources from multiple locations on a single site, the **Set the home location of new customers based on the location of the resource** setting (internal name: `PublicWebSite.Bookings.PreserveWebAddress`) controls what happens when a customer clicks on a resource to book it.

| Setting value         | Behaviour                                                                                                                                                                                                                                                                                           |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Disabled**          | The customer stays on the current site and completes the booking without being redirected. New customers who sign up during the booking process will have their home location set to the location where they are booking from (i.e. the network location showing resources across different sites). |
| **Enabled** (default) | The customer is redirected to the Members Portal of the location that owns the resource before completing the booking and their home location is set to that location.                                                                                                                              |

<Note>This setting only applies when a location is configured to display resources from other locations in the same network.</Note>

### Where to configure

In the Nexudus dashboard, go to **Settings > Bookings and calendar settings > General** and toggle **Set the home location of new customers based on the location of the resource**.

***

## Recommended image sizes

Resources use a single image that is requested at different sizes depending on context.

| Where it appears          | Requested size | Aspect ratio |
| ------------------------- | -------------- | ------------ |
| **Grid card**             | 800 × auto px  | Flexible     |
| **Detail page gallery**   | 900 × 506 px   | \~16 : 9     |
| **Checkout detail**       | 2048 × auto px | Flexible     |
| **Instant booking modal** | 600 × 300 px   | 2 : 1        |
| **Map view card**         | 500 × 200 px   | 5 : 2        |
| **Booking confirmation**  | 914 × auto px  | Flexible     |
| **Calendar thumbnail**    | 80 × 80 px     | 1 : 1        |
| **Basket thumbnail**      | 200 × 200 px   | 1 : 1        |
| **Dashboard upcoming**    | 300 × 300 px   | 1 : 1        |

<Tip>
  For the best results, upload a resource image of at least **2048 px wide** with a **16:9 aspect ratio** (e.g. 2048 × 1152 px). This covers the highest resolution requested by the detail page while looking good when cropped to square thumbnails or the 2:1 cards used in the booking modal. Keep the subject centred so it is not lost in tighter crops.
</Tip>


# Tours
Source: https://learn.nexudus.com/member-portal/public/tours

How visitors request and book tours of your coworking space through the Members Portal.

The tours feature lets prospective customers schedule a visit to your coworking space directly from the Members Portal. Visitors fill in a short form, pick an available date and time, and receive a confirmation email once the request is processed.

<Frame>
  <img alt="The tour form" />
</Frame>

## How tours appear in the portal

Tours are available in two places:

| Entry point               | Where it appears                                                                                         |
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Navigation bar**        | A "Book a tour" link in the portal header — visible to unauthenticated visitors when tours are enabled   |
| **Enquiry checkout flow** | When the enquiry tour option is active, the tour form is embedded as a step in the plan enquiry checkout |

Both entry points open the same tour booking form.

<Note>The "Book a tour" link only appears when tours are enabled **and** the location has billing configured. It is hidden from signed-in members.</Note>

### Linking directly to the tour form

You can open the tour form on any portal page by appending `?action=tour` to the URL. For example:

```
https://your-portal.nexudus.com/plans?action=tour
```

This is useful when you want to link to the tour form from an external website, email campaign, or social media post. The tour form will open automatically when the page loads.

## Tour booking form

The tour form collects the information needed to schedule a visit.

### Fields

| Field            | Required | Description                                                                                        |
| ---------------- | -------- | -------------------------------------------------------------------------------------------------- |
| **Full name**    | Yes      | Visitor's name                                                                                     |
| **Email**        | Yes      | Used for the confirmation email                                                                    |
| **Mobile phone** | Yes      | Contact number                                                                                     |
| **Location**     | Yes      | Dropdown listing locations that have tours enabled — defaults to the current location              |
| **Tour date**    | Yes      | Date picker — only future dates are selectable, and days without available time slots are disabled |
| **Time slot**    | Yes      | After picking a date, available half-hour slots are shown as buttons based on the configured hours |
| **Notes**        | No       | Free-text area for any additional information                                                      |

### Customising form fields

You can add extra fields to the tour form from the Nexudus dashboard under **Settings > Sign-up and checkout > Forms**. The Forms page lists all checkout flows that can be extended — click the **Tour** row to open its field editor.

<Note>
  Unlike other checkout forms, the tour form only supports **custom fields**. Standard sign-up fields (billing details, profile, contact information, etc.) cannot be added because the visitor is not creating an account.
</Note>

Each custom field can be set to:

| Status       | Behaviour                                          |
| ------------ | -------------------------------------------------- |
| **Optional** | Shown on the form but not required                 |
| **Required** | Must be filled in before the tour can be submitted |
| **Hidden**   | Not shown on the tour form                         |

### Date and time selection

When a visitor picks a date, the form displays the available time slots for that day as selectable buttons in 30-minute intervals. Only days that have at least one configured time slot are selectable in the calendar.

If no time slots are available for the selected date, an informational message is shown instead of the time buttons.

### Validation

* The tour date must be at least one day in the future.
* The selected time must fall within a configured time slot for that day of the week.
* All required fields must be completed before submission.

### reCAPTCHA and terms

The form includes Google reCAPTCHA to prevent spam submissions. Visitors must also accept your terms and conditions before booking.

***

## Calendly integration

If you prefer to use Calendly for tour scheduling, you can enable the Calendly integration instead of the built-in time-slot picker. When active, the tour form displays an embedded Calendly widget where visitors select their preferred time directly within Calendly's interface.

With Calendly enabled:

* The location dropdown and Calendly embed are shown instead of the date/time picker and contact fields.
* Visitor details and scheduling are handled entirely through Calendly.

***

## Confirmation

After a successful booking, the visitor sees a confirmation message and receives an email with the tour details. If you have configured a tour host, that person is also notified.

***

## Admin configuration

Tour settings are managed from the Nexudus dashboard under **Settings > Modules > Tours**.

### Enabling tours

| Setting                        | Description                                                                                  |
| ------------------------------ | -------------------------------------------------------------------------------------------- |
| **Enable tour form**           | Turns the tour request form on or off for the Members Portal                                 |
| **Tours require confirmation** | When enabled, tour requests must be manually confirmed by an admin before they are finalised |

### Tour time slots

| Setting                      | Description                                                                                              |
| ---------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Enable custom time slots** | Restricts tours to specific hours and days. When disabled, the location's regular opening hours are used |
| **Time slot schedule**       | A weekly planner where you define available days and time ranges for tours                               |

### Tour host

You can assign a user as the **tour host**. This person receives notifications when a tour is requested or when the visitor checks in. The assigned user should have a customer account linked to their profile.

### Enquiry tour

| Setting                          | Description                                                            |
| -------------------------------- | ---------------------------------------------------------------------- |
| **Include tour in enquiry flow** | Adds a tour scheduling step to the plan enquiry checkout in the portal |

### Calendly settings

These settings are found under **Settings > Integrations > Calendly**.

| Setting             | Description                                             |
| ------------------- | ------------------------------------------------------- |
| **Enable Calendly** | Activates the Calendly integration for tour scheduling  |
| **API token**       | Your Calendly personal API token                        |
| **Tour event URL**  | The Calendly event link used for the tour booking embed |

### iCal feed

When tours are enabled, an iCal feed URL is available in the dashboard. You can subscribe to this feed from any calendar application to keep track of upcoming tour requests.

***

## Visitor notifications

When a tour is booked, the system can send a notification email to the assigned tour host using the **Visitor Notification** template. This template is editable from the **Email Template Editor** in the dashboard.

The default template informs the host that a visitor is expected and includes the location name.

<Tip>Assign a dedicated tour host so that someone on your team is always notified when a new tour is requested. This ensures prospective customers get a timely response.</Tip>


# URL Parameters Reference
Source: https://learn.nexudus.com/member-portal/public/url-parameters

A complete reference of URL parameters you can use to deep-link into specific Members Portal pages with pre-filled values.

# URL Parameters Reference

You can link directly into specific Members Portal pages with pre-filled values by appending URL parameters. This is useful when sending customers to your portal from external websites, emails, marketing campaigns, or automation workflows.

<Tip>
  All query parameters are appended to the URL after a `?` character, and multiple parameters are separated with `&`. For example:
  `https://your-portal.nexudus.com/bookings/meeting-rooms/list?start=2026-06-01T09:00:00&type=12345`
</Tip>

## Booking pages

### Resource list and calendar

**Path:** `/bookings/:type/:view`

Use this to send customers directly to a filtered view of bookable resources.

| Parameter      | Location | Description                                                     |
| -------------- | -------- | --------------------------------------------------------------- |
| `:type`        | Path     | Resource type slug (e.g. `meeting-rooms`, `hot-desks`, `all`)   |
| `:view`        | Path     | View mode: `list`, `calendar`, `map`, or `floorplan`            |
| `start`        | Query    | Start date/time in ISO 8601 format (e.g. `2026-06-01T09:00:00`) |
| `end`          | Query    | End date/time in ISO 8601 format                                |
| `view`         | Query    | Calendar sub-view: `day`, `week`, `month`, or `list`            |
| `type`         | Query    | Filter by resource type ID                                      |
| `group`        | Query    | Filter by resource group name                                   |
| `Allocation`   | Query    | Minimum capacity (number of persons)                            |
| `floorplan_id` | Query    | Floor plan ID (for the floorplan view)                          |
| `customFields` | Query    | Comma-separated custom field filters                            |

**Feature filters** — set any of these to `true` to filter resources by amenities:

`Projector`, `Internet`, `ConferencePhone`, `StandardPhone`, `WhiteBoard`, `LargeDisplay`, `Catering`, `TeaAndCoffee`, `Drinks`, `SecurityLock`, `CCTV`, `VoiceRecorder`, `AirConditioning`, `Heating`, `NaturalLight`, `StandingDesk`, `QuietZone`, `WirelessCharger`, `PrivacyScreen`

<Info>
  **Example:** Show meeting rooms with a projector and natural light in calendar week view:
  `/bookings/meeting-rooms/calendar?view=week&Projector=true&NaturalLight=true`
</Info>

### Booking checkout

**Path:** `/public/bookings/edit`

Use this to send customers directly to the booking form for a specific resource.

| Parameter     | Location | Description                                              |
| ------------- | -------- | -------------------------------------------------------- |
| `resource_id` | Query    | ID of the resource to book                               |
| `start`       | Query    | Booking start time in ISO 8601 format                    |
| `end`         | Query    | Booking end time in ISO 8601 format                      |
| `desk`        | Query    | Specific desk ID (for resources with desk-level booking) |
| `booking`     | Query    | Existing booking ID (to edit an existing booking)        |
| `id`          | Query    | Alternative parameter for existing booking ID            |

<Info>
  **Example:** Open a booking form for resource 12345 on June 1st at 2pm:
  `/public/bookings/edit?resource_id=12345&start=2026-06-01T14:00:00&end=2026-06-01T15:00:00`
</Info>

***

## Checkout and sign-up

### Plan selection and sign-up flow

**Path:** `/checkout/tariffs`

Use this to send prospective customers directly to the sign-up flow, optionally with a plan pre-selected.

| Parameter      | Location | Description                                                                                               |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `plan_id`      | Query    | Pre-select a specific plan by ID                                                                          |
| `start`        | Query    | Contract start date in ISO 8601 date format (e.g. `2026-06-01`)                                           |
| `invite_guid`  | Query    | Invitation GUID to reveal restricted/private plans                                                        |
| `team_guid`    | Query    | Team GUID for team-based sign-up                                                                          |
| `proposal_id`  | Query    | Proposal ID for proposal-based checkout                                                                   |
| `discountCode` | Query    | Pre-apply a discount code                                                                                 |
| `refererGuid`  | Query    | Referrer GUID for referral tracking                                                                       |
| `type`         | Query    | Filter visible plans by plan type number                                                                  |
| `session_id`   | Query    | [AI assistant](/member-portal/ai/overview) session ID to track the conversation that led to this checkout |

<Info>
  **Example:** Send a customer to sign up with plan 67890 and a discount code:
  `/checkout/tariffs?plan_id=67890&discountCode=SUMMER20`
</Info>

**UTM tracking parameters** are also supported and stored for analytics:
`utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content`

### Checkout invite

**Path:** `/checkout/invite`

| Parameter | Location | Description                                                       |
| --------- | -------- | ----------------------------------------------------------------- |
| `t`       | Query    | Invite token — stored locally and used to unlock restricted plans |

***

## Store and products

### Product store

**Path:** `/store/:type`

| Parameter | Location | Description                                                 |
| --------- | -------- | ----------------------------------------------------------- |
| `:type`   | Path     | Product type slug to filter by, or `all` to show everything |

### Product checkout

**Path:** `/product/edit`

| Parameter    | Location | Description                   |
| ------------ | -------- | ----------------------------- |
| `product_id` | Query    | ID of the product to purchase |

<Info>
  **Example:** Link directly to purchase product 11111:
  `/product/edit?product_id=11111`
</Info>

***

## Events

### Events list and calendar

**Path:** `/events/:view` or `/events/:view/:categoryId/:slug`

| Parameter     | Location | Description                            |
| ------------- | -------- | -------------------------------------- |
| `:view`       | Path     | View mode: `list` or `calendar`        |
| `:categoryId` | Path     | Category ID to filter events           |
| `:slug`       | Path     | Category slug (for SEO-friendly URLs)  |
| `page`        | Query    | Page number for pagination             |
| `past`        | Query    | Set to `true` to show past events      |
| `search`      | Query    | Search term to filter events           |
| `start`       | Query    | Calendar start date in ISO 8601 format |
| `end`         | Query    | Calendar end date in ISO 8601 format   |
| `date`        | Query    | Selected date in ISO 8601 format       |

### Event details

**Path:** `/events/view/:id/:slug`

| Parameter | Location | Description                             |
| --------- | -------- | --------------------------------------- |
| `:id`     | Path     | Event ID                                |
| `:slug`   | Path     | Event name slug (for SEO-friendly URLs) |

### Event checkout

**Path:** `/event/edit`

| Parameter   | Location | Description                     |
| ----------- | -------- | ------------------------------- |
| `event_id`  | Query    | ID of the event to register for |
| `attendees` | Query    | Number of attendees to pre-fill |

<Info>
  **Example:** Register for event 22222 with 3 attendees:
  `/event/edit?event_id=22222&attendees=3`
</Info>

***

## Courses

### Course details

**Path:** `/courses/view/:id/:slug`

| Parameter | Location | Description                               |
| --------- | -------- | ----------------------------------------- |
| `:id`     | Path     | Course ID                                 |
| `:slug`   | Path     | Course title slug (for SEO-friendly URLs) |

### Course checkout

**Path:** `/course/edit`

| Parameter   | Location | Description                  |
| ----------- | -------- | ---------------------------- |
| `course_id` | Query    | ID of the course to enrol in |

***

## Community

### Community board

**Path:** `/community/board`

| Parameter   | Location | Description                |
| ----------- | -------- | -------------------------- |
| `group`     | Query    | Group ID to filter threads |
| `inbox`     | Query    | Show inbox threads         |
| `tag`       | Query    | Tag to filter by           |
| `thread_id` | Query    | Open a specific thread     |

### Members directory

**Path:** `/community/directory`

| Parameter     | Location | Description                        |
| ------------- | -------- | ---------------------------------- |
| `coworker_id` | Query    | Show a specific customer's profile |
| `team_id`     | Query    | Show a specific team's profile     |
| `tag`         | Query    | Filter by skill or tag             |
| `search`      | Query    | Search term                        |
| `type`        | Query    | Filter type                        |
| `order`       | Query    | Sort order                         |

***

## Locations directory

**Path:** `/directory`

| Parameter | Location | Description          |
| --------- | -------- | -------------------- |
| `maplat`  | Query    | Map centre latitude  |
| `maplng`  | Query    | Map centre longitude |
| `mapzoom` | Query    | Map zoom level       |

Use the URL hash `#card-{id}` to auto-scroll to a specific location card.

***

## Enquiry form

**Path:** `/enquire/form`

| Parameter      | Location | Description                       |
| -------------- | -------- | --------------------------------- |
| `plan_id`      | Query    | Pre-select a plan for the enquiry |
| `invite_guid`  | Query    | Invitation GUID                   |
| `team_guid`    | Query    | Team GUID                         |
| `proposal_id`  | Query    | Proposal ID                       |
| `discountCode` | Query    | Pre-apply a discount code         |
| `refererGuid`  | Query    | Referrer GUID                     |

***

## Tour request

**Path:** `/:webAddress` (location home page)

| Parameter | Location | Description                                 |
| --------- | -------- | ------------------------------------------- |
| `action`  | Query    | Set to `tour` to open the tour request form |
| `summary` | Query    | Pre-fill tour notes                         |

<Info>
  **Example:** Open the tour form with a note:
  `/your-space?action=tour&summary=Interested+in+a+10-person+office`
</Info>

***

## FAQ

**Path:** `/user/faq`

| Parameter  | Location | Description                      |
| ---------- | -------- | -------------------------------- |
| `faq_id`   | Query    | Auto-open a specific FAQ article |
| `category` | Query    | Filter by category name          |

***

## Authentication

### Login

**Path:** `/login`

| Parameter     | Location | Description                         |
| ------------- | -------- | ----------------------------------- |
| `redirectTo`  | Query    | URL path to redirect to after login |
| `redirectUrl` | Query    | Alternative redirect parameter      |
| `t`           | Query    | Exchange token for automatic login  |

<Info>
  **Example:** Send a customer to login and then redirect to a booking page:
  `/login?redirectTo=%2Fpublic%2Fbookings%2Fedit%3Fresource_id%3D12345`
</Info>

### Password reset

**Path:** `/login/forgot-reset`

| Parameter | Location | Description              |
| --------- | -------- | ------------------------ |
| `token`   | Query    | Password reset JWT token |

***

## Forms and surveys

### Form pages

**Path:** `/forms/:formId/show`

| Parameter | Location | Description |
| --------- | -------- | ----------- |
| `:formId` | Path     | Form GUID   |

### Survey pages

**Path:** `/survey/:surveyId/questionnaire`

| Parameter   | Location | Description |
| ----------- | -------- | ----------- |
| `:surveyId` | Path     | Survey GUID |

***

## Notes

* **Path parameters** (marked with `:`) are part of the URL path itself and are required.
* **Query parameters** are appended after `?` and are optional unless noted otherwise.
* All IDs refer to the Nexudus record ID, which you can find in the admin dashboard URL or via the REST API.
* Dates use [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:mm:ss` for date-times, `YYYY-MM-DD` for dates.
* URL-encode any special characters in parameter values (spaces become `+` or `%20`).

***

## Portal styling and theme mode

**Path:** Any Members Portal page (for example `/nexudus`)

| Parameter                | Location | Description                                                            |
| ------------------------ | -------- | ---------------------------------------------------------------------- |
| `Theme.DisableLightMode` | Query    | Forces dark mode for the current session                               |
| `Theme.ForceDarkMode`    | Query    | Forces dark mode for the current session, unless dark mode is disabled |
| `Theme.ForceLightMode`   | Query    | Forces light mode for the current session                              |

Use these together with color parameters when you want campaign or embed links to open in a specific mode.

For the full list of styling parameters, see [URL color overrides](/member-portal/styling/url-color-overrides).


# URL color overrides
Source: https://learn.nexudus.com/member-portal/styling/url-color-overrides

Override Members Portal theme colors at page load using URL parameters, with support for light and dark mode values.

# URL color overrides

You can override Members Portal colors directly from the page URL. This is useful when you want campaign-specific branding, embedded portal styling, or quick design tests without changing saved styling settings in Nexudus.

## When to use this

Use URL color overrides when you want to:

* apply a temporary color set for a campaign or event
* match the portal colors to a partner or white-label site
* test a new style direction before saving it as the default

<Info>
  Saved colors in Nexudus remain unchanged. URL overrides only affect the session opened with that URL.
</Info>

## How it works

When a page loads with supported `Theme.*` parameters:

1. Nexudus reads the saved colors for the location.
2. URL color values are applied on top of the saved colors.
3. A dynamic stylesheet is generated and loaded with the merged values.

This means the back-end remains the source of saved colors, and URL parameters are applied after those saved colors are returned.

## Supported parameters

### Behaviour parameter

| Parameter                | Values            | What it controls                                                |
| ------------------------ | ----------------- | --------------------------------------------------------------- |
| `Theme.DisableDarkMode`  | `true` or `false` | Forces light mode if set to `true`                              |
| `Theme.DisableLightMode` | `true` or `false` | Forces dark mode if set to `true`                               |
| `Theme.ForceDarkMode`    | `true` or `false` | Forces dark mode for the session when dark mode is not disabled |
| `Theme.ForceLightMode`   | `true` or `false` | Forces light mode for the session                               |

### Light mode color parameters

| Parameter              | Typical use              |
| ---------------------- | ------------------------ |
| `Theme.PrimaryColor`   | Main brand color         |
| `Theme.SecondaryColor` | Secondary brand color    |
| `Theme.TertiaryColor`  | Tertiary accent          |
| `Theme.BrandBlack`     | Dark neutral brand color |
| `Theme.Success`        | Success states           |
| `Theme.Warning`        | Warning states           |
| `Theme.Alert`          | Error and alert states   |
| `Theme.Info`           | Informational states     |
| `Theme.Highlight1`     | Highlight palette 1      |
| `Theme.Highlight2`     | Highlight palette 2      |
| `Theme.Highlight3`     | Highlight palette 3      |
| `Theme.Highlight4`     | Highlight palette 4      |
| `Theme.Highlight5`     | Highlight palette 5      |
| `Theme.Ground`         | Base ground color        |
| `Theme.Surface`        | Surface color            |

### Dark mode color parameters

Use the same colors for dark mode with the `DarkMode` suffix:

* `Theme.PrimaryColorDarkMode`
* `Theme.SecondaryColorDarkMode`
* `Theme.TertiaryColorDarkMode`
* `Theme.BrandBlackDarkMode`
* `Theme.SuccessDarkMode`
* `Theme.WarningDarkMode`
* `Theme.AlertDarkMode`
* `Theme.InfoDarkMode`
* `Theme.Highlight1DarkMode`
* `Theme.Highlight2DarkMode`
* `Theme.Highlight3DarkMode`
* `Theme.Highlight4DarkMode`
* `Theme.Highlight5DarkMode`
* `Theme.GroundDarkMode`
* `Theme.SurfaceDarkMode`

## Example URL

```text theme={null}
https://your-portal.nexudus.com/nexudus?Theme.PrimaryColor=%23D6BF57&Theme.SecondaryColor=%23161616&Theme.TertiaryColor=%2385878A&Theme.BrandBlack=%230B0A12&Theme.PrimaryColorDarkMode=%236092C0
```

<Tip>
  Use `%23` instead of `#` in hex values. Example: `#D6BF57` must be sent as `%23D6BF57`.
</Tip>

## Priority order

If the same visual token exists in multiple places, Nexudus applies values in this order:

1. URL override parameter
2. Saved color in Nexudus styling settings
3. Default portal fallback

## Light and dark mode behaviour

* If portal mode is light, light-mode values are used.
* If portal mode is dark, dark-mode values are used.
* If `Theme.ForceDarkMode=true`, the portal is forced to dark mode for that session.
* If `Theme.ForceLightMode=true`, the portal is forced to light mode for that session.
* If `Theme.DisableDarkMode=true`, the portal is forced to light mode for that session.
* If `Theme.DisableLightMode=true`, the portal is forced to dark mode for that session.

### Mode priority

When multiple mode parameters are present, Nexudus applies this order:

1. `Theme.DisableDarkMode=true` or `Theme.ForceLightMode=true` (light mode)
2. `Theme.DisableLightMode=true` or `Theme.ForceDarkMode=true` (dark mode)
3. Customer saved mode preference

## Mode examples

```text theme={null}
https://your-portal.nexudus.com/nexudus?Theme.ForceDarkMode=true&Theme.PrimaryColorDarkMode=%236092C0
```

```text theme={null}
https://your-portal.nexudus.com/nexudus?Theme.ForceLightMode=true&Theme.PrimaryColor=%23D6BF57
```

## Troubleshooting

If colors are not changing as expected:

1. Confirm parameter names are exact, including capitalization and `Theme.` prefix.
2. Confirm hex values are URL-encoded with `%23`.
3. Confirm you are passing the parameters on the page URL, not only after redirect steps.
4. Confirm dark mode is not disabled when testing dark-mode colors.
5. Hard refresh the page to avoid stale browser CSS.

## Related guides

* [URL Parameters Reference](/member-portal/public/url-parameters)
* [Custom Code and Fonts](/editor/custom-web-injector)


# Team Management
Source: https://learn.nexudus.com/member-portal/teams/team-management

An overview of the team management pages — bookings, attendance, members, and permissions.

The team management section is available to members who are designated as team managers or administrators. It provides visibility into team-wide bookings, attendance, membership, and permissions.

All team management pages are fully customisable through the **Page Editor** in the Nexudus dashboard, using the editor outline system.

## Team Bookings

**Route:** `/user/team/bookings`

Displays all resource bookings made by members of the team. Team managers can review upcoming and past reservations made by any team member. The layout and visible fields are configured entirely through the Page Editor.

<Frame>
  <img alt="Team Bookings page" />
</Frame>

***

## Team Attendance

**Route:** `/user/team/attendance` or `/user/team/attendance/:teamId`

Shows attendance records for team members — check-in and check-out times, presence data, and usage patterns. Useful for understanding how the team uses the space.

The `:teamId` URL parameter allows managers of multiple teams to view attendance for a specific team.

<Frame>
  <img alt="Team Attendance page" />
</Frame>

***

## Team Members

**Route:** `/user/team/members` or `/user/team/members/:teamId`

Lists all members of the team with their profile information. Team managers can view who belongs to the team and manage membership.

The `:teamId` URL parameter scopes the view to a specific team when the manager oversees multiple teams.

<Frame>
  <img alt="Team Members page" />
</Frame>

***

## Team Permissions

**Route:** `/user/team/permissions` or `/user/team/permissions/:teamId`

Manages role-based access controls and permissions for team members. Team managers can assign roles and configure what each member is allowed to do within the portal.

The `:teamId` URL parameter scopes the view to a specific team.

<Frame>
  <img alt="Team Permissions page" />
</Frame>

***

## Configuration

All four team management pages use the editor outline system, meaning their content and layout are entirely customisable from the Page Editor. There are no hard-coded UI elements — everything is driven by your dashboard configuration.

<Tip>
  Team management features are only visible to members with the appropriate team manager or admin role. Regular members will not see these pages in
  their navigation.
</Tip>


# Virtual Office Onboarding
Source: https://learn.nexudus.com/member-portal/virtual-office/onboarding

The multi-step onboarding wizard for virtual office members.

# Virtual Office Onboarding

The virtual office onboarding flow guides new virtual office members through a structured setup process, collecting company details, personal information, AML screening, identity verification, and mail handling preferences.

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

## Onboarding steps

The wizard uses a visual progress stepper so members always know where they are in the process.

| Step | Name                      | Description                                                              |
| ---- | ------------------------- | ------------------------------------------------------------------------ |
| 1    | **Company details**       | Company and contract information, including director/contact details     |
| 2    | **Personal details**      | Directors, recipients, and company aliases                               |
| 3    | **AML screening**         | Anti-money laundering checks (conditional — only if enabled on the plan) |
| 4    | **Identity verification** | Document upload for identity checks (conditional — only if required)     |
| 5    | **Mail preferences**      | Mail and delivery handling preferences                                   |
| 6    | **Complete**              | Confirmation screen indicating setup is finished                         |

### Dynamic step count

Steps 3 and 4 are conditionally displayed based on the plan configuration. The wizard adjusts the stepper and navigation accordingly:

* **AML + Identity checks enabled** — all 6 steps shown, AML must pass before identity verification begins.
* **Only AML checks enabled** — identity verification step is skipped.
* **Only Identity checks enabled** — AML screening step is skipped.
* **Neither enabled** — both steps are skipped and the member goes directly from personal details to mail preferences.

## Compliance flow order

When both AML and identity checks are enabled on a plan, they follow a strict order:

```
Personal details → AML screening → Identity verification → Mail preferences
```

<Warning>
  AML checks must pass (status: Clear or Manually Cleared) before identity verification is triggered. If AML checks fail, the member can go back to edit their director details.
</Warning>

## Key features

* **Smart routing** — the wizard detects which steps have already been completed and skips them on return visits.
* **Exit confirmation** — if a member tries to leave mid-process, a modal asks for confirmation to prevent accidental data loss.
* **Profile mismatch alert** — if the signed-in member doesn't match the expected virtual office profile, a warning is displayed.
* **Custom signup fields** — form fields adapt based on the tariff/plan the member has selected.
* **Director/contact form** — collects information about company directors or other contact persons.
* **AML confirmation dialog** — before triggering AML screening, the member is asked to confirm all directors have been added and that names, company registration numbers, and company names are correct.
* **Back navigation on failure** — if AML checks fail, the member can navigate back to the personal details step to correct director information.

## Form sections by step

### Step 1 — Company details

* Company name and registration
* Contract information
* Director/contact person details

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

### Step 2 — Personal details

* Directors: full name, address, city, postcode, state, phone, date of birth
* Recipients: forwarding addresses
* Company aliases

The continue button at the bottom of this step adapts based on the plan:

| Plan configuration                    | Button label                        | Behavior                                            |
| ------------------------------------- | ----------------------------------- | --------------------------------------------------- |
| AML checks required (not yet passed)  | "Continue to AML screening"         | Shows confirmation dialog, then triggers AML checks |
| AML passed + Identity checks required | "Continue to identity verification" | Triggers identity verification                      |
| Neither required                      | "Set up handling preferences"       | Navigates to mail preferences                       |

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

### Step 3 — AML screening (conditional)

Displayed when `RequiresAmlChecks` is enabled on the plan. The member sees the status of their AML screening for each director.

**Before triggering**: When clicking "Continue to AML screening" from the personal details step, the member sees a confirmation dialog:

> *"Please confirm that all directors have been added and that all names, company registration numbers and company names are correct. Once you proceed, the AML screening will be triggered and cannot be undone."*

**AML statuses displayed**:

| Status       | Badge  | Description                                          |
| ------------ | ------ | ---------------------------------------------------- |
| Not started  | Grey   | Checks haven't been triggered yet                    |
| In progress  | Blue   | Screening is running                                 |
| Clear        | Green  | All checks passed                                    |
| Under review | Yellow | Manual review required by the operator               |
| Match found  | Red    | Confirmed match — contact support                    |
| Error        | Red    | Processing error — review details or contact support |
| Cleared      | Green  | Manually cleared by an administrator                 |

**Navigation from the AML step**:

* If checks pass → "Continue to identity verification" (if identity checks enabled) or "Continue to handling preferences"
* If checks fail or are under review → "Back to edit directors" button appears, allowing the member to return to the personal details step and correct information

### Step 4 — Identity verification (conditional)

* Upload identity documents (passport, ID card, etc.)
* Only displayed when `RequiresIdentityChecks` is enabled for the plan
* Only reachable after AML screening passes (if AML is also enabled)

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

### Step 5 — Mail preferences

* Delivery handling instructions
* Forwarding preferences
* Notification settings for incoming mail

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

### Step 6 — Completion

* Confirmation that onboarding is complete
* Links to the dashboard or next steps

<Frame>
  <img alt="Virtual Office Onboarding" />
</Frame>

## State detection

The onboarding flow tracks completion status through metadata flags:

| Flag                         | Effect                                                                                                                            |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `RequiresAmlChecks`          | Controls whether the AML screening step appears                                                                                   |
| `AmlChecksStatus`            | Tracks the current AML outcome (`NotStarted`, `Pending`, `Clear`, `PotentialMatch`, `ConfirmedMatch`, `Error`, `ManuallyCleared`) |
| `RequiresIdentityChecks`     | Controls whether the identity verification step appears                                                                           |
| `HasStartedIdentityChecks`   | Tracks whether identity checks have been triggered                                                                                |
| `HasSubmittedIdentityChecks` | Detects whether identity documents have been submitted                                                                            |
| `HasSubmittedForm`           | Detects whether the member has already completed onboarding                                                                       |
| `ContactIsMissingDetails`    | Prevents proceeding if director information is incomplete                                                                         |

## Automatic redirect logic

When a member returns to the onboarding flow, the system determines which step to show:

1. Missing company details → **Company details** step
2. AML required but not started → **Personal details** (to trigger AML)
3. AML in progress or under review → **AML screening** step
4. AML passed, identity not started → **Personal details** (to trigger identity verification)
5. Identity started but not completed → **Identity verification** step
6. Preferences not set → **Mail preferences** step

<Tip>
  Virtual office onboarding is separate from the standard member registration flow. It is specifically designed for services that require additional
  compliance steps like AML screening, identity verification, and mail handling setup.
</Tip>


# Access
Source: https://learn.nexudus.com/operators/portal-configuration/access

Control who can view each section of your Members Portal by assigning access levels — public, logged-in users, members only, or contacts only.

## Overview

Access settings let you decide which types of visitors and customers can reach each section of your Members Portal. Combined with [Features Configuration](/operators/portal-configuration/features/features-configuration), which turns sections on or off entirely, access settings add a second layer of control by restricting **who** can see each enabled section.

Navigate to [**Settings → Website → Access**](https://dashboard.nexudus.com/settings/2/0/4) in the Nexudus dashboard to configure these settings.

## Access levels

Every configurable section supports four access levels:

| Level               | Who can see the section                                                    |
| ------------------- | -------------------------------------------------------------------------- |
| **Public**          | Anyone visiting your portal — no sign-in required                          |
| **Logged-in users** | Any customer who has signed in, regardless of whether they have a contract |
| **Members only**    | Only customers with an active contract                                     |
| **Contacts only**   | Only registered customers without an active contract                       |

<Info>
  Members are customers with an active contract, while contacts are customers without an active contract. Learn more in [Platform Overview](/get-started/platform-overview/data-model-overview).
</Info>

## Configurable sections

The table below lists every portal section whose access level you can control and links to the detailed documentation for that section.

### Global

| Section           | Description                                                                                             | Details                                    |
| ----------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| **Entire portal** | Sets the baseline access level for the whole portal. Sections with their own setting can override this. | [Portal overview](/member-portal/overview) |

### Public pages

| Section                        | Description                                                    | Details                                                  |
| ------------------------------ | -------------------------------------------------------------- | -------------------------------------------------------- |
| **Home page**                  | The landing page with hero, plans, events, and locations.      | [Home page](/member-portal/public/home)                  |
| **About us page**              | Static page describing your coworking space.                   | —                                                        |
| **Events list and calendar**   | Browse, filter, and purchase tickets for upcoming events.      | [Events](/member-portal/public/events)                   |
| **Booking pages**              | Resource listing, availability, and the booking checkout flow. | [Resource list](/member-portal/public/resource-list)     |
| **Directory pages**            | Professional profiles of your community members.               | [Directory](/member-portal/public/directory)             |
| **Discussion board pages**     | Community forums where customers post topics and replies.      | [Community board](/member-portal/public/community-board) |
| **Article pages**              | Published articles, news, and community stories.               | [Articles](/member-portal/public/articles)               |
| **Contact pages**              | Contact form for visitors and customers to reach your team.    | [Contact](/member-portal/public/contact)                 |
| **Perks and benefits page**    | Discounts and special offers available to your community.      | [Perks](/member-portal/public/perks)                     |
| **Frequently asked questions** | Searchable knowledge base of common questions and answers.     | [FAQ](/member-portal/dashboard/faq)                      |

### Logged-in sections

The sections below require a signed-in customer and cannot be set to **Public**.

| Section                 | Description                                                         | Details                                             |
| ----------------------- | ------------------------------------------------------------------- | --------------------------------------------------- |
| **Help-desk module**    | Support ticket system for submitting and tracking help requests.    | [Help desk](/member-portal/dashboard/help-desk)     |
| **Benefits page**       | Overview of allowances and credits included in the customer's plan. | [My plans](/member-portal/dashboard/my-plans)       |
| **Payments page**       | Invoice history, outstanding balances, and payment methods.         | [My invoices](/member-portal/dashboard/my-invoices) |
| **Plan selection page** | Browse and sign up for membership plans and time passes.            | [My plans](/member-portal/dashboard/my-plans)       |
| **Products store page** | Purchase products and services directly through the portal.         | [Store](/member-portal/checkout/store)              |

<Note>
  The **Payments**, **Plan selection**, and **Products store** sections are only available on portals running on the Nexudus-hosted infrastructure. They do not appear in self-hosted Vercel deployments.
</Note>

## How to configure

<Steps>
  <Step title="Open access settings">
    Go to [**Settings → Website → Access**](https://dashboard.nexudus.com/settings/2/0/4) in the Nexudus dashboard.
  </Step>

  <Step title="Set the access level for each section">
    For every section listed, select one of the four access levels: **Public**, **Logged-in users**, **Members only**, or **Contacts only**.
  </Step>

  <Step title="Save your changes">
    Click **Save**. Changes take effect immediately for all visitors.
  </Step>
</Steps>

## How access interacts with features

Access settings work hand-in-hand with two other configuration systems:

1. **[Features configuration](/operators/portal-configuration/features/features-configuration)** — turns a section on or off entirely. If a section is disabled, its access setting has no effect.
2. **Default customer access** — sets the per-customer defaults (network access, bookings, products, events, discussion boards) that are applied when a new customer is created. You can override these defaults on each individual customer's profile.

<Tip>
  First enable the sections you need in [Features](/operators/portal-configuration/features/features-configuration), then fine-tune who can see them here in Access.
</Tip>

## Linked access: bookings and events

Some sections are linked so their access levels stay in sync automatically:

* **Booking pages** and **Resource pages** always share the same access level. Changing one updates the other.
* **Events list and calendar** and **Event ticket pages** always share the same access level.

This ensures customers who can browse resources or events can also complete the related checkout flows.


# Custom Domain Setup
Source: https://learn.nexudus.com/operators/portal-configuration/custom-domain-setup

Configure your own domain name for your Members Portal to provide a seamless branded experience for your members.

## Overview

Custom domain setup allows you to use your own domain name (like `members.mydomain.com`) for your Members Portal instead of the default Nexudus subdomain. This provides a more professional, branded experience for your members and maintains consistency with your overall brand identity.

## Purpose

By default, your Members Portal is accessible through a Nexudus subdomain (like `yourspace.nexudus.site`). Custom domains solve several business challenges:

* **Brand consistency**: Keep your members within your brand ecosystem rather than directing them to a third-party domain
* **Professional appearance**: Custom domains appear more trustworthy and established to potential members
* **SEO benefits**: Domain authority remains with your organization
* **Member confidence**: Members feel more secure accessing services through your own domain

This feature is primarily designed for coworking operators who want to maintain their brand identity throughout the entire member experience.

## Setup Process

<CardGroup>
  <Card title="Basic Setup" icon="globe" href="#basic-configuration">
    Configure domain name and basic settings through the dashboard interface.
  </Card>

  <Card title="SSL & DNS Configuration" icon="shield-check" href="#ssl-and-dns-verification">
    Set up SSL certificates and configure DNS records for domain verification.
  </Card>
</CardGroup>

### Basic Configuration

<Steps>
  <Step title="Access Domain Settings">
    Navigate to **[Settings > Website > Domain](https://dashboard.nexudus.com/settings/2/0/6)** in your dashboard to begin custom domain configuration.
  </Step>

  <Step title="Add Domain Details">
    * **Name**: Internal reference name for the domain (not visible to users) - **Domain**: Your custom domain URL (e.g.,
      `members.mydomain.com`) -**Active status**: Toggle to enable/disable the domain The domain automatically includes SSL
      proxy functionality when created.
  </Step>

  <Step title="Save Configuration">
    Save your domain configuration to begin the verification process. The system will start checking DNS configuration and SSL certificate requirements.
  </Step>
</Steps>

## SSL and DNS Verification

The setup process differs depending on your Nexudus hosting configuration:

<Tabs>
  <Tab title="Portal version 5 or above">
    For locations running on version 5 of the members portal, the system provides automated SSL certificate generation and detailed DNS configuration guidance.

    #### DNS Configuration Requirements

    Once you save your domain, the system displays the required DNS records:

    | Record Type | Name/Host                                      | Value/Points to                   |
    | ----------- | ---------------------------------------------- | --------------------------------- |
    | **CNAME**   | Your subdomain (e.g., `members`)               | Value provided by the system      |
    | **A**       | `@` or your apex domain (e.g., `mydomain.com`) | IP address provided by the system |

    <Warning>
      DNS records must match exactly as provided. Any discrepancies will prevent SSL certificate generation and domain
      verification.
    </Warning>

    #### SSL Certificate Process

    The system automatically handles SSL certificate generation through this workflow:

    1. **DNS Verification**: System checks that your DNS records point correctly to Nexudus servers
    2. **Certificate Request**: Automatic SSL certificate request is initiated
    3. **Certificate Issuance**: Certificate is generated and deployed
    4. **Domain Activation**: Your custom domain becomes fully functional

    The verification process typically takes a few minutes to several hours, depending on DNS propagation times.

    #### Status Monitoring

    The interface provides real-time status updates:

    * **Domain Status**: Shows whether DNS records are properly configured
    * **SSL Certificate Status**: Indicates certificate generation progress
    * **Ready to Use**: Confirmation when the domain is fully operational
  </Tab>

  <Tab title="Members Portal version 1 to 4">
    For locations running earlier versions of the members portal, additional coordination with Nexudus support is required before domain setup.

    <Info>Contact [support@Nexudus.com](mailto:support@Nexudus.com) before attempting to add custom domains on legacy hosting to ensure proper SSL certificate provisioning.</Info>
  </Tab>
</Tabs>

### Troubleshooting Common Issues

* **Certificate Pending**: Usually indicates DNS records are not yet properly configured or propagated
* **Domain Misconfigured**: DNS records don't match the required values exactly

<Tip>
  Use `nslookup`, `ping` or online DNS checking tools to verify your DNS records are properly configured before
  contacting support.
</Tip>


# Articles
Source: https://learn.nexudus.com/operators/portal-configuration/features/articles

Configure the articles module for your Members Portal.

## Overview

The articles module lets you publish articles, announcements, and other content for your customers to read directly in the Members Portal. You can control whether customers can leave comments and whether those comments are published automatically.

Navigate to [**Settings → Modules → Articles**](https://dashboard.nexudus.com/settings/2/2/4) in the Nexudus dashboard to configure these settings.

## Settings

| Setting                                        | Description                                                                                                                                              |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable the articles section**                | Turns the articles section on or off in the portal.                                                                                                      |
| **Let users post comments in articles**        | Allows customers to leave comments on published articles.                                                                                                |
| **Automatically publish comments in articles** | When enabled, comments appear immediately. When disabled, each comment must be manually approved by an administrator before it is visible on the portal. |

## Related pages

* [Articles](/member-portal/public/articles) — the articles listing and detail pages customers see in the portal


# Directory
Source: https://learn.nexudus.com/operators/portal-configuration/features/directory

Configure the professional directory module for your Members Portal.

## Overview

The directory module lets your customers share their personal and company professional profiles, and browse profiles published by other members. You can control which directory types are active, what content is included, and define the skills and industries available for tagging. Customers can also direct message other customers from the directory.

Navigate to [**Settings → Modules → Directory**](https://dashboard.nexudus.com/settings/2/2/8) in the Nexudus dashboard to configure these settings.

## Settings

| Setting                                               | Description                                                                                                                                             |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable members and teams directories**              | Turns the directory section on or off in the portal.                                                                                                    |
| **List all customers and teams across all locations** | When enabled, the directory shows profiles from every location in your network. When disabled, only profiles from the current location are displayed.   |
| **Enable these directory types**                      | Choose which types of directory entries to show — for example, individual profiles, team profiles, or both.                                             |
| **Directories should include**                        | Control whether directories display all customers, only those who have opted in, or another subset.                                                     |
| **Profile skills and industries**                     | Define the tags customers can choose when describing their skills and industries on their profiles. You can enter custom tags or use a recommended set. |

## Related pages

* [Directory](/member-portal/public/directory) — the directory browsing page customers see in the portal
* [Professional profile](/member-portal/profile/professional-profile) — where customers edit their own profile information


# Discussion Boards
Source: https://learn.nexudus.com/operators/portal-configuration/features/discussion-boards

Configure the discussion boards community forum for your Members Portal.

## Overview

The discussion boards module gives your customers a community forum where they can post topics, share files and images, and engage with other members. You can control posting permissions, daily digest emails, and notification preferences.

Navigate to [**Settings → Modules → Discussion boards**](https://dashboard.nexudus.com/settings/2/2/3) in the Nexudus dashboard to configure these settings.

## Settings

'

| Setting                                                                | Description                                                                                                                                                                                                                           |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable the discussion boards section**                               | Turns the discussion boards on or off in the portal.                                                                                                                                                                                  |
| **Customers can only post new messages to groups they have access to** | Restricts posting so customers can only create new topics in discussion groups they belong to, rather than in all groups or the general group.                                                                                        |
| **Sign-up new users to the discussion board daily digest**             | Automatically subscribes new customers to a daily email summarising recent discussion board activity.                                                                                                                                 |
| **Enable discussion board notifications to members**                   | Sends discussion board notifications to customers with an active contract.                                                                                                                                                            |
| **Enable discussion board notifications to contacts**                  | Sends discussion board notifications to registered customers without an active contract.                                                                                                                                              |
| **Digest email subject line**                                          | Customise the subject line of the daily digest email. You can use `{businessName}` for the location name, `{fullNames}` for the names of people who posted, `{subjects}` for the topics discussed, or `{groups}` for the group names. |

## Related pages

* [Community board](/member-portal/public/community-board) — the discussion board page customers see in the portal


# Events and Ticketing
Source: https://learn.nexudus.com/operators/portal-configuration/features/events

Configure the events calendar and ticket purchasing settings for your Members Portal.

## Overview

The events and ticketing module displays your event calendar in the Members Portal and lets customers browse, register for, and purchase tickets to your events. You can also control ticket cancellation policies, billing behaviour, and attendee notifications.

Navigate to [**Settings → Modules → Events**](https://dashboard.nexudus.com/settings/2/2/5) in the Nexudus dashboard to configure these settings. Ticket-specific checkout settings are also available at [**Settings → Sign-up and checkout → Checkout**](https://dashboard.nexudus.com/settings/2/1/2).

## Settings

| Setting                                                                 | Description                                                                                                                                                                                       |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable the events and tickets section**                               | Turns the events calendar and ticket purchasing on or off in the portal.                                                                                                                          |
| **Allow customers to cancel event tickets**                             | Lets customers cancel tickets they have already purchased.                                                                                                                                        |
| **Automatically cancel unpaid tickets purchased by contacts**           | Unpaid tickets bought by customers without an active contract are automatically cancelled 15 minutes after purchase. Only available on Nexudus-hosted portals.                                    |
| **Invoice event buyer instead of their team paying customer**           | When a customer in a team with merged billing buys a ticket, the invoice goes to the buyer instead of the team's paying customer. Has no effect for customers not in teams with merged invoicing. |
| **Include an internet access code in each ticket confirmation email**   | Adds a network access code to the confirmation email sent after a ticket purchase.                                                                                                                |
| **Send a reminder to event attendees 24 hours before the event starts** | Sends an automated reminder email to all attendees the day before the event.                                                                                                                      |

### Events calendar feed

When events are enabled, an iCal feed URL is generated automatically. You can subscribe to this feed from any calendar application to see upcoming events.

## Related pages

* [Events](/member-portal/public/events) — the events listing and calendar page customers see in the portal
* [Event checkout](/member-portal/checkout/event-checkout) — the ticket purchase flow
* [My events](/member-portal/dashboard/my-events) — the customer's purchased tickets and registrations


# Features Configuration
Source: https://learn.nexudus.com/operators/portal-configuration/features/features-configuration

Control which portal sections and features are available to your customers by enabling or disabling specific functionality modules.

## Overview

Features configuration allows you to customize your members portal by selectively enabling or disabling different sections and functionality. This central control system determines which features appear in your portal's navigation menu and which services are available to your customers.

Different coworking spaces offer different services — this system lets you present only the features that are relevant to your location. Disabling unused features creates a cleaner, more focused experience for your customers while reducing confusion and support inquiries.

Navigate to [**Settings → Website → Features**](https://dashboard.nexudus.com/settings/2/0/3) in your Nexudus dashboard to configure these settings.

## Portal features

You can toggle each of the following features on or off. Features with additional configuration options link to a dedicated settings page.

<CardGroup>
  <Card title="My account" icon="user" href="/operators/portal-configuration/features/my-account">
    Enables customers to edit their details, professional profile, and manage their membership and payment information.

    [Configuration →](/operators/portal-configuration/features/my-account)

    [What customers see →](/member-portal/profile/personal-information)
  </Card>

  <Card title="Help-desk" icon="headset" href="/member-portal/dashboard/help-desk">
    Enables customers to report issues and request help from you and your team.

    [What customers see →](/member-portal/dashboard/help-desk)
  </Card>

  <Card title="Deliveries" icon="box" href="/member-portal/dashboard/my-deliveries">
    Enables customers to keep track of any deliveries they need to collect from your team.

    [What customers see →](/member-portal/dashboard/my-deliveries)
  </Card>

  <Card title="Contact form" icon="envelope" href="/member-portal/public/contact">
    Enables customers and other users of your site to contact you via an online form.

    [What customers see →](/member-portal/public/contact)
  </Card>

  <Card title="Discussion boards" icon="comments" href="/operators/portal-configuration/features/discussion-boards">
    Enables customers to communicate with other members as well as share images and files via an online forum system.

    [Configuration →](/operators/portal-configuration/features/discussion-boards)

    [What customers see →](/member-portal/public/community-board)
  </Card>

  <Card title="Events and tickets" icon="calendar" href="/operators/portal-configuration/features/events">
    Enables customers and other users to see a calendar of events as well as purchase tickets or register for those events.

    [Configuration →](/operators/portal-configuration/features/events)

    [What customers see →](/member-portal/public/events)
  </Card>

  <Card title="Directory" icon="address-book" href="/operators/portal-configuration/features/directory">
    Enables customers to list their professional and/or company profile as well as browse the profiles shared by other customers.

    [Configuration →](/operators/portal-configuration/features/directory)

    [What customers see →](/member-portal/public/directory)
  </Card>

  <Card title="Articles" icon="newspaper" href="/operators/portal-configuration/features/articles">
    Enables you to post content for customers to read.

    [Configuration →](/operators/portal-configuration/features/articles)

    [What customers see →](/member-portal/public/articles)
  </Card>

  <Card title="Team and attendance" icon="clock" href="/operators/portal-configuration/features/team">
    Enables team members to view the team attendance section and lets team administrators manage their teams.

    [Configuration →](/operators/portal-configuration/features/team)

    [What customers see →](/member-portal/teams/team-management)
  </Card>

  <Card title="Visitor registration" icon="user-plus" href="/member-portal/dashboard/my-visitors">
    Enables customers to pre-register guests coming to visit them. You can use NexIO to check visitors in using QR codes, a pin-code, or a front-desk visitor registration form.

    [What customers see →](/member-portal/dashboard/my-visitors)
  </Card>

  <Card title="Tour request form" icon="map" href="/operators/portal-configuration/features/tours">
    Enables users to request a tour of this location.

    [Configuration →](/operators/portal-configuration/features/tours)

    [What customers see →](/member-portal/public/tours)
  </Card>

  <Card title="Metrics" icon="chart-line">
    Enables customers to view the metrics section.
  </Card>

  <Card title="Notifications" icon="bell" href="/member-portal/profile/account-settings">
    Enables customers to manage the notifications they receive.

    [What customers see →](/member-portal/profile/account-settings)
  </Card>
</CardGroup>

## Configuration Process

<Steps>
  <Step title="Access Features Settings">
    Navigate to [**Settings** → **Website** → **Features**](https://dashboard.nexudus.com/settings/2/0/3) in your Nexudus dashboard.
  </Step>

  <Step title="Enable Desired Sections">
    Toggle each feature on or off based on the services your location offers. Each feature includes a description of its
    functionality.
  </Step>

  <Step title="Configure Access Levels">
    After enabling features, use the [**Access**](/operators/portal-configuration/access)
    settings to control which types of customers can access each section.
  </Step>

  <Step title="Test customer experience">
    Review your portal to ensure the enabled features create a logical navigation flow for your customers.
  </Step>
</Steps>

## Key interactions

### Access control integration

Feature enablement works in conjunction with [access control](/operators/portal-configuration/access) settings. Even when a feature is enabled, you can still restrict access based on customer type (public, logged-in users, contacts, or members). This two-layer system provides granular control over your portal experience.

### Navigation impact

Enabled features automatically appear in your portal's navigation menu. Disabled features are completely hidden, creating a streamlined interface that matches your location's service offerings.

### Mobile app synchronization

Many of these feature settings also control availability in the Nexudus mobile app, ensuring consistency across all customer touchpoints.

## Important implications

<Warning>
  Disabling core features like "My account" may prevent customers from managing essential functions like billing and
  profile updates. Consider the complete customer journey before restricting access to fundamental sections.
</Warning>

### Feature dependencies

Some features work better together:

* **Directory** and **Discussion boards** create stronger community engagement
* **Events** and **Articles** support comprehensive programming communication
* **Visitor registration** requires staff training on NexIO integration for optimal effectiveness

<Tip>
  Start with core features (for example, My account, Help desk) and gradually enable additional sections as
  your community grows and your service offerings expand.
</Tip>


# My Account
Source: https://learn.nexudus.com/operators/portal-configuration/features/my-account

Configure which account management features are available to your customers in the My Account section of the portal.

## Overview

The My account settings control what customers can do from their account area in the Members Portal. This includes managing plans, bookings, help requests, and invoices.

Navigate to [**Settings → Modules → My account**](https://dashboard.nexudus.com/settings/2/2/9) in the Nexudus dashboard to configure these settings.

## Settings

| Setting                                               | Description                                                                                             |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Users can change or cancel their plan**             | Allows customers to switch to a different membership plan or cancel their current one from the portal.  |
| **Users can request new bookings**                    | Allows customers to create new resource bookings.                                                       |
| **Users can change existing bookings**                | Allows customers to modify bookings they have already made.                                             |
| **Users can request help using the help-desk module** | Allows customers to submit support tickets through the [help desk](/member-portal/dashboard/help-desk). |
| **Users can view / pay their invoices**               | Allows customers to see their [invoices](/member-portal/dashboard/my-invoices) and make payments.       |
| **Users can print their invoices**                    | Allows customers to download or print a copy of their invoices.                                         |

## Related pages

* [Personal information](/member-portal/profile/personal-information) — what customers see in their profile
* [My invoices](/member-portal/dashboard/my-invoices) — the invoice and payments page
* [My bookings](/member-portal/dashboard/my-bookings) — the bookings management page
* [My plans](/member-portal/dashboard/my-plans) — the plans and passes page
* [Help desk](/member-portal/dashboard/help-desk) — the support ticket system


# Team and Attendance
Source: https://learn.nexudus.com/operators/portal-configuration/features/team

Configure team management and attendance tracking settings for your Members Portal.

## Overview

The team and attendance settings control how teams operate in the Members Portal, including attendance reminders, weekly reports, and what team administrators can manage for their members. This module is particularly useful for teams wanting to ,,manage and track employee/team member attendance.

Navigate to [**Settings → Modules → Team**](https://dashboard.nexudus.com/settings/2/2/10) in the Nexudus dashboard to configure these settings.

## Settings

| Setting                                                                                          | Description                                                                                                                        |
| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| **Send a reminder to customers set to "work from the office" the next day but with no bookings** | Sends an automated reminder at around 8 pm the day before customers are expected in the office, prompting them to book a resource. |
| **Send an attendance report to all team administrators once a week**                             | Generates a weekly attendance report every Sunday and adds it to the Files section of each team administrator.                     |
| **Team administrators can remove members from their teams**                                      | Allows team admins to remove members directly from the team management page in the portal.                                         |
| **Let team administrators update access card details for their team members**                    | Allows team admins to edit access card information for members of their team.                                                      |

## Related pages

* [Team management](/member-portal/teams/team-management) — the team management page customers see in the portal


# Tour Request Form
Source: https://learn.nexudus.com/operators/portal-configuration/features/tours

Configure the tour request form that lets visitors schedule a visit to your coworking space.

## Overview

The tour request form allows prospective customers to schedule a visit to your location directly from the Members Portal. You can require administrator confirmation, restrict tours to specific time slots, and assign a staff member as tour host.

Navigate to [**Settings → Modules → Tours**](https://dashboard.nexudus.com/settings/2/2/1) in the Nexudus dashboard to configure these settings.

## Settings

| Setting                                                         | Description                                                                                                                                                                 |
| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enable the tour request form section**                        | Turns the tour request form on or off in the portal.                                                                                                                        |
| **Tour requests must be confirmed by an administrator**         | When enabled, tour requests are held in a pending state until an administrator approves them.                                                                               |
| **Tours can only be booked at specific hours/days of the week** | Restricts available tour times to a defined schedule instead of allowing any time. When enabled, a time-slot editor appears where you can set the available days and hours. |
| **Tour host**                                                   | Select a staff member to be notified when someone requests a tour and to act as the host on the day of the visit.                                                           |

### Tours iCal feed

When the tour form is enabled, an iCal feed URL is generated automatically. You can subscribe to this feed from any calendar application to see upcoming tour appointments.

## Related pages

* [Tours](/member-portal/public/tours) — the tour request page customers see in the portal


# Search Engine Optimization (SEO)
Source: https://learn.nexudus.com/operators/portal-configuration/seo-optimization

Optimize your Members Portal for search engines to help potential customers discover your coworking space online

## What is SEO Pre-rendering?

When search engine bots (like Google, Bing, or DuckDuckGo) visit your Members Portal, they receive a specially pre-rendered version of each page that includes:

* **Meta tags** — Title and description that appear in search results
* **Open Graph data** — Rich preview cards when shared on social media
* **Structured data (JSON-LD)** — Machine-readable information about your location, opening hours, and services
* **Navigation links** — Links to all your public pages to help crawlers discover your content

This pre-rendered content ensures search engines can properly index your site and display it attractively in search results, even though your Members Portal is a dynamic web application.

<Note>
  SEO pre-rendering is automatically enabled for all Members Portal Version 5 locations. No additional setup is required.
</Note>

## Configuring SEO Settings

Navigate to **Settings > Features > Website > SEO** to configure how your portal appears in search engines.

<Info>
  The SEO tab is only available for locations running Members Portal Version 5.
</Info>

### Home Page Content

The settings you configure for your home page directly affect what search engines display in search results:

#### Banner & Claims

| Setting                  | Impact on SEO                                                             | Tip                                                                        |
| ------------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| **Banner main text**     | Used as the primary headline in search result titles and Open Graph cards | Use `{"{0}"}` to insert your location name (e.g., "Welcome to `{"{0}"}` ") |
| **Banner small text**    | Appears as the subtitle in search results after a dash                    | Keep concise — this is often the first thing people read                   |
| **Primary claim text**   | Displayed as a prominent section heading in crawler content               | Summarize your main value proposition                                      |
| **Secondary claim text** | Shown in the footer area of pre-rendered content                          | Good place for a call-to-action                                            |

<Tip>
  Search engines give more weight to text that appears higher on the page. Put your most important keywords in the banner text and primary claim.
</Tip>

#### Services Section

When you enable services on your home page, each service adds a bullet point to the pre-rendered content that search engines see:

* **Workspace service** — Describe your hot desks, dedicated desks, and workspace offerings
* **Bookings service** — Highlight meeting rooms, event spaces, and bookable resources
* **Community service** — Promote your networking events, community perks, and member benefits

Each service has a **short text** (used as the label) and **long text** (used as the description). Both appear in search engine content.

### Features Visible to Search Engines

The features you enable in **Settings > Features > Website > Features** directly affect what search engines index:

* Enabled features appear in a "What We Offer" list in search results
* They influence your meta description (the snippet shown below your title)
* Each feature gets a clickable link in the navigation section

**Enabled features currently visible to crawlers:**

* Events
* Blog
* Room Bookings
* Member Directory
* Discussion Board
* Contact
* Book a Tour
* Online Sign Up
* Mail & Deliveries
* Visitor Management

<Warning>
  Disabling a feature in Settings > Features will remove it from your SEO content and may affect your search rankings for that feature.
</Warning>

### Social Links

Social network links you configure in **Settings > Features > Website > Footer** are included in structured data served to search engines.

| Platform    | How It Helps SEO                                               |
| ----------- | -------------------------------------------------------------- |
| X (Twitter) | Appears in your Google Knowledge Panel                         |
| Facebook    | Helps Google associate your social presence with your location |
| Instagram   | Included in `sameAs` schema.org property for brand validation  |

These links help search engines understand that your social media accounts belong to your coworking space, which can improve your overall online presence.

### Location Information

The following location details from **Settings > General settings > Contact & location details** are used in structured data:

| Field                  | SEO Impact                                                        |
| ---------------------- | ----------------------------------------------------------------- |
| **Location name**      | Used in schema.org `name` property                                |
| **Short introduction** | Primary meta description (fallback to About Us if empty)          |
| **Address**            | Included in schema.org PostalAddress and visible on Google Maps   |
| **Phone**              | Shown in search results and schema.org telephone property         |
| **Contact email**      | Included in contact page meta tags                                |
| **Coordinates**        | Used for GeoCoordinates schema to improve local search visibility |

<Tip>
  Fill in all location information fields completely. Search engines use this data to show your location in local search results and map listings.
</Tip>

### Page-Specific Settings

Some feature settings affect how individual pages appear in search results:

#### Contact Page

* **Enable enquiry form** — When enabled, search engines see that you offer a contact form
* **Enable tour booking** — Mentions tour booking in contact page SEO content

#### Events

* **Allow ticket cancellation** — Events page mentions free cancellation in search results

#### Blog

* **Allow comments** — Blog page mentions open comments in search results

#### Reservations

* **Allow guest bookings** — Booking pages mention "no membership required"
* **Allow recurring bookings** — Booking pages mention recurring options

#### Sign-Up

* **Google sign-in** / **Facebook sign-in** — Sign-up page mentions social sign-up options

## Navigation Links for Crawlers

Your Members Portal automatically generates navigation links in the pre-rendered content to help search engines discover all your public pages:

### Home Page Navigation

The home page includes an "Explore" section with links to:

* Sign Up (if online sign-up is enabled)
* Book a Tour (if tours are enabled)
* Contact Us (if contact page is enabled)
* Events (if events are enabled)
* Blog (if blog is enabled)
* FAQ (if FAQs are publicly accessible)
* Book (Resource Type) — one link per enabled resource type (meeting rooms, hot desks, private offices, etc.)

### Cross-Links Between Pages

To help crawlers navigate your site, pages include relevant cross-links:

**Contact Page** → Sign Up, Book a Tour, FAQ

**Sign-Up Page** → All bookable resource types, Book a Tour, Contact Us

**Booking Pages** → Sign Up, Book a Tour, Contact Us, Other resource types

This internal linking helps search engines understand your site structure and improves the likelihood that all your pages are indexed.

## FAQ Page Optimization

If you've configured FAQs (**Settings > Features > Website > Access > FAQs**), your FAQ page includes structured data with the `FAQPage` schema type.

<Note>
  FAQ pages only appear in search results if Access is set to **Public**. Other access levels (Logged in users, Members only) prevent search engines from seeing the content.
</Note>

When properly configured, FAQ pages can appear as rich results in Google, showing questions and answers directly in search results.

## Best Practices

### Write for Humans First

While it's important to include relevant keywords, write naturally for your potential customers. Search engines prioritize content that provides value to readers.

### Keep Descriptions Concise

* **Meta title**: 50-60 characters
* **Meta description**: 150-160 characters
* **Home page short introduction**: 140 characters maximum

Longer text will be truncated in search results.

### Use Descriptive Text for Services

Instead of generic text like "We offer workspace," write specific descriptions:

✅ **Good**: "Flexible hot desks in a vibrant open-plan area with high-speed WiFi and unlimited coffee"

❌ **Avoid**: "Workspace available"

### Update Content Regularly

Search engines favor sites with fresh content. Regularly publish:

* Blog articles about your community, industry insights, or space updates
* New events to keep your events page active
* Updates to your About Us section

### Monitor Your Search Presence

Use [Google Search Console](https://search.google.com/search-console) to:

* See which pages are indexed
* Monitor search performance
* Identify and fix crawl errors

## Verifying Your SEO Setup

To verify your SEO configuration is working:

1. **View Source in Browser**\
   Visit your Members Portal in a private browsing window, right-click, and select "View Page Source." Search for `<meta name="description"` to see your meta tags.

2. **Test Rich Results**\
   Use [Google's Rich Results Test](https://search.google.com/test/rich-results) to validate your structured data.

3. **Check Open Graph**\
   Paste your portal URL into [Facebook's Sharing Debugger](https://developers.facebook.com/tools/debug/) to see how your page appears when shared.

## Related Documentation

* [Custom Domain Setup](/operators/portal-configuration/custom-domain-setup) — Use your own domain for better brand recognition
* [Features Configuration](/operators/portal-configuration/features/features-configuration) — Enable or disable features that affect SEO
* [Access Settings](/operators/portal-configuration/access) — Control which pages are publicly accessible


# Widget Embedding
Source: https://learn.nexudus.com/operators/portal-configuration/widget-embedding

Embed the members portal directly into your coworking space's marketing website for seamless customer experience.

## Overview

Widget embedding allows you to integrate specific sections of your members portal directly into your coworking space's marketing website. Instead of redirecting customers to a separate portal domain, they can access booking forms, member directories, or other portal features while staying on your main website.

This creates a seamless experience where customers never leave your brand environment, improving conversion rates and maintaining consistent visual identity throughout their journey.

<Frame>
  <img />
</Frame>

## Purpose

Coworking spaces often maintain separate marketing websites to showcase their brand, location, and services. However, when customers want to book a meeting room or view available desks, they typically need to navigate to a different portal domain, breaking the user experience flow.

Widget embedding solves this by allowing you to:

* **Maintain brand consistency** - Customers stay within your website's design and navigation
* **Reduce friction** - No redirects or separate login processes required
* **Improve conversion** - Streamlined booking flows directly on your marketing pages

## How It Works

The widget system uses an iframe-based architecture with intelligent communication between your website and the embedded portal content. Here's what happens technically:

<Steps>
  <Step title="Widget Script Integration">
    Your marketing website includes a lightweight JavaScript file that handles all iframe communication and dynamic resizing.
  </Step>

  <Step title="Container Definition">
    You place a simple HTML container on your page that specifies which portal section to embed and display preferences.
  </Step>

  <Step title="Automatic Iframe Creation">
    The widget script automatically creates and configures an iframe pointing to your portal, handling security
    permissions for features like geolocation and camera access.
  </Step>

  <Step title="Dynamic Height Management">
    The embedded portal communicates its content height back to your website, automatically resizing the iframe to prevent
    scrollbars and maintain a native feel.
  </Step>

  <Step title="Scroll Synchronization">
    The widget tracks scroll position between your website and the embedded content, ensuring smooth navigation and proper positioning of sticky elements.
  </Step>
</Steps>

## Implementation Process

### Basic Setup

Add the widget script to your website's HTML head section:

```html theme={null}
<script src="https://cdn.nexudus.site/widget/nexudus-widget.min.js"></script>
```

### Embedding Portal Sections

Create a container element where you want the portal to appear:

```html theme={null}
<div
  id="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/bookings/meeting-rooms/list"
  hide-header="true"
></div>
```

You can also use the class name instead of an ID, which allows you to embed multiple widgets on the same page:

```html theme={null}
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/bookings/meeting-rooms/list"
  hide-header="true"
></div>
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/events/list"
  hide-header="true"
  hide-footer="true"
></div>
```

The widget script automatically detects all containers matching either the `nexudus-widget-iframe` ID or class and creates the embedded iframes when the page loads.

### Configuration Options

<ParamField type="string">
  The full URL to the portal section you want to embed. This should point to your location's portal domain and the
  specific page you want to display.
</ParamField>

<ParamField type="string">
  Set to "true" to hide the portal's header navigation, creating a more integrated appearance within your website.
  Defaults to showing the header if omitted.
</ParamField>

<ParamField type="string">
  Set to "true" to hide the portal's footer, creating a more streamlined appearance. Defaults to showing the footer if
  omitted.
</ParamField>

<ParamField type="string">
  Set to "true" to hide the portal's logo, useful when you want to maintain full brand control. Defaults to showing the
  logo if omitted.
</ParamField>

## Styling embedded widgets with URL parameters

When you embed the portal into another website, you can control the embedded look and mode directly from the widget `url` value.

This is useful when you want the embedded experience to match your website branding for a specific campaign, landing page, or partner page.

For full details and all supported parameters, see:

* [URL color overrides](/member-portal/styling/url-color-overrides)
* [URL Parameters Reference](/member-portal/public/url-parameters)

### Example: force dark mode with campaign colors

```html theme={null}
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/nexudus?Theme.ForceDarkMode=true&Theme.PrimaryColorDarkMode=%236092C0&Theme.SecondaryColorDarkMode=%23161616"
  hide-header="true"
  hide-footer="true"
></div>
```

### Example: force light mode for a branded landing page

```html theme={null}
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/nexudus?Theme.ForceLightMode=true&Theme.PrimaryColor=%23D6BF57&Theme.SecondaryColor=%23161616"
  hide-header="true"
></div>
```

<Tip>
  If you use hex colors, encode `#` as `%23` in the URL.
</Tip>

## Core Behavior

### Multiple Widgets on a Single Page

You can embed multiple portal sections on the same page by creating multiple container divs with the `nexudus-widget-iframe` class:

```html theme={null}
<!-- Meeting Rooms Section -->
<h2>Book a Meeting Room</h2>
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/bookings/meeting-rooms/list"
  hide-header="true"
></div>

<!-- Events Section -->
<h2>Upcoming Events</h2>
<div
  class="nexudus-widget-iframe"
  url="https://your-location.nexudus.site/events/list"
  hide-header="true"
  hide-footer="true"
></div>

<!-- Member Directory Section -->
<h2>Our Community</h2>
<div class="nexudus-widget-iframe" url="https://your-location.nexudus.site/directory" hide-header="true"></div>
```

Each widget operates independently with its own iframe, height management, and communication channel. The widget script handles scroll synchronization for all embedded sections simultaneously.

### The `in-iframe` CSS Class

When the portal detects it is running inside an iframe, it automatically adds the `in-iframe` class to the `<html>` element. You can use this in your [custom CSS](/editor/custom-web-injector#targeting-embedded-iframe-mode) (`styles.css`) to apply styles only when the portal is embedded:

```css theme={null}
/* Reduce spacing when embedded in a host page */
html.in-iframe .page-wrapper {
  padding-top: 0;
}
```

The class is added synchronously before the portal renders, so there is no flash of unstyled content.

### Responsive Design

The embedded portal automatically adapts to your website's container width while maintaining its responsive behavior. The iframe adjusts its height dynamically as content changes, such as when filtering booking options or expanding details.

### Navigation Handling

When customers navigate within the embedded portal, the iframe height automatically adjusts to accommodate the new content. The widget also handles scroll-to-top behavior, ensuring customers see new pages from the beginning.

### Permission Management

The widget automatically grants necessary permissions for portal features that require device access:

* **Geolocation** - For location-based features and maps
* **Camera** - For profile photos and document uploads
* **Microphone** - For video calling integrations

### Security Considerations

All communication between your website and the embedded portal happens through secure postMessage APIs. The iframe operates in a sandboxed environment while still allowing necessary functionality.

## Live Example

The following is a live example of a marketing page that embeds the portal booking page without a header or footer. You can also [open the example in a new tab](https://musical-salamander-fcf864.netlify.app).

<iframe title="Widget Embedding Example" />

## Common Integration Patterns

<CardGroup>
  <Card title="Meeting Room Booking" icon="calendar">
    Embed booking forms directly on your "Meeting Rooms" marketing page, allowing visitors to check availability and reserve spaces without leaving your site.
  </Card>

  <Card title="Member Directory" icon="users">
    Display your coworking community directly on your "Community" page, showcasing the vibrant network of professionals at
    your location.
  </Card>

  <Card title="Event Listings" icon="calendar-days">
    Show upcoming events and workshops on your homepage or dedicated events page, with integrated registration
    capabilities.
  </Card>

  <Card title="Desk Availability" icon="desktop">
    Add real-time desk booking to your "Hot Desks" page, letting customers see and reserve available workspace immediately.
  </Card>
</CardGroup>

## Important Considerations

### Content Height Management

The widget continuously monitors content height changes and automatically adjusts the iframe size. This handles dynamic content like expanding forms, loading states, and pagination without requiring manual configuration.

### Cross-Domain Communication

Since the embedded portal runs on your Nexudus domain while being displayed on your marketing website, all interactions use secure cross-domain messaging protocols to maintain functionality.

### Mobile Responsiveness

The embedded portal inherits responsive behavior from both your website's container styling and the portal's internal responsive design. Test across different screen sizes to ensure optimal display.

### Content Security Policy (CSP) Headers

If your website uses Content Security Policy headers, they may block the embedded portal from loading or functioning correctly. CSP headers control which external resources your page is allowed to load, and overly restrictive policies can prevent the iframe from rendering or communicating with your website.

To ensure the widget works correctly, your CSP headers must allow the following:

* **`frame-src`** - Must include your portal domain (e.g. `https://your-location.nexudus.site`) to allow the iframe to load.
* **`script-src`** - Must include `https://cdn.nexudus.site` to allow the widget script to execute.
* **`connect-src`** - Must include your portal domain to allow cross-domain communication between the widget and the embedded portal.

For example, if your existing CSP header looks like this:

```
Content-Security-Policy: frame-src 'self'; script-src 'self';
```

You would need to update it to:

```
Content-Security-Policy: frame-src 'self' https://your-location.nexudus.site; script-src 'self' https://cdn.nexudus.site; connect-src 'self' https://your-location.nexudus.site;
```

<Warning>
  If the embedded portal appears as a blank space or your browser console shows "Refused to frame" errors, your CSP headers are likely blocking the iframe. Check your hosting platform's security settings or ask your web developer to update the CSP policy.
</Warning>

### SEO Implications

Content within the iframe is not directly indexable by search engines as part of your main website. Consider this when planning which sections to embed versus link to directly.

### Performance Impact

Each embedded widget adds an additional HTTP request and iframe to your page. Consider the performance trade-offs, especially if embedding multiple portal sections on a single page.

<Warning>
  Always test embedded widgets thoroughly across different devices and browsers, particularly for critical booking flows
  that directly impact your revenue.
</Warning>

## Troubleshooting

### Widget Not Appearing

* Verify the widget script loads successfully from the CDN
* Check that the container element uses either the `nexudus-widget-iframe` ID or class
* Ensure the URL attribute points to a valid portal page
* Check your browser console for CSP-related errors (messages containing "Refused to frame" or "Blocked by Content-Security-Policy") and update your CSP headers accordingly

### Height Issues

* The widget automatically manages height, but complex layouts might need additional CSS styling on your container
* Check browser console for any cross-domain communication errors

### Mobile Display Problems

* Ensure your website's viewport meta tag includes appropriate scaling settings:
  ```html theme={null}
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  ```
* Check that your container element has adequate padding and doesn't constrain the iframe width
* Test on actual mobile devices, not just browser emulation, as iframe behavior can differ
* Verify touch events and gestures work correctly within the embedded portal
* Consider adding CSS media queries to adjust container sizing for smaller screens


# ACT365
Source: https://learn.nexudus.com/platform/access-control/integrations/act365

Connect Nexudus with ACT365's cloud-based access control system to automate door access based on plans, passes, bookings, and desk assignments

# ACT365 Access Control Integration

## Overview

ACT365 is a cloud-based access control platform that enables flexible, secure physical access management. The Nexudus integration with ACT365 automates credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **Cloud-based management**: Manage access from anywhere through ACT365's web platform
* **Mobile access**: Customers can use the Nexudus Passport app to unlock doors remotely
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Check-in tracking**: Optionally use door events to check customers in/out
* **RFID card support**: Up to 4 RFID cards per customer for physical access
* **Group-based permissions**: Map your inventory (passes, resources, desks) to ACT365 cardholder groups
* **Booking-based temporary access**: Automatic access during reservation windows

### Integration Type

**Cloud-based** — ACT365 operates entirely in the cloud with no on-premises server requirements.

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                      |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                |
| **Visitor access**         | ❌ No       | Not supported by this integration                                          |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ✅ Yes      | Door events trigger automatic check-ins                                    |
| **Mobile app access**      | ✅ Yes      | Nexudus Passport app integration                                           |
| **Remote door unlock**     | ✅ Yes      | Customers can unlock doors without being physically present                |

## How It Works

### Access Control Model

ACT365 uses a **cardholder group** model to manage access permissions:

* **Cardholders** represent individuals in the system (mapped to Nexudus customers)
* **Cardholder Groups** define collections of doors that cardholders can access
* **Sites** organize door controllers within your ACT365 account
* **Door Controllers** manage individual doors or access points

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their cardholder record in ACT365 with the appropriate group memberships.

### Multi-Door Support

ACT365 uses **cardholder groups** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In ACT365, create a cardholder group (e.g., "Coworking Space Access")
2. Add the relevant doors to that group in ACT365
3. In Nexudus, map your pass/resource/desk to that group
4. Customers with that pass automatically get access to all doors in the group

<Note>
  You must configure which doors belong to each group in the ACT365 platform. Nexudus assigns customers to groups, but the door-to-group mapping is managed in ACT365.
</Note>

## Prerequisites

Before connecting Nexudus to ACT365, ensure you have:

1. **Active ACT365 account** with administrator access
2. **API credentials** obtained from ACT365 (username and password for API authentication)
3. **ACT365 site configured** with door controllers installed and online
4. **Cardholder groups created** in ACT365 for different access levels (e.g., 24/7 access, business hours only)
5. **Nexudus location configured** with plans, passes, and resources

## Configuration

### Step 1: Connect to ACT365

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **ACT365** in the list and expand the settings
3. Enable the **Enable ACT365 integration** toggle
4. Enter your connection details:
   * **Username**: Your ACT365 API username
   * **Password**: Your ACT365 API password
5. Click **Save** to establish the connection
6. Once connected, select your **ACT365 site** from the dropdown menu that appears
7. The configuration panels will load, showing your door controllers, cardholder groups, passes, resources, and desks

<Note>
  The site dropdown will show all sites available in your ACT365 account. Once you select a site, Nexudus will load the door controllers, cardholder groups, and other configuration options for that specific site. If your ACT365 account manages multiple sites, cardholders will be assigned to "All sites" (Site ID 0) automatically. For single-site accounts, cardholders are assigned to your selected site.
</Note>

### Step 2: Configure Presence Tracking (Optional)

ACT365 can trigger automatic check-ins when customers unlock specific doors.

1. In the **Door Controllers** section, you'll see all doors from your ACT365 site
2. For each door, choose an action:
   * **Nothing**: Door access is tracked in ACT365 but doesn't affect Nexudus
   * **Check In**: Unlocking this door checks the customer in
   * **Check Out**: Unlocking this door checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance to **Check In**
* Set the exit door to **Check Out**
* Set internal doors to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires event processing. Nexudus syncs door events every 12 minutes and triggers the appropriate check-in action based on your configuration.
</Note>

### Step 3: Map Passes to Cardholder Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to an ACT365 cardholder group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the ACT365 **Cardholder Group** that customers should be assigned to when they hold that pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to an ACT365 group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | ACT365 Group   | Purpose                            |
| ------------------- | -------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members   | Round-the-clock building access    |
| Business Hours Pass | Business Hours | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms  | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to cardholder groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to cardholder groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated ACT365 access
</Warning>

### Step 4: Map Resources to Cardholder Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select the ACT365 **Cardholder Group** required to access that space
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | ACT365 Group    | Purpose                            |
| ----------------- | --------------- | ---------------------------------- |
| Conference Room A | Meeting Room A  | Access to specific meeting room    |
| Event Space       | Event Hall      | Access to event space for bookings |
| Private Office    | Private Offices | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 5: Map Desks/Units to Cardholder Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select the ACT365 **Cardholder Group** required to access that area
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | ACT365 Group           | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant ACT365 access.
</Warning>

### Step 6: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants ACT365 access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding ACT365 groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped ACT365 group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration

### When Access is Revoked

Nexudus automatically revokes ACT365 access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding ACT365 groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped ACT365 group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all ACT365 access removed
6. **Check-in expires**: If customer checks out or check-in expires, certain temporary access may be revoked

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Event processing**: Door events are synced every 12 minutes for check-in tracking

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## Mobile App Experience

Customers can use the **Nexudus Passport** mobile app to unlock doors remotely.

### Setup for Customers

1. Customer downloads the **Nexudus Passport** app (iOS or Android)
2. Signs in with their Nexudus credentials
3. App detects ACT365 integration is active
4. Customer can view available doors and unlock them remotely

### Using Mobile Access

1. Customer opens the Nexudus Passport app
2. Navigates to **Unlock Doors** section
3. Views list of doors they currently have access to
4. Taps **Unlock** to remotely unlock a door

### RFID Card Management

ACT365 supports traditional RFID access cards alongside mobile access. To assign cards:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678` (up to 4 cards)
5. Save the customer profile

**Card behavior:**

* **No card**: Cardholder is disabled in ACT365 (mobile-only access)
* **Card assigned**: Cardholder is enabled for both physical and mobile access
* **Card removed**: Cardholder is disabled again (reverts to mobile-only)

<Note>
  Only numeric card IDs are supported. Non-numeric cards are automatically filtered out.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any ACT365 cardholder groups
       * **Solution**: Go to Settings > Integrations > ACT365 and map the relevant passes to cardholder groups

    2. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    3. **Cardholder not created**: The customer wasn't created in ACT365
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    4. **Access group permissions**: The ACT365 cardholder group exists but isn't assigned to any doors
       * **Solution**: In ACT365, verify the cardholder group includes the correct door controllers

    5. **Card not assigned**: Customer exists in ACT365 but is disabled (no RFID card)
       * **Solution**: Assign an RFID card in the customer's Access Card ID field, or ensure mobile access is working
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to an ACT365 cardholder group
       * **Solution**: Map the resource to a cardholder group in Settings > Integrations > ACT365

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state
  </Accordion>

  <Accordion title="Mobile app showing no doors available">
    **Possible causes:**

    1. **No active access**: Customer doesn't have any passes or bookings that grant access
       * **Solution**: Verify customer has an active pass or upcoming booking mapped to ACT365 groups

    2. **Cardholder disabled**: Customer has no RFID card assigned and cardholder is disabled
       * **Solution**: Assign a dummy RFID card or contact ACT365 support about enabling cardholders without physical cards

    3. **App not refreshed**: Door list hasn't updated after access was granted
       * **Solution**: Customer should pull down to refresh the door list in the app
  </Accordion>

  <Accordion title="Check-ins not created from door events">
    **Possible causes:**

    1. **Door action not configured**: Door controller is set to "Nothing" instead of a check-in action
       * **Solution**: Configure the door controller action in Settings > Integrations > ACT365

    2. **Event processing disabled**: Setting `ACT365.DoNotProcessEvents` is enabled
       * **Solution**: Ensure this setting is disabled in your business settings

    3. **Sync delay**: Background task runs every 12 minutes
       * **Solution**: Wait up to 12 minutes for the next event sync cycle
  </Accordion>

  <Accordion title="Integration connection failing">
    **Cause:** Your ACT365 API credentials have expired or are incorrect.

    **Solution:**

    1. Verify your username and password in the ACT365 admin portal
    2. Reconnect the integration with updated credentials
    3. Check that your ACT365 account has API access enabled
    4. Contact ACT365 support if credentials are correct but connection fails
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Expired credentials or invalid API tokens
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid cardholder group mappings
* **Synchronization problems**: Delays or failures in updating access permissions

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with ACT365

When provisioning access, Nexudus shares the following information with ACT365:

* **Customer data**: First name, last name, email address, mobile phone
* **External ID**: Nexudus customer ID (used to link records between systems)
* **RFID cards**: Card IDs from the Access Card ID field

Nexudus **does not** share:

* Billing information
* Payment details
* Contract specifics (only cardholder group assignments)
* Personal notes or custom fields

### Credential Management

* **Physical cards**: Managed entirely in ACT365; Nexudus only assigns cardholder groups
* **Mobile credentials**: Nexudus triggers unlock commands but doesn't handle credentials
* **User passwords**: Never shared with Nexudus; authentication to ACT365 is handled by ACT365

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Cardholder Group Organization

Create cardholder groups based on access levels, not products or plans:

* ✅ **Good**: "24/7 Access", "Business Hours", "Meeting Rooms", "Private Offices"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URL**: `https://userapi.act365.eu/api/`
  * **Authentication**: Resource Owner Password Credentials (username/password)
  * **Token endpoint**: `https://userapi.act365.eu/api/account/login`
  * **Token type**: Bearer token (stored in session)
  * **Rate limiting**: 30 requests per minute per username (semaphore-based across multiple servers)

  ### Key Endpoints

  * **Cardholders**: `/api/cardholder` (GET, POST, PUT, DELETE)
  * **Cardholder Groups**: `/api/cardholdergroup`
  * **Doors**: `/api/door`
  * **Door Groups**: `/api/doorgroup`
  * **Sites**: `/api/sites`
  * **Access Events**: `/api/logeventsofcategory?category=7&fromafter={date}&maxlimit=100`
  * **Doors for Cardholder**: `/api/doorsofcardholder?cardholderid={id}`
  * **Remote Unlock**: `POST /api/door` with `{Door: "{doorId}", Command: "Pass"}`

  ### Synchronization

  * **Access updates**: Debounced by 5 seconds per customer to batch rapid changes
  * **Background task**: Polls door events every 12 minutes for check-in tracking
  * **Event query**: Uses `category=7` for access events, queries from `lastEventDate + 1 second`
  * **Event limit**: Maximum 100 events per request
  * **Distributed locking**: Prevents race conditions in multi-server deployments
  * **User provisioning**: Lazy creation on first inventory assignment
  * **Cardholder updates**: Created/updated/deleted as inventory changes
  * **Access signature hashing**: Prevents unnecessary API calls when access hasn't changed

  ### Site Assignment

  * **Multi-site accounts**: Cardholders assigned to "All sites" (Site ID 0)
  * **Single-site accounts**: Cardholders assigned to configured Site ID
  * **Site ID setting**: `Act365.SiteId` business setting

  ### External IDs

  * **Customers**: `ExternalID` set to Nexudus coworker ID (integer)
  * **Visitors**: `ExternalID` set to `NEXVIS-{visitorId}`
  * **Lookup**: Cardholders retrieved via `/api/cardholder?externalid={coworkerId}`

  ### Cardholder Model

  ```json theme={null}
  {
    "CardHolderID": 12345,
    "ExternalID": "67890",
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john@example.com",
    "MobileNumber": "+1234567890",
    "CardholderGroups": [1, 2, 3],
    "Cards": ["123456", "789012"],
    "SiteId": 0,
    "Active": true
  }
  ```

  ### RFID Card Management

  * **Card ID field**: Comma-separated numeric IDs in `AccessCardID` field (up to 4 cards)
  * **Non-numeric cards**: Automatically filtered out
  * **No cards**: Cardholder disabled in ACT365 (mobile-only access via Nexudus Passport app)
  * **Card assignment**: Cardholder enabled for both physical and mobile access

  ### Business Settings Reference

  | Setting                                | Purpose                                                    |
  | -------------------------------------- | ---------------------------------------------------------- |
  | `Act365.Enable`                        | Integration enabled flag ("true"/"false")                  |
  | `Act365.Username`                      | ACT365 API username for authentication                     |
  | `Act365.Password`                      | ACT365 API password for authentication                     |
  | `Act365.SiteId`                        | Site ID for cardholder assignment                          |
  | `ACT365.DoNotProcessEvents`            | Disable event processing ("true"/"false")                  |
  | `ACT365.LastEventDate`                 | Last processed event timestamp (ISO 8601)                  |
  | `ACT365.Controller.Id_{doorId}.Action` | Check-in action per door (Nothing/CheckIn/CheckOut/Toggle) |

  ### Contract-Based Desk Access

  * Desk access determined by active contracts: `coworker.ActiveContracts().SelectMany(x => x.Desks)`
  * **Team billing support**: Customer receives access to desks in paying member's contracts
  * **Multi-site organizations**: Access groups managed per site
  * **Desk mapping**: Each desk mapped to comma-separated cardholder group IDs

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Cardholder groups**: Aggregated list of unique group IDs
  7. **Cardholder provisioning**: Create/update cardholder with aggregated groups
  8. **Card status**: Enable if cards exist, disable if no cards (mobile-only)

  ### Event Processing

  * **Event category**: `7` for access granted events
  * **Event date format**: `dd/MM/yyyy HH:mm` (e.g., "25/12/2024 14:30")
  * **Event retention**: Events processed from `lastEventDate`, limited to last 24 hours if gap > 1 day
  * **Pagination**: Results returned in batches of 100
  * **Check-in trigger**: Only "Open" actions with matching door controller configuration

  ### Error Handling

  * **Authentication failures**: Stored in business log entries
  * **Provisioning errors**: Automatic retry with exponential backoff
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Distributed locks**: Prevent concurrent updates to same customer
</Accordion>


# Avigilon
Source: https://learn.nexudus.com/platform/access-control/integrations/avigilon

Connect Nexudus with Avigilon's on-premises access control system to automate door access based on plans, passes, bookings, and desk assignments

# Avigilon Access Control Integration

## Overview

Avigilon is an enterprise-grade access control platform that provides physical security management through on-premises hardware and software. The Nexudus integration with Avigilon automates credential provisioning and role assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **On-premises management**: Dedicated hardware appliance installed at your location
* **LDAP-based architecture**: Enterprise-grade directory services for identity management
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **RFID card support**: Multiple RFID cards per customer with PIN code support
* **Role-based permissions**: Map your inventory (passes, resources, desks) to Avigilon roles
* **Booking-based temporary access**: Automatic access during reservation windows

### Integration Type

**On-premises** — Avigilon requires a dedicated access control appliance installed at your location. The system is accessed via its local network IP address.

### Capabilities

| Feature                    | Supported  | Notes                                                                                                        |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------ |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                                                        |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                                                           |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                                                  |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                                                  |
| **Visitor access**         | ❌ No       | Not supported by this integration                                                                            |
| **Booking guest access**   | ❌ No       | Customers added as booking guests cannot access spaces during booking windows. Only main booking holder can. |
| **Check-in tracking**      | ❌ No       | Door events are not processed for automatic check-ins                                                        |
| **Mobile app access**      | ❌ No       | No mobile app integration available                                                                          |
| **Remote door unlock**     | ❌ No       | Physical cards/PIN codes required for access                                                                 |

## How It Works

### Access Control Model

Avigilon uses a **role-based** model to manage access permissions:

* **Identities** represent individuals in the system (mapped to Nexudus customers)
* **Roles** define collections of doors that identities can access
* **Tokens** are physical RFID cards assigned to identities
* **Doors** are individual access points managed by door controllers

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their identity record in Avigilon with the appropriate role memberships.

### Multi-Door Support

Avigilon uses **roles** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Avigilon, create a role (e.g., "Coworking Space Access")
2. Add the relevant doors to that role in Avigilon
3. In Nexudus, select that role from the dropdown when mapping your pass/resource/desk
4. Customers with that pass automatically get access to all doors in the role

<Note>
  You must configure which doors belong to each role in the Avigilon system. Nexudus assigns customers to roles by selecting from the available roles retrieved from your Avigilon system. The door-to-role mapping is managed in Avigilon.
</Note>

## Prerequisites

Before connecting Nexudus to Avigilon, ensure you have:

1. **Avigilon access control system** installed and operational at your location
2. **Network access** to the Avigilon appliance from Nexudus servers (see connectivity options below)
3. **API credentials** with administrative permissions
4. **IP address** of the Avigilon appliance
5. **Avigilon system configured** with door controllers installed and online
6. **Roles created** in Avigilon for different access levels (e.g., 24/7 access, business hours only)
7. **Nexudus location configured** with plans, passes, and resources

### Network Connectivity Options

Since Avigilon is an on-premises system, you have two options for network connectivity:

**Option 1: Direct Connection (Firewall Configuration)**

* Configure your firewall to allow incoming HTTPS connections from Nexudus IP addresses
* Set up a static IP or internal DNS for your Avigilon appliance
* Ensure valid SSL certificates (self-signed certificates are accepted but not recommended for production)

**Option 2: Nexudus Network Bridge (Recommended for restricted networks)**

If you cannot open firewall ports to allow Nexudus servers to reach your local network, use the **Nexudus Network Bridge**:

* A lightweight application runs on your local network
* Creates an outbound connection to Nexudus (no inbound ports required)
* Securely proxies API requests between Nexudus and your Avigilon appliance
* See [Network Bridge documentation](/integrations/network-bridge) for setup instructions

<Note>
  The Network Bridge is the recommended approach for organizations with strict firewall policies or those who prefer not to expose on-premises systems directly to the internet.
</Note>

## Configuration

### Step 1: Enable and Connect to Avigilon

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Avigilon** in the list and expand the settings
3. Enable the **Enable Avigilon integration** toggle
4. Enter your connection details (fields appear when toggle is enabled):
   * **IP Address**: The IP address or hostname of your Avigilon appliance
     * Direct connection: `192.168.1.100` or `avigilon.yourcompany.local`
     * Network Bridge: Use the bridge hostname (see [Network Bridge setup](/integrations/network-bridge))
   * **Username**: Your Avigilon administrator username
   * **Password**: Your Avigilon administrator password
5. Click **Save** to establish the connection
6. Once connected successfully, the configuration panels for passes, resources, and desks will load below

<Note>
  If using the Network Bridge, ensure the bridge application is running and connected before saving your Avigilon settings in Nexudus.
</Note>

### Step 2: Map Passes to Roles

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to an Avigilon role.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select an **Avigilon access group** from the dropdown menu
   * The dropdown shows all roles available in your connected Avigilon system
   * Roles are automatically retrieved when you save the connection settings
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to an Avigilon role, the customer is added to that role
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Avigilon Role | Purpose                            |
| ------------------- | ------------- | ---------------------------------- |
| 24/7 Access Pass    | 247Members    | Round-the-clock building access    |
| Business Hours Pass | BusinessHours | Access only during operating hours |
| Meeting Room Pass   | MeetingRooms  | Access to meeting room zones       |

<Note>
  Roles are automatically retrieved from your Avigilon system. If you don't see a role in the dropdown, verify it exists in Avigilon and re-save your connection settings to refresh the list.
</Note>

<Warning>
  Plans are **not** directly mapped to roles. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to roles (selected from dropdown)
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Avigilon access
</Warning>

### Step 3: Map Resources to Roles

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select an **Avigilon access group** from the dropdown menu
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Avigilon Role  | Purpose                            |
| ----------------- | -------------- | ---------------------------------- |
| Conference Room A | ConfRoomA      | Access to specific meeting room    |
| Event Space       | EventHall      | Access to event space for bookings |
| Private Office    | PrivateOffices | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 4: Map Desks/Units to Roles

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select an **Avigilon access group** from the dropdown menu
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped role
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Avigilon Role | Purpose                                   |
| --------------------- | ------------- | ----------------------------------------- |
| Private Office #101   | PrivateFloor1 | Access to first-floor private office area |
| Dedicated Desk Zone A | DeskZoneA     | Access to dedicated desk zone A           |
| Studio #5             | StudioAccess  | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Avigilon access.
</Warning>

### Step 5: Save Configuration

1. Review all mappings to ensure they're correct
2. Verify role names match exactly with your Avigilon system (case-sensitive)
3. Click **Save** to apply the configuration
4. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Avigilon access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Avigilon roles
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Avigilon role
3. **Booking created**: Customer books a resource → granted access to resource's role 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped role
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's role for the booking duration

### When Access is Revoked

Nexudus automatically revokes Avigilon access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Avigilon roles
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Avigilon role
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's role is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's role is revoked
5. **Customer deactivated**: Customer account is deactivated → all Avigilon access removed

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## RFID Card Management

Avigilon supports traditional RFID access cards with optional PIN code support. To assign cards to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678`
5. Optionally, set a PIN code in the **Access PIN Code** field
6. Save the customer profile

**Card behavior:**

* **No card**: Identity exists in Avigilon but cannot unlock doors (no physical credentials)
* **Card assigned**: Customer can use physical RFID card to unlock doors
* **PIN code set**: Customer can use card + PIN for enhanced security
* **Card removed**: Physical access is revoked (identity remains in system)

**Card numbering:**

* Cards use both **internal number** and **embossed number** fields (Nexudus sets both to the same value)
* Card IDs should match the format expected by your Avigilon system
* Cards are assigned validity dates: Active from 2000-01-01 to 2500-01-01 (effectively permanent)

<Note>
  Unlike cloud-based systems, Avigilon does **not** support mobile access. Customers must use physical RFID cards or PIN codes to unlock doors.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Avigilon roles
       * **Solution**: Go to Settings > Integrations > Avigilon and select a role for the relevant passes

    2. **Role no longer exists**: The selected role was deleted from Avigilon
       * **Solution**: Select a different role or recreate the role in Avigilon, then refresh the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **Identity not created**: The customer wasn't created in Avigilon
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Role permissions**: The Avigilon role exists but isn't assigned to any doors
       * **Solution**: In Avigilon, verify the role includes the correct door controllers

    6. **No card assigned**: Customer exists in Avigilon but has no physical credentials
       * **Solution**: Assign an RFID card in the customer's Access Card ID field

    7. **Network connectivity**: Nexudus cannot reach your Avigilon appliance
       * **Solution**: Check firewall rules and verify the IP address is correct
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to an Avigilon role
       * **Solution**: Select a role for the resource in Settings > Integrations > Avigilon

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **No card assigned**: Customer has no physical card to use
       * **Solution**: Assign an RFID card to the customer's profile
  </Accordion>

  <Accordion title="RFID cards not working">
    **Possible causes:**

    1. **Card format**: Card IDs don't match the format expected by your Avigilon system
       * **Solution**: Check your Avigilon system documentation for the correct card ID format

    2. **Card not synced**: Recent card changes haven't been synced to Avigilon
       * **Solution**: Wait a few minutes for sync, or manually trigger by editing and saving the customer profile

    3. **Identity inactive**: Customer's identity is marked as inactive in Avigilon
       * **Solution**: Verify customer has active passes/contracts that grant access

    4. **Card reader issue**: Physical hardware problem
       * **Solution**: Test cards on different readers to isolate hardware issues
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Incorrect IP address**: The Avigilon appliance IP has changed or is incorrect
       * **Solution**: Verify the correct IP address and update in Settings > Integrations > Avigilon

    2. **Network connectivity**: Firewall blocking HTTPS connections
       * **Solution**: Configure firewall to allow HTTPS from Nexudus servers to your Avigilon appliance, or use the [Network Bridge](/integrations/network-bridge) instead

    3. **Network Bridge not running**: If using the bridge, it may not be running or connected
       * **Solution**: Verify the Network Bridge application is running and connected (check bridge status dashboard)

    4. **Invalid credentials**: Username or password is incorrect
       * **Solution**: Verify credentials have administrative access in Avigilon

    5. **SSL certificate issues**: Certificate validation failing
       * **Solution**: Ensure Avigilon has a valid SSL certificate, or contact support if using self-signed certificates

    6. **Appliance offline**: Avigilon system is powered off or unreachable
       * **Solution**: Verify Avigilon appliance is online and accessible on your network
  </Accordion>

  <Accordion title="Role assignments not updating">
    **Possible causes:**

    1. **Role deleted**: Role was selected but has since been deleted from Avigilon
       * **Solution**: Recreate the role in Avigilon or select a different role in Nexudus

    2. **Stale role list**: Available roles not refreshed after changes in Avigilon
       * **Solution**: Re-save your connection settings to refresh the role list from Avigilon

    3. **API permissions**: Avigilon user doesn't have permission to modify roles
       * **Solution**: Ensure the API user has administrative permissions in Avigilon

    4. **Background job delay**: Updates are queued but not yet processed
       * **Solution**: Wait a few minutes for background jobs to process
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid credentials or connection errors
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid role mappings
* **Network connectivity**: Connection timeouts or unreachable appliance

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Avigilon

When provisioning access, Nexudus shares the following information with Avigilon:

* **Customer data**: First name, last name
* **External ID**: Nexudus customer ID (used to link records between systems)
* **RFID cards**: Card IDs from the Access Card ID field
* **PIN codes**: Optional PIN codes from the Access PIN Code field

Nexudus **does not** share:

* Email addresses
* Phone numbers
* Billing information
* Payment details
* Contract specifics (only role assignments)
* Personal notes or custom fields

### Network Security

* **HTTPS encryption**: All communication uses HTTPS (SSL/TLS)
* **Basic authentication**: Username and password sent with each request (over HTTPS)
* **On-premises control**: Your Avigilon system remains on your local network
* **Firewall protection**: Configure firewall rules to restrict access to authorized IP addresses only

<Warning>
  Because Avigilon is an on-premises system, you must configure your firewall to allow incoming HTTPS connections from Nexudus servers. Ensure you restrict access to Nexudus IP addresses only to maintain security.
</Warning>

### Credential Management

* **Physical cards**: Managed in both Nexudus and Avigilon; always assign through Nexudus
* \*Network Bridge Setup]\(/integrations/network-bridge) - For on-premises connectivity without opening firewall ports
* \[*PIN codes*\*: Stored in Nexudus and synced to Avigilon
* **User passwords**: Never shared with Nexudus; authentication is handled by Avigilon

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Role Organization

Create roles in Avigilon based on access levels, not products or plans:

* ✅ **Good**: "247Access", "BusinessHours", "MeetingRooms", "PrivateOffices"
* ❌ **Avoid**: "HotDeskPlan", "DedicatedDeskPlan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Naming Conventions

* Create descriptive role names in Avigilon that make them easy to identify in the dropdown
* Avoid overly long role names that are difficult to read in the admin panel
* Document role-to-door mappings in Avigilon for future reference

### Card Management

* Assign unique card IDs to each customer
* Keep spare cards for emergencies
* Use PIN codes for enhanced security on sensitive areas
* Regularly audit card assignments and deactivate unused cards
  **Direct Connection:**
* Place Avigilon appliance on a secure network segment
* Use firewall rules to restrict access to Nexudus IP addresses only
* Maintain separate admin credentials for Nexudus integration vs. manual administration

**Network Bridge (Recommended):**

* Install Network Bridge on a server within your local network
* No inbound firewall ports required (bridge initiates outbound connection)
* Bridge encrypts all communication between Nexudus and your Avigilon appliance
* See [Network Bridge documentation](/integrations/network-bridge) for security details
* Use firewall rules to restrict access to Nexudus IP addresses only
* Consider VPN for additional security if Avigilon is on internal network
* Maintain separate admin credentials for Nexudus integration vs. manual administration

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Protocol**: HTTPS with XML-based API
  * **Authentication**: HTTP Basic Authentication (username/password)
  * **API Format**: XML (using ServiceStack XmlServiceClient)
  * **Base URL**: `https://{ip_address}/`
  * **Certificate validation**: Accepts self-signed certificates (ServerCertificateValidationCallback returns true)

  ### LDAP Structure

  Avigilon uses LDAP (Lightweight Directory Access Protocol) for identity management:

  * **Distinguished Names (DN)**: Format `cn={id},ou=identities,dc=plasec`
  * **Roles**: Format `cn={id},ou=roles,dc=plasec`
  * **External IDs**: Custom LDAP attribute `plasecId` stores Nexudus customer ID

  ### Key Endpoints

  * **Identities (Users)**:
    * GET `/identities.xml?adv_search_exec_search=true&adv_search_field_0=plasecId&adv_search_val_0={id}&adv_search_and_or=%26&adv_search_cnt=0` - Find identity by external ID
    * POST `/identities.xml` - Create new identity
    * PUT `/identities/{id}.xml` - Update identity
    * PUT `/identities/{id}/update_roles.xml` - Update role assignments

  * **Roles (Access Groups)**:
    * GET `/roles.xml` - List all roles
    * POST `/roles.xml` - Create new role

  * **Doors**:
    * GET `/doors.xml` - List all doors

  * **Tokens (Cards)**:
    * GET `/identities/{id}/tokens.xml` - List tokens for identity
    * POST `/identities/{id}/tokens.xml` - Create new token
    * DELETE `/identities/{id}/tokens/{tokenId}.xml` - Delete token

  ### Identity Model

  ```xml theme={null}
  <identity>
    <plasecId>12345</plasecId>
    <dn>cn=user123,ou=identities,dc=plasec</dn>
    <plasecName>John Doe</plasecName>
    <plasecFname>John</plasecFname>
    <plasecLname>Doe</plasecLname>
    <plasecIdstatus>1</plasecIdstatus>
  </identity>
  ```

  **Status values:**

  * `1`: Active - identity can access doors
  * `2`: Inactive - identity exists but cannot access doors

  ### Token (Card) Model

  ```xml theme={null}
  <token>
    <dn>cn=token123,ou=tokens,dc=plasec</dn>
    <plasecInternalnumber>123456</plasecInternalnumber>
    <plasecEmbossednumber>123456</plasecEmbossednumber>
    <plasecPIN>1234</plasecPIN>
    <plasecTokenstatus>1</plasecTokenstatus>
    <plasecDownload>TRUE</plasecDownload>
    <plasecActivatedate>20000101000000+0100</plasecActivatedate>
    <plasecDeactivatedate>25000101000000+0100</plasecDeactivatedate>
  </token>
  ```

  **Token properties:**

  * **InternalNumber**: Primary card identifier
  * **EmbossedNumber**: Printed number on card (Nexudus sets same as internal)
  * **PIN**: Optional PIN code
  * **Status**: `1` = active, `2` = inactive
  * **Download**: `TRUE` enables card for use
  * **Dates**: Format `YYYYMMDDhhmmss+timezone` (default: 2000-2500 for permanent cards)

  ### Role Assignment Model

  ```xml theme={null}
  <sel_members type="array">
    <sel_member>cn=Role1,ou=roles,dc=plasec</sel_member>
    <sel_member>cn=Role2,ou=roles,dc=plasec</sel_member>
  </sel_members>
  ```

  ### Business Settings Reference

  | Setting                                  | Purpose                                                                              |
  | ---------------------------------------- | ------------------------------------------------------------------------------------ |
  | `Avigilon.Enabled`                       | Integration enabled flag ("true"/"false")                                            |
  | `Avigilon.IpAddress`                     | IP address or hostname of Avigilon appliance                                         |
  | `Avigilon.Username`                      | Administrator username for API authentication                                        |
  | `Avigilon.Password`                      | Administrator password for API authentication                                        |
  | `Avigilon.Controller.Id_{doorId}.Action` | Check-in action per door (Nothing/CheckIn/CheckOut/Toggle) - currently not processed |

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Roles**: Aggregated list of unique role names
  7. **Identity provisioning**: Create/update identity with aggregated roles
  8. **Card management**: Create/update/delete tokens based on AccessCardID field
  9. **Status**: Active (status=1) if customer has any roles, Inactive (status=2) if no roles

  ### External IDs

  * **Customers**: `plasecId` set to Nexudus coworker ID (integer as string)
  * **Lookup**: Identities retrieved via advanced search on `plasecId` field
  * **Uniqueness**: ExternalSystemId ensures no duplicate identities

  ### Error Handling

  * **Nil-classes error**: Returned when no results found, handled as empty list
  * **Authentication failures**: Logged to business log entries
  * **Provisioning errors**: Automatic retry with distributed locking
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Event system**: OnExceptionHandler raises AccessControlEventData for error tracking

  ### Card Management Logic

  * **Multiple cards**: Comma-separated list in AccessCardID field
  * **Card sync**: Existing tokens compared with current AccessCardID, unused tokens deleted
  * **No cards**: If AccessCardID is empty, all tokens are removed
  * **Token creation**: Each card gets separate token with same internal/embossed number
  * **PIN code**: Synced from AccessPincode field to token.Pin

  ### Performance Optimization

  * **Debouncing**: 5-second debounce prevents rapid repeated updates for same customer

  **Direct Connection:**

  * **Firewall rules**: Allow HTTPS (443) from Nexudus servers to Avigilon appliance
  * **SSL/TLS**: HTTPS required (self-signed certificates accepted)
  * **IP addressing**: Static IP or DNS hostname recommended
  * **Latency**: Low latency recommended for responsive access updates

  **Network Bridge:**

  * **Outbound connection**: Bridge initiates HTTPS connection to Nexudus (no inbound ports)
  * **Local network access**: Bridge requires access to Avigilon appliance on local network
  * **Bridge requirements**: See [Network Bridge documentation](/integrations/network-bridge) for full requirement

  ### Network Requirements

  * **Firewall rules**: Allow HTTPS (443) from Nexudus servers to Avigilon appliance
  * **SSL/TLS**: HTTPS required (self-signed certificates accepted)
  * **IP addressing**: Static IP or DNS hostname recommended
  * **Latency**: Low latency recommended for responsive access updates
</Accordion>


# Avigilon Alta / OpenPath
Source: https://learn.nexudus.com/platform/access-control/integrations/avigilon-alta

Connect Nexudus with OpenPath's cloud-based access control system to automate door access based on plans, passes, bookings, and desk assignments

# OpenPath (Avigilon Alta) Access Control Integration

## Overview

OpenPath (now Avigilon Alta) is a cloud-based access control platform that enables flexible, secure physical access management without the need for on-premises servers. The Nexudus integration with OpenPath automates credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

<Note>
  OpenPath and Avigilon Alta refer to the same platform. The product was rebranded to Avigilon Alta but may still appear as "OpenPath" in some places within Nexudus.
</Note>

### Key Features

* **Cloud-based management**: Manage access from anywhere through OpenPath's web platform
* **Mobile access**: Customers can use the Nexudus Passport app with mobile credentials
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Check-in tracking**: Optionally use reader events to check customers in/out
* **Multiple card types**: Support for MIFARE CSN, DESFire encrypted cards, and custom card formats
* **Group-based permissions**: Map your inventory (passes, resources, desks) to OpenPath groups
* **Booking-based temporary access**: Automatic access during reservation windows
* **Visitor cloud keys**: Generate time-limited access links for visitors and guests
* **Remote unlock**: Allow customers to unlock doors remotely through the mobile app
* **Multi-region support**: Available in US and EU data centers

### Integration Type

**Cloud-based** — OpenPath operates entirely in the cloud with no on-premises server requirements.

### Capabilities

| Feature                    | Supported  | Notes                                                                                 |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                                 |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                                    |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                           |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                           |
| **Visitor access**         | ✅ Yes      | Cloud key links with time-limited access                                              |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests receive access based on booking resource and timing |
| **Check-in tracking**      | ✅ Yes      | Reader events trigger automatic check-ins                                             |
| **Mobile app access**      | ✅ Yes      | Nexudus Passport app integration with mobile credentials                              |
| **Remote door unlock**     | ✅ Yes      | Customers can unlock doors without being physically present                           |
| **Physical access cards**  | ✅ Yes      | MIFARE, DESFire, and custom card formats                                              |

## How It Works

### Access Control Model

OpenPath uses a **group-based** model to manage access permissions:

* **Users** represent individuals in the system (mapped to Nexudus customers)
* **Groups** define collections of doors/entries that users can access
* **Entries** are individual access points (doors, gates, turnstiles)
* **Credentials** are the methods users authenticate with (mobile, cards, cloud keys)
* **Readers** are the physical devices that grant access at entries

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their user record in OpenPath with the appropriate group memberships.

### Multi-Door Support

OpenPath uses **groups** to grant permissions to multiple entries. Instead of mapping each entry individually:

1. In OpenPath, create a group (e.g., "24/7 Access")
2. Add the relevant entries to that group in OpenPath
3. In Nexudus, map your pass/resource/desk to that group by its ID
4. Customers with that pass automatically get access to all entries in the group

<Note>
  You must configure which entries belong to each group in the OpenPath platform. Nexudus assigns customers to groups, but the entry-to-group mapping is managed in OpenPath.
</Note>

### Credential Types

OpenPath supports multiple credential types:

1. **Mobile credentials**: Bluetooth-enabled access through the Nexudus Passport app
2. **Cloud keys**: Time-limited web links for temporary access (primarily for visitors)
3. **Physical cards**: RFID cards in various formats
   * **MIFARE CSN**: Simple card serial number (fast, less secure)
   * **DESFire**: Encrypted card data (secure, recommended)
   * **Custom formats**: Configurable card formats with facility codes and other fields

Every customer receives a mobile credential automatically. Physical cards are optional and configured via the customer's Access Card ID field.

## Prerequisites

Before connecting Nexudus to OpenPath, ensure you have:

1. **Active OpenPath account** with administrator access
2. **API credentials** (username and password for API authentication)
3. **Organization ID** — The numeric identifier for your OpenPath organization
4. **Region selection** — US or EU based on your data center location
5. **OpenPath system configured** with readers installed and online
6. **Groups created** in OpenPath for different access levels (e.g., 24/7 access, business hours only)
7. **Nexudus location configured** with plans, passes, and resources

## Configuration

### Step 1: Connect to OpenPath

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **OpenPath** or **Avigilon Alta** in the list and click **Connect**
3. Enter your connection details:
   * **Username**: Your OpenPath API username
   * **Password**: Your OpenPath API password
   * **Organization ID**: The numeric ID of your organization
   * **Region**: Select **US** or **EU** based on your data center
4. Click **Save** to establish the connection

Once connected, Nexudus can read your OpenPath groups, entries, readers, and credential types.

<Note>
  The region setting determines which API endpoint is used:

  * **US**: `https://api.openpath.com`
  * **EU**: `https://api.eu.openpath.com`

  Choose the region where your OpenPath account was created.
</Note>

### Step 2: Configure Credential Type

OpenPath supports multiple types of physical access cards. Choose the credential type that matches your hardware.

1. In the **Credential Type** section, select your card type:
   * **Automatic** (recommended): Auto-detects based on card number length
     * 14 digits → DESFire (encrypted, secure)
     * Other lengths → MIFARE CSN (fast, less secure)
   * **Specific card type**: Choose a specific credential type if you have custom cards
2. **Card Format** (optional): If using custom card formats with facility codes or site codes:
   * Select the card format from the dropdown
   * Enter values for required fields (facility code, company code, etc.)
   * These values apply to all cards issued at this location
3. Click **Save**

**Card type recommendations:**

* **DESFire (Encrypted)**: More secure, slightly slower to read
* **MIFARE CSN**: Faster to read, less secure (uses only the card serial number)
* **Automatic**: Best for most installations — uses DESFire for 14-digit cards, MIFARE for others

<Note>
  Card formats are typically pre-configured in OpenPath by your installer. Only configure custom fields if you're using cards with facility codes or site-specific encoding.
</Note>

### Step 3: Configure Presence Tracking (Optional)

OpenPath can trigger automatic check-ins when customers unlock specific readers.

1. In the **Presence Tracking** section, you'll see all readers from your OpenPath system
2. For each reader, choose an action:
   * **Nothing**: Reader access is tracked in OpenPath but doesn't affect Nexudus
   * **Check In**: Unlocking this reader checks the customer in
   * **Check Out**: Unlocking this reader checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance reader to **Check In**
* Set the exit reader to **Check Out**
* Set internal readers to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires event processing. Nexudus syncs reader events every 9 minutes and triggers the appropriate check-in action based on your configuration.
</Note>

### Step 4: Map Passes to Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to an OpenPath group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the OpenPath **Group** that customers should be assigned to when they hold that pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to an OpenPath group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | OpenPath Group | Purpose                            |
| ------------------- | -------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members   | Round-the-clock building access    |
| Business Hours Pass | Business Hours | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms  | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to OpenPath groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated OpenPath access
</Warning>

### Step 5: Map Resources to Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select the OpenPath **Group** required to access that space
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked 15 minutes after the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | OpenPath Group   | Purpose                            |
| ----------------- | ---------------- | ---------------------------------- |
| Conference Room A | Conference Rooms | Access to conference room zone     |
| Event Space       | Event Hall       | Access to event space for bookings |
| Private Office    | Private Offices  | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 6: Map Desks/Units to Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select the OpenPath **Group** required to access that area
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | OpenPath Group         | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant OpenPath access.
</Warning>

### Step 7: Configure Visitor Cloud Keys (Optional)

OpenPath supports generating time-limited access links (cloud keys) for visitors and guests.

**To enable visitor cloud keys:**

1. In **Settings > Integrations > OpenPath**, enable the setting:
   * **Send a CloudKey link to visitors**: Set to **Yes/True**
2. Configure **CloudKey Guests Entry IDs**: Enter the entry IDs that visitors should have access to
   * Format: Comma-separated list of entry IDs (e.g., `123,456,789`)
   * Find entry IDs in your OpenPath dashboard under **Entries**
3. Click **Save**

**How visitor cloud keys work:**

1. When you register a visitor in Nexudus, a cloud key link is automatically generated
2. The visitor receives an email with the access link
3. They can open the link on their mobile device to unlock doors
4. Access is valid from 15 minutes before their expected arrival until:
   * Next day at midnight (for general visitors)
   * 15 minutes after booking end time (for booking guests)
5. If the visitor is associated with a booking, they automatically receive access to the booked resource's entries

**Booking integration:**

If a visitor is added as a guest on a resource booking:

* The cloud key is automatically scoped to the resource's access group
* Access timing matches the booking window (start to end + 15 minutes)
* No need to manually configure entry IDs for booking-based visitors

<Note>
  Cloud keys are temporary credentials that expire automatically. Visitors don't need to download an app — they simply open the web link on their mobile device.
</Note>

### Step 8: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants OpenPath access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding OpenPath groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped OpenPath group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted cloud key access for the booking duration
6. **Visitor registered**: Visitor is registered → receives cloud key link with time-limited access
7. **Check-in active**: Customer with a valid pass checks in → maintains access through the check-in period

### When Access is Revoked

Nexudus automatically revokes OpenPath access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding OpenPath groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped OpenPath group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all OpenPath access removed
6. **No access groups remain**: If customer has no passes, bookings, or desks → user is deleted from OpenPath

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds (5-second debounce)
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Event processing**: Reader events are synced every 9 minutes for check-in tracking
* **Automatic retry**: Failed operations retry automatically with exponential backoff (5 retries over 5 minutes)

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## Mobile App Experience

Customers can use the **Nexudus Passport** mobile app to unlock doors remotely.

### Setup for Customers

1. Customer downloads the **Nexudus Passport** app (iOS or Android)
2. Signs in with their Nexudus credentials
3. App detects OpenPath integration is active
4. Customer receives a mobile credential automatically
5. Customer can view available entries and unlock them remotely

### Using Mobile Access

1. Customer opens the Nexudus Passport app
2. Navigates to **Unlock Doors** section
3. Views list of entries they currently have access to
4. Taps **Unlock** to remotely unlock an entry
5. Can also use Bluetooth proximity unlock if available

### Mobile Credential Provisioning

Mobile credentials are issued automatically:

* **Automatic creation**: When a customer receives their first access group, a mobile credential is created
* **Manual provisioning** (optional): Enable **Set Up Mobile Credential** in settings to automatically provision the credential for immediate use
* **App-based setup**: Customers can also provision credentials through the Nexudus Passport app

<Note>
  Mobile credentials work via Bluetooth and web-based remote unlock. Customers need Bluetooth enabled on their device for proximity-based unlocking.
</Note>

### Physical Card Management

OpenPath supports traditional RFID access cards alongside mobile access. To assign cards:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678`
5. Save the customer profile

**Card behavior:**

* **No card**: User receives mobile credential only
* **Card assigned**: User has both physical card and mobile credential
* **Card removed**: Physical credential is deleted, mobile credential remains

**Card type detection (Automatic mode):**

* **14-digit cards**: Created as DESFire (encrypted)
* **Other lengths**: Created as MIFARE CSN
* **Specific type selected**: Uses the configured credential type

<Note>
  OpenPath uses the card number directly without additional encoding. If you need facility codes or site codes, select a custom card format and configure the additional fields.
</Note>

## Visitor Access

### Generating Visitor Cloud Keys

OpenPath provides time-limited access links for visitors:

**Automatic generation:**

1. Register a visitor in **Operations > Visitors**
2. Enter their email address and expected arrival time
3. Nexudus automatically generates a cloud key link
4. The visitor receives the link via email

**Manual generation:**

1. Open an existing visitor record
2. Click **Generate Access Link** (if available)
3. Copy the link and send it to the visitor

### Cloud Key Access Scope

**For general visitors:**

* Access to entries specified in **Visitor Entry IDs** setting
* Valid from 15 minutes before expected arrival
* Expires at midnight the following day (in location's timezone)

**For booking guests:**

* Access to all entries in the booked resource's access group
* Valid from 15 minutes before booking start
* Expires 15 minutes after booking end
* Overrides general visitor entry IDs

**Access link usage:**

1. Visitor opens the link on their mobile device
2. Link opens the OpenPath web interface
3. Visitor can unlock assigned entries
4. Access expires automatically at the configured time

<Note>
  Visitors don't need to create an account or download an app. The cloud key link provides temporary access through their mobile browser.
</Note>

### Managing Visitor Access

**To revoke visitor access:**

1. Go to **Operations > Visitors**
2. Select the visitor
3. Click **Revoke Access** or delete the visitor record
4. The cloud key is immediately invalidated

**Access is automatically revoked when:**

* The visitor's expected departure time passes
* The associated booking ends (for booking guests)
* The visitor record is deleted
* The visitor checks out

## Remote Door Unlock

Customers can unlock doors remotely through the Nexudus Passport app without being physically present.

### Enabling Remote Unlock

1. In **Settings > Integrations > OpenPath**, enable:
   * **Has Remote Unlock**: Set to **Yes/True**
2. This setting allows customers to unlock doors from anywhere, not just via proximity

### How Remote Unlock Works

1. Customer opens Nexudus Passport app
2. Selects the entry to unlock
3. Taps **Unlock**
4. Nexudus sends the unlock command to OpenPath
5. Door unlocks immediately (subject to OpenPath's configured unlock duration)

<Warning>
  Remote unlock allows customers to unlock doors without being physically present. Only enable this feature if your security policy allows remote access.
</Warning>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access entries">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any OpenPath groups
       * **Solution**: Go to Settings > Integrations > OpenPath and map the relevant passes to groups

    2. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    3. **User not created**: The customer wasn't created in OpenPath
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    4. **Group permissions**: The OpenPath group exists but isn't assigned to any entries
       * **Solution**: In OpenPath, verify the group includes the correct entries

    5. **No credentials**: Customer doesn't have a mobile credential or physical card
       * **Solution**: Check the customer's OpenPath user record to verify credentials were created

    6. **Credential not provisioned**: Mobile credential exists but isn't provisioned
       * **Solution**: Enable "Set Up Mobile Credential" in settings, or have the customer provision through the app
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to an OpenPath group
       * **Solution**: Map the resource to a group in Settings > Integrations > OpenPath

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **Group has no entries**: The mapped group exists but doesn't contain any entries
       * **Solution**: In OpenPath, add entries to the group
  </Accordion>

  <Accordion title="Mobile app showing no entries available">
    **Possible causes:**

    1. **No active access**: Customer doesn't have any passes or bookings that grant access
       * **Solution**: Verify customer has an active pass or upcoming booking mapped to OpenPath groups

    2. **Credential not provisioned**: Mobile credential exists but not provisioned
       * **Solution**: Enable "Set Up Mobile Credential" setting, or have customer tap "Provision" in the app

    3. **App not refreshed**: Entry list hasn't updated after access was granted
       * **Solution**: Customer should pull down to refresh the entry list in the app

    4. **Wrong region**: App is connecting to wrong OpenPath region
       * **Solution**: Verify the region setting matches your OpenPath account (US or EU)
  </Accordion>

  <Accordion title="Check-ins not created from reader events">
    **Possible causes:**

    1. **Reader action not configured**: Reader is set to "Nothing" instead of a check-in action
       * **Solution**: Configure the reader action in Settings > Integrations > OpenPath

    2. **Event processing disabled**: Events aren't being synced
       * **Solution**: Check that the OpenPath integration is enabled and credentials are valid

    3. **Sync delay**: Background task runs every 9 minutes
       * **Solution**: Wait up to 9 minutes for the next event sync cycle

    4. **No external ID**: User in OpenPath doesn't have an external ID linking to Nexudus
       * **Solution**: Delete and recreate the user by updating the customer's access
  </Accordion>

  <Accordion title="Physical cards not working">
    **Possible causes:**

    1. **Card number incorrect**: Card ID entered doesn't match the actual card
       * **Solution**: Verify card number by reading it with an enrollment reader

    2. **Wrong card type**: Using DESFire card with MIFARE setting or vice versa
       * **Solution**: Set credential type to "Automatic" or select the correct card type

    3. **Card format mismatch**: Using cards that require facility codes but format not configured
       * **Solution**: Select the appropriate card format and configure required fields

    4. **Credential not created**: Card number saved but credential not created in OpenPath
       * **Solution**: Check Business Checkup for errors, or remove and re-add the card number
  </Accordion>

  <Accordion title="Visitor cloud keys not generating">
    **Possible causes:**

    1. **Feature not enabled**: Send a CloudKey link to visitors setting is disabled
       * **Solution**: Enable "Send a CloudKey link to visitors" in Settings > Integrations > OpenPath

    2. **No entry IDs configured**: CloudKey Guests Entry IDs setting is empty
       * **Solution**: Configure entry IDs in the settings (unless using booking-based access)

    3. **Invalid entry IDs**: Entry IDs don't exist in OpenPath
       * **Solution**: Verify entry IDs in OpenPath dashboard and update the setting

    4. **Visitor has no email**: Visitor record doesn't have an email address
       * **Solution**: Add email address to the visitor record
  </Accordion>

  <Accordion title="Integration connection failing">
    **Cause:** Your OpenPath API credentials have expired or are incorrect.

    **Solution:**

    1. Verify your username and password in the OpenPath admin portal
    2. Reconnect the integration with updated credentials
    3. Ensure your OpenPath account has API access enabled
    4. Verify the correct region is selected (US or EU)
    5. Check that your organization ID is correct
    6. Contact OpenPath support if credentials are correct but connection fails
  </Accordion>

  <Accordion title="Access signature unchanged - no update triggered">
    **Cause:** Nexudus optimizes API calls by checking if access has actually changed before updating OpenPath.

    **This is normal behavior when:**

    * Customer already has access to the same groups
    * A pass is added but the customer already has another pass with the same access
    * An update is triggered but no access groups have changed

    **Solution:**

    * No action needed — this is an optimization to reduce API calls
    * If access should have changed but didn't, check the pass/resource/desk mappings
    * Review the customer's current access groups in OpenPath
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Expired credentials or invalid API tokens
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Invalid group IDs or missing entries
* **Synchronization problems**: Delays or failures in updating access permissions
* **Credential creation failures**: Unable to issue mobile credentials or cards

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Error message from OpenPath
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations (5 attempts over 5 minutes). If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with OpenPath

When provisioning access, Nexudus shares the following information with OpenPath:

* **Customer data**: First name, last name, email address
* **External ID**: Nexudus customer ID (used to link records between systems)
* **RFID cards**: Card IDs from the Access Card ID field
* **Access groups**: Group IDs the customer should be assigned to

Nexudus **does not** share:

* Billing information
* Payment details
* Contract specifics (only group assignments)
* Personal notes or custom fields
* Other customers' information

### Credential Security

* **Mobile credentials**: Managed entirely by OpenPath; Nexudus only creates the credential record
* **Cloud keys**: Time-limited and automatically expire; can be revoked immediately
* **Physical cards**: Card numbers stored in Nexudus; OpenPath encrypts card data
* **Remote unlock**: Requires valid authentication to Nexudus Passport app
* **User passwords**: Never shared with Nexudus; authentication to OpenPath is handled by OpenPath

### Access Logging

All access events are logged in OpenPath:

* Who accessed which entry
* When the access occurred
* Which credential was used (mobile, card, cloud key)
* Whether access was granted or denied

These logs are available in the OpenPath dashboard for audit purposes.

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)
* [Visitor Management](/platform/operations/visitors)

## Best Practices

### Group Organization

Create groups based on access levels, not products or plans:

* ✅ **Good**: "24/7 Access", "Business Hours", "Meeting Rooms", "Private Offices"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Credential Strategy

**For members:**

* Issue mobile credentials to all customers (automatic)
* Only issue physical cards when needed (reduces cost and management overhead)
* Use DESFire cards for higher security environments
* Use MIFARE CSN for faster access in low-security areas

**For visitors:**

* Use cloud keys instead of physical credentials
* Set appropriate expiration times based on visit duration
* For recurring visitors, consider converting them to temporary members

### Entry Organization in OpenPath

* Group entries by access level (not by physical location)
* Create separate groups for different time restrictions (24/7 vs business hours)
* Use descriptive group names that indicate the access level
* Document which entries belong to which groups

### Check-in Configuration

* Only enable check-in tracking on primary entrance readers
* Set exit readers to "Check Out" to automatically track departures
* Set interior readers to "Nothing" to avoid redundant check-ins
* Consider using "Toggle" for single-entry/exit locations

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URL (US)**: `https://api.openpath.com`
  * **Base URL (EU)**: `https://api.eu.openpath.com`
  * **Authentication**: Basic Auth (username/password)
  * **Token management**: Session-based with automatic token refresh
  * **Rate limiting**: 30 requests per minute per username (enforced via semaphore across servers)

  ### Key Endpoints

  * **Users**: `/orgs/{orgId}/users` (GET, POST, PUT, DELETE)
  * **Groups**: `/orgs/{orgId}/groups`
  * **User Groups**: `/users/{userId}/groups` (PUT to update group assignments)
  * **Credentials**: `/users/{userId}/credentials` (GET, POST, DELETE)
  * **Credential Types**: `/credentialTypes`
  * **Card Formats**: `/cardFormats`
  * **Readers**: `/orgs/{orgId}/readers`
  * **Entries**: `/groups/{groupId}/entries`
  * **Activity Report**: `/orgs/{orgId}/activity` (access events)
  * **Mobile Setup Token**: `/users/{userId}/credentials/{credentialId}/mobile/provisioningQrcode`
  * **Cloud Key Token**: `/users/{userId}/credentials/{credentialId}/cloudKey/accessToken`
  * **Remote Unlock**: POST with entry ID and unlock command

  ### Synchronization

  * **Access updates**: Debounced by 5 seconds per customer to batch rapid changes
  * **Background task**: Polls reader events every 9 minutes for check-in tracking
  * **Event query**: Queries activity report for successful access events
  * **Distributed locking**: Prevents race conditions in multi-server deployments
  * **User provisioning**: Lazy creation on first group assignment
  * **User deletion**: Automatic when no groups remain
  * **Access signature hashing**: Prevents unnecessary API calls when access hasn't changed

  ### External IDs

  * **Customers**: `ExternalID` set to Nexudus customer ID (integer)
  * **Lookup**: Users retrieved via email first, then verified by external ID
  * **Uniqueness**: One OpenPath user per customer email address

  ### User Model

  ```json theme={null}
  {
    "id": 12345,
    "externalId": "67890",
    "status": "active",
    "hasRemoteUnlock": true,
    "identity": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com"
    },
    "groups": [1, 2, 3]
  }
  ```

  ### Credential Types

  | Type ID | Name       | Model Name             | Use Case                    |
  | ------- | ---------- | ---------------------- | --------------------------- |
  | 1       | Mobile     | mobile                 | Bluetooth mobile access     |
  | 4       | MIFARE CSN | cardMifareCsn          | Simple RFID cards           |
  | 5       | DESFire    | cardOpenpathDesfireEv1 | Encrypted RFID cards        |
  | 6       | Cloud Key  | cloudKey               | Time-limited visitor access |
  | Custom  | Varies     | card                   | Custom card formats         |

  ### Card Format Fields

  Custom card formats may include:

  * `cardId` (required): The card number
  * `facilityCode`: Facility/site identifier
  * `companyCode`: Company identifier
  * `issueLevel`: Card issue level
  * `siteCode`: Site code
  * `oem`, `rcm`: Manufacturer codes

  ### Business Settings Reference

  | Setting                                    | Purpose                                                      |
  | ------------------------------------------ | ------------------------------------------------------------ |
  | `OpenPath.Enabled`                         | Integration enabled flag ("true"/"false")                    |
  | `OpenPath.Username`                        | OpenPath API username                                        |
  | `OpenPath.Password`                        | OpenPath API password                                        |
  | `OpenPath.OrganisationId`                  | Organization ID for API calls                                |
  | `OpenPath.Region`                          | API region ("US" or "EU")                                    |
  | `OpenPath.CardType`                        | Default credential type ID (0 = automatic)                   |
  | `OpenPath.CardFormatId`                    | Card format ID for custom cards                              |
  | `OpenPath.CardFormat.{field}`              | Custom card format field values                              |
  | `OpenPath.HasRemoteUnlock`                 | Enable remote unlock ("true"/"false")                        |
  | `OpenPath.SetUpMobileCredential`           | Auto-provision mobile credentials ("true"/"false")           |
  | `OpenPath.CreateVisitorCloudKeys`          | Enable visitor cloud keys ("true"/"false")                   |
  | `OpenPath.VisitorEntryIds`                 | Comma-separated entry IDs for visitors                       |
  | `OpenPath.Controller.Id_{readerId}.Action` | Check-in action per reader (Nothing/CheckIn/CheckOut/Toggle) |

  ### Contract-Based Desk Access

  * Desk access determined by active contracts: `coworker.ActiveContracts().SelectMany(x => x.Desks)`
  * **Team billing support**: Customer receives access to desks in paying member's contracts
  * **Desk mapping**: Each desk mapped to a single group ID

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Group aggregation**: Unique list of all group IDs from above sources
  7. **Signature check**: Compare new group list to stored access signature
  8. **Skip if unchanged**: If signature matches, skip API call (optimization)
  9. **User provisioning**: Create user if doesn't exist and has groups
  10. **Group update**: Update user's group assignments via PUT to `/users/{id}/groups`
  11. **Credential management**: Create mobile credential, physical cards based on Access Card ID
  12. **User deletion**: If no groups remain, delete all credentials and user

  ### Credential Management Logic

  **Mobile credentials:**

  * Created with credential type ID 1
  * Name set to location name
  * Provisioned automatically if `SetUpMobileCredential` is enabled
  * One mobile credential per user

  **Physical cards:**

  * Created based on Access Card ID field (comma-separated)
  * Auto-detection: 14 digits = DESFire, others = MIFARE CSN
  * Multiple cards supported (split by comma)
  * All existing card credentials deleted before creating new ones
  * Custom card formats supported with additional fields

  **Cloud keys (visitors):**

  * Created with credential type ID 6
  * Name format: "Visitor #"
  * Time-limited access tokens generated with entry scope
  * Booking integration: inherits entries from resource's group
  * Validity: expected arrival -15 min to departure +15 min (or next day midnight)

  ### Event Processing

  * **Task schedule**: Recurring job every 9 minutes
  * **Event query**: Activity report from `lastEventDate` to `now`
  * **Event filtering**: Only "Granted" results processed
  * **User lookup**: Match by user ID in OpenPath, verify via external ID
  * **Check-in trigger**: Based on reader's configured action
  * **Timestamp conversion**: Unix timestamp to DateTime
  * **Invalid check-in notification**: System message sent to access control notification users

  ### Error Handling

  * **Authentication failures**: Disable integration and log error
  * **Provisioning errors**: Automatic retry with 5 attempts
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Distributed locks**: Prevent concurrent updates to same customer
  * **Exception logging**: Full stack trace logged for troubleshooting
  * **Event raising**: `OnExceptionHandler<AccessControlEventData>` for monitoring

  ### Card Number Detection

  ```csharp theme={null}
  if (cardNumber.Length == 14)
      credentialType = DESFire;  // Encrypted
  else
      credentialType = MIFAREC SN;  // Fast
  ```

  ### Access Signature Hash

  ```csharp theme={null}
  var signature = string.Join(",", groups.OrderBy(x => x));
  coworker.SetAccessSignatureForProvider(eAccessSignatureProviderType.OpenPath, signature);
  ```

  This prevents API calls when group membership hasn't actually changed.
</Accordion>


# Brivo
Source: https://learn.nexudus.com/platform/access-control/integrations/brivo

Connect Nexudus with Brivo's cloud-based access control system to automate door access based on plans, passes, bookings, and desk assignments

# Brivo Access Control Integration

## Overview

Brivo is a cloud-based access control platform that enables flexible, secure physical access management. The Nexudus integration with Brivo automates credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **Cloud-based management**: Manage access from anywhere through Brivo's web platform
* **Mobile access**: Customers can use the Brivo OnAir mobile app via the Nexudus Passport app
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Visitor support**: Time-limited credentials for visitors with automatic expiry
* **Check-in tracking**: Optionally use door events to check customers in/out
* **Multi-region support**: Works with both Global and Europe Brivo regions
* **Group-based permissions**: Map your inventory (passes, resources, desks) to Brivo access groups

### Integration Type

**Cloud-based** — Brivo operates entirely in the cloud with no on-premises server requirements.

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Primary access mechanism via pass-to-group mapping                         |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Temporary access during bookings with 15-min lead time                     |
| **Desk/unit-based access** | ✅ Yes      | Contract-based access with team billing support                            |
| **Visitor access**         | ✅ Yes      | Time-limited credentials with automatic expiry                             |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ✅ Yes      | Door events trigger automatic check-ins                                    |
| **Mobile app access**      | ✅ Yes      | Brivo OnAir integration via Nexudus Passport app                           |
| **Remote door unlock**     | ❌ No       | Customers must be physically near doors to unlock                          |

## How It Works

### Access Control Model

Brivo uses a **user and group** model:

1. **Users**: Each customer is created as a user in Brivo with their email and name
2. **Groups**: Access permissions are organized into groups in Brivo (e.g., "24/7 Access", "Meeting Room A")
3. **Credentials**: Users receive credentials (physical cards, QR codes, or mobile passes) to access doors
4. **Access points**: Physical doors/locks controlled by Brivo hardware

When a customer should have access (based on their plan, passes, or bookings), Nexudus:

* Creates or updates their Brivo user profile
* Assigns them to the appropriate access groups
* Provisions credentials (mobile pass or physical card)

### Multi-Door Support

Brivo uses **access groups** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Brivo, create an access group (e.g., "Coworking Space Access")
2. Add the relevant doors to that group in Brivo
3. In Nexudus, map your pass/resource/desk to that group
4. Customers with that pass automatically get access to all doors in the group

<Note>
  You must configure which doors belong to each group in the Brivo platform. Nexudus assigns customers to groups, but the door-to-group mapping is managed in Brivo.
</Note>

## Prerequisites

Before connecting Nexudus to Brivo, ensure you have:

1. **Active Brivo account** with administrator access
2. **Brivo API Key** obtained from Brivo support or your account manager
3. **Brivo site configured** with access points (doors/locks) installed and online
4. **Access groups created** in Brivo for different access levels (e.g., 24/7 access, business hours only)
5. **API access enabled** on your Brivo account
6. **Nexudus location configured** with plans, passes, and resources

<Note>
  **Getting your API Key**: Contact Brivo support or your Brivo account manager to request an API Key for your account. You'll need this before you can connect Nexudus to Brivo. The API Key is separate from your login credentials and enables programmatic access to your Brivo system.
</Note>

<Note>
  You'll need to choose your region (Global or Europe) during setup. This determines which Brivo API endpoint is used and cannot be changed later without reconnecting.
</Note>

## Configuration

### Step 1: Connect to Brivo

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Brivo** in the list and click to open the integration settings
3. Toggle **Enable Brivo integration** to ON
4. Enter your **API Key** (obtained from Brivo support)
5. Select your region:
   * **Global**: For accounts on `https://auth.brivo.com`
   * **Europe**: For accounts on `https://auth.eu.brivo.com`
6. Click **Connect**
7. Sign in to your Brivo account when prompted
8. Grant Nexudus permission to access your Brivo account
9. You'll be redirected back to Nexudus

Once connected, Nexudus can read your Brivo sites, access points, groups, and credential formats.

<Warning>
  The region selection (Global vs Europe) is tied to your Brivo account setup. If you're unsure which region your account uses, check with your Brivo administrator or look at your Brivo login URL.
</Warning>

### Step 2: Select Your Site

If you have multiple Brivo sites:

1. From the **Site** dropdown, select the site that corresponds to this Nexudus location
2. This determines which access points and groups are available for mapping

<Note>
  If you have multiple locations in Nexudus and multiple sites in Brivo, you'll need to configure the integration separately for each location.
</Note>

### Step 3: Configure Presence Tracking (Optional)

Brivo can trigger automatic check-ins when customers unlock specific doors.

1. In the **Access Points** section, you'll see all doors from your Brivo site
2. For each door, choose an action:
   * **Nothing**: Door access is tracked in Brivo but doesn't affect Nexudus
   * **Check In**: Unlocking this door checks the customer in
   * **Check Out**: Unlocking this door checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance to **Check In**
* Set the exit door to **Check Out**
* Set internal doors to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires webhook events from Brivo. Nexudus listens for access granted events and triggers the appropriate check-in action based on your configuration.
</Note>

### Step 4: Map Passes to Access Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Brivo access group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the Brivo **Access Group** that customers should be assigned to when they hold that pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Brivo group, the customer is added to that group in Brivo
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Brivo Group    | Purpose                            |
| ------------------- | -------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members   | Round-the-clock building access    |
| Business Hours Pass | Business Hours | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms  | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to access groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to access groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Brivo access
</Warning>

### Step 5: Map Resources to Access Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select the Brivo **Access Group** required to access that space
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Brivo Group     | Purpose                            |
| ----------------- | --------------- | ---------------------------------- |
| Conference Room A | Meeting Room A  | Access to specific meeting room    |
| Event Space       | Event Hall      | Access to event space for bookings |
| Private Office    | Private Offices | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 6: Map Desks/Units to Access Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select the Brivo **Access Group** required to access that area
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Brivo Group            | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Brivo access.
</Warning>

### Step 7: Configure Visitor Access (Optional)

Brivo supports time-limited credentials for visitors.

1. In the **Visitor Settings** section, select the Brivo **Access Groups** that visitors should receive
2. Multiple groups can be selected if visitors need access to multiple areas
3. Optionally configure:
   * **Credential format**: Choose which credential format to use for visitors (QR code, PIN, etc.)
   * **Automatic mobile invitations**: Enable to automatically send mobile pass invitations to visitors

**How visitor access works:**

* When a visitor is registered in Nexudus with an expected arrival time, Nexudus creates a temporary Brivo user
* The visitor receives a time-limited credential (access starts 15 minutes before expected arrival)
* Access automatically expires:
  * **Guest on a booking**: 15 minutes after the booking ends
  * **Regular visitor**: At midnight (location's time zone) after the arrival date
* When the visitor is marked as departed or deleted, their Brivo credential is removed immediately

<Note>
  Visitors can also be added as **guests on bookings**. When a customer adds a guest to a meeting room booking, the guest receives the same access as the resource grants, limited to the booking time window.
</Note>

### Step 8: Configure Mobile Access (Optional)

Brivo OnAir enables customers to unlock doors using their smartphone via the Nexudus Passport app.

**Requirements:**

* Brivo OnAir must be enabled on your Brivo account
* Customers must download the Nexudus Passport app
* The integration must be configured to use mobile credentials

**Setup:**

1. In Brivo, ensure your access points support OnAir (mobile credentials)
2. In Nexudus, under **Credential Settings**, select:
   * **Credential format**: Choose "Brivo Mobile Pass"
   * **Redeem OnAir passes automatically**: Enable to automatically provision mobile passes without requiring customers to manually redeem an invitation

**Customer experience:**

1. Customer logs in to the Nexudus Passport app
2. App detects Brivo integration is enabled
3. Customer receives a Brivo OnAir invitation:
   * **Automatic mode**: Invitation is pre-redeemed, customer can unlock doors immediately
   * **Manual mode**: Customer receives an email with an access code to redeem in the Brivo app
4. Customer can unlock doors directly from the Passport app

<Note>
  If automatic redemption is disabled, customers receive an email with a Brivo OnAir access code. They must enter this code in the Brivo Mobile app to activate their mobile credential.
</Note>

### Step 9: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Brivo access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Brivo groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Brivo group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Visitor registered**: Visitor is added with expected arrival → temporary Brivo credential created
6. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration

### When Access is Revoked

Nexudus automatically revokes Brivo access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Brivo groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Brivo group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all Brivo access removed
6. **Visitor expires**: Visitor's access window ends or visitor is deleted → Brivo credential deleted
7. **Check-in expires**: If customer checks out or check-in expires, certain temporary access may be revoked

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Visitor access**: Starts 15 minutes before expected arrival
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## Mobile App Experience

Customers can use the **Nexudus Passport** mobile app to access doors via Brivo OnAir.

### Setup for Customers

1. Customer downloads the **Nexudus Passport** app (iOS or Android)
2. Signs in with their Nexudus credentials
3. App detects Brivo integration is active
4. Customer receives or redeems a Brivo OnAir mobile pass:
   * **Automatic mode**: Pass is ready immediately
   * **Manual mode**: Customer receives an email with an access code to enter in the Brivo app

### Using Mobile Access

1. Customer opens the Nexudus Passport app
2. Navigates to **Unlock Doors** section
3. Views available Brivo OnAir credentials
4. Approaches door and uses phone to unlock (via Bluetooth or QR code, depending on Brivo hardware)

### Revoking Mobile Access

Customers can revoke and re-invite their mobile pass from the Nexudus Passport app if:

* They changed phones
* The pass stopped working
* They want to refresh their credentials

Admins can also force a refresh by:

1. Temporarily deactivating the customer
2. Reactivating the customer
3. Access is automatically re-provisioned

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Brivo access groups
       * **Solution**: Go to Settings > Integrations > Brivo and map the relevant passes to access groups

    2. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    3. **Brivo user not created**: The customer wasn't created in Brivo
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    4. **Access group permissions**: The Brivo access group exists but isn't assigned to any doors
       * **Solution**: In Brivo, verify the access group includes the correct access points

    5. **Credential not provisioned**: Customer exists in Brivo but has no active credential
       * **Solution**: Check if the customer has redeemed their OnAir invitation (if using mobile access), or issue a physical card
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to a Brivo access group
       * **Solution**: Map the resource to an access group in Settings > Integrations > Brivo

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state
  </Accordion>

  <Accordion title="Visitor cannot access the space">
    **Possible causes:**

    1. **Visitor access not configured**: Visitor access groups are not set in the integration settings
       * **Solution**: Configure visitor access groups in Settings > Integrations > Brivo

    2. **Visitor code not generated**: The visitor doesn't have a visitor code assigned
       * **Solution**: Ensure the visitor has a unique visitor code in their profile

    3. **Access window not started**: Visitor access starts 15 minutes before expected arrival
       * **Solution**: Check the visitor's expected arrival time

    4. **Credential expired**: Visitor access window has ended
       * **Solution**: Update the visitor's expected arrival time or mark them as departed and re-register
  </Accordion>

  <Accordion title="Mobile access (OnAir) not working">
    **Possible causes:**

    1. **OnAir not enabled**: Brivo OnAir is not enabled on your Brivo account
       * **Solution**: Contact Brivo support to enable OnAir for your account

    2. **Invitation not redeemed**: Customer received an invitation but hasn't redeemed it
       * **Solution**: Check customer's email for the Brivo OnAir invitation code, or enable automatic redemption

    3. **Customer changed phones**: Mobile credential is tied to a specific device
       * **Solution**: Customer should revoke and re-invite their mobile pass from the Nexudus Passport app

    4. **Bluetooth/location disabled**: OnAir requires Bluetooth and location services
       * **Solution**: Customer should enable Bluetooth and location permissions for the Nexudus Passport app
  </Accordion>

  <Accordion title="Access not revoking when contract ends">
    **Possible causes:**

    1. **Multiple active contracts**: Customer has another active contract that includes the same passes
       * **Solution**: This is expected behavior — access remains as long as any active contract provides it

    2. **Shared passes**: Customer is part of a team with shared passes from another team member
       * **Solution**: Access remains as long as the paying team member's contract is active

    3. **Background job delayed**: Access revocation is queued and may take a few minutes
       * **Solution**: Wait 5-10 minutes and check again, or check the Business Checkup page if errors persist
  </Accordion>

  <Accordion title="Integration shows 'Developer Inactive' error">
    **Cause:** Your Brivo API credentials or subscription have expired or been revoked.

    **Solution:**

    1. Contact your Brivo account manager to verify your API access is active
    2. Reconnect the integration (disconnect and connect again) to refresh credentials
    3. Check that your Brivo subscription includes API access
  </Accordion>

  <Accordion title="Integration shows 'Developer Over Rate' error">
    **Cause:** Nexudus is making too many API requests to Brivo (hitting rate limits).

    **Solution:**

    * This is usually temporary and will resolve automatically
    * If it persists, it indicates high access update volume (e.g., large contract changes affecting many customers)
    * Contact Nexudus support if this error continues for more than 30 minutes
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Expired credentials or invalid API tokens
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid access group mappings
* **Synchronization problems**: Delays or failures in updating access permissions

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Brivo

When provisioning access, Nexudus shares the following information with Brivo:

* **Customer data**: First name, last name, email address
* **External ID**: Nexudus customer ID (used to link records between systems)
* **Visitor data**: Name, email, visitor code

Nexudus **does not** share:

* Billing information
* Payment details
* Contract specifics (only access group assignments)
* Personal notes or custom fields

### Credential Management

* **Physical cards**: Managed entirely in Brivo; Nexudus only assigns access groups
* **Mobile credentials**: Provisioned through Brivo OnAir; Nexudus triggers invitation but doesn't handle the credential itself
* **Visitor credentials**: Time-limited and automatically expire
* **User passwords**: Never shared with Nexudus; authentication to Brivo apps is handled by Brivo

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URLs**:
    * US: `https://api.brivo.com`
    * EU: `https://api.eu.brivo.com`
  * **Authorization URLs**:
    * US: `https://auth.brivo.com`
    * EU: `https://auth.eu.brivo.com`
  * **Authentication**: OAuth2 Authorization Code flow
  * **Authorization path**: `/oauth/authorize`
  * **Token path**: `/oauth/token`
  * **Token type**: Bearer token (stored in `Brivo.ApiToken` setting)
  * **Refresh token**: Stored in `Brivo.ApiRefreshToken` setting
  * **Client credential style**: POST body (not Authorization header)
  * **Rate limiting**:
    * Debug: 20 requests/second
    * Production: 50 requests/second
    * Per API key, distributed across multiple servers

  ### Key Endpoints

  * **Users**: Create, update, delete Brivo users
  * **Groups**: Manage access groups and group assignments
  * **Credentials**: Provision mobile passes, QR codes, PIN codes
  * **Sites**: Query sites associated with the account
  * **Access Points**: Query doors and access points
  * **Events**: Query access granted events with pagination
  * **Digital Invitations**: Send OnAir mobile pass invitations

  ### Synchronization

  * **Access updates**: Debounced by 5 seconds per customer to batch rapid changes
  * **Background task**: Polls door events every 9 minutes for check-in tracking
  * **Event query limitations**: Brivo cannot query more than 24 hours of data in a single call
  * **Event pagination**: Forward-in-time pagination using `occurred__gt` and `offset` parameters
  * **Distributed locking**: Semaphore-based (max 10 concurrent operations, 15-minute timeout)
  * **User provisioning**: Lazy creation on first inventory assignment
  * **Credential rules**: Created/updated/deleted as inventory changes
  * **Access signature hashing**: Prevents unnecessary API calls when access hasn't changed

  ### External IDs

  * **Customers**: `BrivoUserId` field stores Brivo user ID (integer)
  * **Lookup**: `coworker.BrivoUserId` maps to Brivo user's `id` field
  * **Visitors**: Temporary Brivo users created with `firstName`, `lastName`, `email`

  ### User Model

  ```json theme={null}
  {
    "id": 12345,
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "externalId": "CUSTOMER-67890",
    "suspended": false,
    "groups": [1, 2, 3]
  }
  ```

  ### Visitor Access

  * **Visitor users**: Temporary Brivo users with time-limited credentials
  * **Access time window**:
    * Start: 15 minutes before expected arrival
    * End: 15 minutes after departure (or midnight if no departure set)
  * **Access groups**:
    * Booking-based: From resource or desk mapped groups
    * General visitors: From `Brivo.VisitorAccessGroupIds` setting
  * **Credential format**: Configurable via `Brivo.QR.CardFormat` setting
  * **Cleanup**: Users deleted after access window expires

  ### Mobile Credentials (OnAir)

  * **OnAir invitations**: Sent via Brivo Digital Invitation API
  * **Automatic redemption**: Configurable via `Brivo.RedeemOnAirPassesAutomatically`
  * **Manual redemption**: Customer receives email with access code to enter in Brivo app
  * **Integration**: Nexudus Passport app integrates with Brivo OnAir
  * **Revocation**: Customer can revoke and re-invite from Passport app

  ### Business Settings Reference

  | Setting                                      | Purpose                                                            |
  | -------------------------------------------- | ------------------------------------------------------------------ |
  | `Brivo.Enable`                               | Integration enabled flag ("true"/"false")                          |
  | `Brivo.Region`                               | API region ("US" or "EU")                                          |
  | `Brivo.ApiKey`                               | API key for rate limiting identification                           |
  | `Brivo.ApiToken`                             | OAuth2 access token (auto-refreshed)                               |
  | `Brivo.ApiRefreshToken`                      | OAuth2 refresh token                                               |
  | `Brivo.SystemId`                             | Brivo system identifier                                            |
  | `Brivo.SiteId`                               | Comma-separated site IDs to query events from                      |
  | `Brivo.VisitorAccessGroupIds`                | Comma-separated group IDs for general visitors                     |
  | `Brivo.RedeemOnAirPassesAutomatically`       | Auto-redeem mobile passes ("true"/"false")                         |
  | `Brivo.QR.CardFormat`                        | Credential format ID for visitor QR codes                          |
  | `Brivo.LastEventDate`                        | Last processed event timestamp (ISO 8601)                          |
  | `Brivo.Controller.Id_{accessPointId}.Action` | Check-in action per access point (Nothing/CheckIn/CheckOut/Toggle) |

  ### Contract-Based Desk Access

  * Desk access determined by active contracts: `coworker.ActiveContracts().SelectMany(x => x.Desks)`
  * **Team billing support**: Customer receives access to desks in paying member's contracts via `coworker.PaysInvoicesViaTeam()`
  * **Access check**: Validated via `coworker.GetPayingMemberWithSharedTimePasses()` for shared passes
  * **Desk mapping**: Each desk mapped to comma-separated Brivo group IDs

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 16 minutes (15-min lead + 1-min buffer)
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Group aggregation**: Collect unique group IDs from all access sources
  7. **User provisioning**: Create/update Brivo user with aggregated groups
  8. **Credential management**: Issue mobile credentials or manage visitor access

  ### Event Processing

  * **Event query**: `GET /api/v1/api/events?occurred__gt={lastEventDate}&offset={timestamp}`
  * **Security action filter**: Only "Open" actions trigger check-ins
  * **Event fields**: `uuid`, `occurred`, `actor` (user), `object` (access point), `securityAction`
  * **Pagination**: Forward-in-time using minimum `occurred` timestamp as offset
  * **24-hour limitation**: Each query limited to 24 hours of data
  * **Event ordering**: Ordered by `occurred` timestamp ascending
  * **Multi-site**: Events queried separately for each Site ID in `Brivo.SiteId`

  ### Error Handling

  * **Developer Over Rate**: Rate limit exceeded, operation automatically retried
  * **Developer Inactive**: API credentials expired or subscription inactive
  * **Authentication failures**: Automatic token refresh using refresh token
  * **Provisioning errors**: Stored in business log entries with retry logic
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Distributed locks**: Prevent concurrent updates to same customer

  ### Rate Limiting

  * **Semaphore-based**: Per API key across distributed servers
  * **Thread-safe**: Uses `RateLimiterThreadingTimer` with sliding window
  * **Dynamic headers**: API key header applied dynamically per request
  * **Over-rate handling**: Requests queued and retried automatically

  ### Region Configuration

  * **US Region**: Default, uses `api.brivo.com` and `auth.brivo.com`
  * **EU Region**: Uses `api.eu.brivo.com` and `auth.eu.brivo.com`
  * **Client credentials**: Different client IDs per region (`BrivoClientId` vs `BrivoEuClientId`)
  * **Cannot change**: Region locked after initial configuration (requires reconnection to switch)
</Accordion>

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Visitor Management](/platform/operations/visitors)
* [Resource Bookings](/platform/operations/bookings)


# Doorflow
Source: https://learn.nexudus.com/platform/access-control/integrations/doorflow

Connect Nexudus with Doorflow's cloud-based access control system to automate door access based on plans, passes, bookings, and desk assignments

# Doorflow Access Control Integration

## Overview

Doorflow is a cloud-based access control platform that enables flexible, secure physical access management for modern workspaces. The Nexudus integration with Doorflow automates credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **Cloud-based management**: Manage access from anywhere through Doorflow's web platform
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Check-in tracking**: Optionally use door events to check customers in/out
* **RFID card support**: Physical access cards with PIN code support
* **Group-based permissions**: Map your inventory (passes, resources, desks) to Doorflow groups
* **Booking-based temporary access**: Automatic access during reservation windows
* **Multi-site support**: Manage access across multiple physical locations

### Integration Type

**Cloud-based** — Doorflow operates entirely in the cloud with no on-premises server requirements. API endpoints are hosted at `api.doorflow.com`.

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                      |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                |
| **Visitor access**         | ❌ No       | Not supported by this integration                                          |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ✅ Yes      | Door events trigger automatic check-ins                                    |
| **Mobile app access**      | ❌ No       | Physical cards/PIN codes required for access                               |
| **Remote door unlock**     | ❌ No       | Unlike cloud systems like ACT365, Doorflow requires physical credentials   |

## How It Works

### Access Control Model

Doorflow uses a **group-based** model to manage access permissions:

* **People** represent individuals in the system (mapped to Nexudus customers)
* **Groups** define collections of doors that people can access
* **Sites** organize door controllers within your Doorflow account
* **Controllers** manage individual doors or access points
* **Tokens** are physical RFID cards assigned to people

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their person record in Doorflow with the appropriate group memberships.

### Multi-Door Support

Doorflow uses **groups** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Doorflow, create a group (e.g., "24/7 Access")
2. Add the relevant doors to that group in Doorflow
3. In Nexudus, map your pass/resource/desk to that group
4. Customers with that pass automatically get access to all doors in the group

<Note>
  You must configure which doors belong to each group in the Doorflow platform. Nexudus assigns customers to groups, but the door-to-group mapping is managed in Doorflow.
</Note>

## Prerequisites

Before connecting Nexudus to Doorflow, ensure you have:

1. **Active Doorflow account** with administrator access
2. **OAuth2 credentials** from Doorflow (obtained during connection process)
3. **Doorflow system configured** with door controllers installed and online
4. **Groups created** in Doorflow for different access levels (e.g., 24/7 access, business hours only)
5. **Nexudus location configured** with plans, passes, and resources

<Note>
  Doorflow uses OAuth2 for secure authentication. When you connect the integration, you'll be redirected to Doorflow to authorize access. No manual API key entry is required.
</Note>

## Configuration

### Step 1: Connect to Doorflow

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Doorflow** in the list and click **Connect**
3. You'll be redirected to the Doorflow authorization page
4. Sign in with your Doorflow administrator credentials
5. Review the permissions requested by Nexudus:
   * Read account and person information
   * Manage people (create, update, delete)
   * Read events for check-in tracking
   * Read sites and controllers
6. Click **Authorize** to grant access
7. You'll be redirected back to Nexudus with the connection established

Once connected, Nexudus can read your Doorflow sites, door controllers, and groups.

<Note>
  The OAuth2 connection uses secure tokens that are automatically refreshed. You won't need to re-authorize unless you explicitly disconnect the integration or revoke access in Doorflow.
</Note>

### Step 2: Select Site for Check-in Tracking

If you want door events to trigger automatic check-ins, select which Doorflow site to monitor:

1. In the **Check in customers at** dropdown, select the Doorflow site
2. Leave blank if you don't want automatic check-ins from door events
3. If you have multiple sites, you can only track check-ins for one site at a time

<Note>
  Check-in tracking requires event processing. Nexudus syncs door events every 12 minutes and triggers the appropriate check-in action based on your controller configuration.
</Note>

### Step 3: Select Site for Configuration

Before mapping passes, resources, and desks, you must select which Doorflow site to configure:

1. In the **Doorflow site** dropdown, select your site
2. Once selected, the configuration panels for controllers, resources, passes, and desks will load

This step is necessary because Doorflow accounts can manage multiple sites, and each site has its own controllers and groups.

### Step 4: Configure Presence Tracking (Optional)

Doorflow can trigger automatic check-ins when customers unlock specific doors.

1. In the **Presence tracking** section, you'll see all door controllers from your selected site
2. For each controller, choose an action:
   * **Nothing**: Door access is tracked in Doorflow but doesn't affect Nexudus
   * **Check In**: Unlocking this door checks the customer in
   * **Check Out**: Unlocking this door checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance to **Check In**
* Set the exit door to **Check Out**
* Set internal doors to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires event processing. Nexudus syncs door events every 12 minutes. There may be a delay between a door unlock and the check-in appearing in Nexudus.
</Note>

### Step 5: Map Passes to Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Doorflow group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the **Doorflow access group** from the dropdown
   * The dropdown shows all groups available in your Doorflow site
   * Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Doorflow group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Doorflow Group | Purpose                            |
| ------------------- | -------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members   | Round-the-clock building access    |
| Business Hours Pass | Business Hours | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms  | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to Doorflow groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Doorflow access
</Warning>

### Step 6: Map Resources to Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select a **Doorflow access group** from the dropdown
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Doorflow Group  | Purpose                            |
| ----------------- | --------------- | ---------------------------------- |
| Conference Room A | Meeting Room A  | Access to specific meeting room    |
| Event Space       | Event Hall      | Access to event space for bookings |
| Private Office    | Private Offices | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 7: Map Desks/Units to Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks / Offices** section, you'll see all desks from your floor plans
2. For each desk, select a **Doorflow access group** from the dropdown
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Doorflow Group         | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Doorflow access.
</Warning>

### Step 8: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Doorflow access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Doorflow groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Doorflow group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration

### When Access is Revoked

Nexudus automatically revokes Doorflow access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Doorflow groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Doorflow group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all Doorflow access removed
6. **Check-in expires**: If customer checks out or check-in expires, certain temporary access may be revoked

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Debouncing**: Rapid changes to the same customer are batched together (5-second delay) to prevent excessive API calls
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Event processing**: Door events are synced every 12 minutes for check-in tracking

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## RFID Card Management

Doorflow supports traditional RFID access cards with optional PIN code support. To assign cards to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678` (up to 4 cards)
5. Optionally, set a PIN code in the **Access PIN Code** field
6. Save the customer profile

**Card behavior:**

* **No card**: Person exists in Doorflow but cannot unlock doors (no physical credentials)
* **Card assigned**: Customer can use physical RFID card to unlock doors
* **PIN code set**: Customer can use card + PIN for enhanced security
* **Card removed**: Physical access is revoked (person record remains in system)

**Card numbering:**

* Only numeric card IDs are supported
* Non-numeric cards are automatically filtered out
* Cards are stored in the Doorflow person record

<Note>
  Unlike cloud-based systems like ACT365 that support mobile access via the Nexudus Passport app, Doorflow requires physical RFID cards or PIN codes. Customers cannot unlock doors remotely.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Doorflow groups
       * **Solution**: Go to Settings > Integrations > Doorflow and select a group for the relevant passes

    2. **Group no longer exists**: The selected group was deleted from Doorflow
       * **Solution**: Select a different group or recreate the group in Doorflow, then reconnect the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **Person not created**: The customer wasn't created in Doorflow
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Group permissions**: The Doorflow group exists but isn't assigned to any doors
       * **Solution**: In Doorflow, verify the group includes the correct door controllers

    6. **No card assigned**: Customer exists in Doorflow but has no physical credentials
       * **Solution**: Assign an RFID card in the customer's Access Card ID field

    7. **Wrong site selected**: The customer's passes are mapped to groups in a different Doorflow site
       * **Solution**: Verify you've selected the correct site in the configuration
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to a Doorflow group
       * **Solution**: Map the resource to a group in Settings > Integrations > Doorflow

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **Wrong site**: Resource is mapped to a group in a different Doorflow site
       * **Solution**: Ensure resource is mapped to a group in the correct site
  </Accordion>

  <Accordion title="Check-ins not created from door events">
    **Possible causes:**

    1. **Controller action not configured**: Door controller is set to "Nothing" instead of a check-in action
       * **Solution**: Configure the controller action in Settings > Integrations > Doorflow

    2. **Wrong site selected for check-ins**: The "Check in customers at" setting points to a different site
       * **Solution**: Ensure the correct site is selected for check-in tracking

    3. **Sync delay**: Background task runs every 12 minutes
       * **Solution**: Wait up to 12 minutes for the next event sync cycle

    4. **Event processing disabled**: Background processing may be temporarily paused
       * **Solution**: Wait for the next sync cycle or check server status
  </Accordion>

  <Accordion title="Cannot connect to Doorflow">
    **Possible causes:**

    1. **OAuth2 authorization failed**: You denied permission or the authorization expired
       * **Solution**: Click Disconnect, then Connect again to restart the OAuth2 flow

    2. **Doorflow account access**: Your Doorflow account doesn't have admin permissions
       * **Solution**: Ensure you're signing in with an administrator account

    3. **Network connectivity**: Unable to reach Doorflow API servers
       * **Solution**: Check your internet connection and try again

    4. **Authorization revoked in Doorflow**: You manually revoked Nexudus access in Doorflow settings
       * **Solution**: Reconnect the integration from Nexudus
  </Accordion>

  <Accordion title="Configuration panels not loading">
    **Possible causes:**

    1. **Site not selected**: You haven't selected a Doorflow site from the dropdown
       * **Solution**: Select your site from the "Doorflow site" dropdown

    2. **No controllers or groups**: The selected site has no controllers or groups configured
       * **Solution**: Configure controllers and groups in Doorflow, then refresh the integration

    3. **Connection lost**: OAuth2 token expired or was revoked
       * **Solution**: Disconnect and reconnect the integration
  </Accordion>

  <Accordion title="Duplicate email address error">
    **Possible causes:**

    1. **Email already exists in Doorflow**: Another person in Doorflow already uses this email
       * **Solution**: Nexudus will automatically use a unique email (`no-reply+doorflow_{customerId}@nexudus.com`) to avoid conflicts

    2. **Company and individual records**: Customer has both company and individual records with the same email
       * **Solution**: Nexudus automatically prioritizes the individual record and skips company records
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: OAuth2 token expired or invalid
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid group mappings
* **Synchronization problems**: Delays or failures in updating access permissions
* **API rate limiting**: Too many requests to Doorflow API (30 requests per minute limit)

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations with exponential backoff. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Doorflow

When provisioning access, Nexudus shares the following information with Doorflow:

* **Customer data**: First name, last name, email address, mobile phone
* **System ID**: Nexudus customer ID prefixed with "NX" (used to link records between systems)
* **RFID cards**: Card IDs from the Access Card ID field
* **PIN codes**: Access PIN codes if configured

Nexudus **does not** share:

* Billing information
* Payment details
* Contract specifics (only group assignments)
* Personal notes or custom fields

### External ID Management

* **Customers**: `SystemId` set to `NX{coworkerId}` (e.g., `NX12345`)
* **Lookup**: People are retrieved via system ID to prevent duplicates
* **Email conflicts**: If email already exists in Doorflow, Nexudus uses `no-reply+doorflow_{coworkerId}@nexudus.com`

### API Rate Limiting

* **Rate limit**: 30 requests per minute per username
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers
* **Debouncing**: Multiple rapid changes to a customer are batched together (5-second delay)
* **Background processing**: Updates are queued to avoid overwhelming the Doorflow API

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Group Organization

Create groups based on access levels, not products or plans:

* ✅ **Good**: "24/7 Access", "Business Hours", "Meeting Rooms", "Private Offices"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Multi-Site Management

If you have multiple Doorflow sites:

* Configure passes, resources, and desks separately for each site
* Select the appropriate site before mapping inventory
* Only one site can be monitored for check-in tracking at a time

### Access Signature Tracking

* Nexudus tracks an "access signature" for each customer (a hash of their group memberships)
* Access updates are skipped if the signature hasn't changed
* This prevents unnecessary API calls and improves performance

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URL**: `https://api.doorflow.com/api/3/` (OAuth2 version) or `https://api.doorflow.com/api/2/` (Basic Auth version)
  * **Authentication**: OAuth2 Authorization Code flow (preferred) or Basic Authentication (legacy)
  * **OAuth2 endpoints**:
    * Authorization: `https://admin.doorflow.com/oauth/authorize`
    * Token: `https://api.doorflow.com/oauth/token`
  * **Token type**: Bearer token (OAuth2) or Basic Auth (username/password)
  * **Rate limiting**: 30 requests per minute per username (semaphore-based across multiple servers)
  * **Scope**: `account.person.readonly account.person account.event.readonly account.site.readonly account.channel.readonly`

  ### Key Endpoints

  * **People**: `/api/3/account/people` (GET, POST, PUT, DELETE)
  * **Groups**: `/api/3/account/groups` (GET)
  * **Sites**: `/api/3/account/sites` (GET)
  * **Controllers**: `/api/3/sites/{siteId}/channels` (GET)
  * **Events**: `/api/3/account/events?from={date}&limit=1000` (GET)
  * **Person by System ID**: `/api/3/account/people?system_id={systemId}` (GET)
  * **Person by Email**: `/api/3/account/people?email={email}` (GET)

  ### Synchronization

  * **Access updates**: Debounced by 5 seconds per customer to batch rapid changes
  * **Background task**: Polls door events every 12 minutes for check-in tracking
  * **Event query**: Retrieves up to 1000 events from last sync date
  * **Event limit**: Maximum 1000 events per request
  * **Distributed locking**: Prevents race conditions in multi-server deployments (`doorflow:coworker:{coworkerId}`)
  * **User provisioning**: Lazy creation on first inventory assignment
  * **Person updates**: Created/updated/deleted as inventory changes
  * **Access signature hashing**: Prevents unnecessary API calls when access hasn't changed

  ### External IDs

  * **Customers**: `system_id` set to `NX{coworkerId}` (e.g., `NX12345`)
  * **Lookup**: People retrieved via `/api/3/account/people?system_id=NX{coworkerId}`
  * **Email conflicts**: If email exists, fallback to `no-reply+doorflow_{coworkerId}@nexudus.com`

  ### Person Model

  ```json theme={null}
  {
    "id": 12345,
    "system_id": "NX67890",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "mobile": "+1234567890",
    "groups": [1, 2, 3],
    "tokens": [
      {
        "number": "123456",
        "pin": "1234",
        "active_from": "2000-01-01",
        "active_until": "2500-01-01"
      }
    ]
  }
  ```

  ### RFID Card Management

  * **Card ID field**: Comma-separated numeric IDs in `AccessCardID` field (up to 4 cards)
  * **Non-numeric cards**: Automatically filtered out
  * **No cards**: Person exists in Doorflow but has no physical credentials
  * **Card assignment**: Tokens added to person record with validity dates

  ### Business Settings Reference

  | Setting                                   | Purpose                                                          |
  | ----------------------------------------- | ---------------------------------------------------------------- |
  | `DoorGuard.Enable`                        | Integration enabled flag ("true"/"false")                        |
  | `DoorGuard.ApiToken`                      | API token for Basic Auth (legacy, V1 only)                       |
  | `DoorGuard.SpaceGroupId`                  | Legacy setting (not used in V2)                                  |
  | `Doorflow.CheckinSiteId`                  | Site ID for check-in event processing                            |
  | `DoorGuard.Controller.Id_{doorId}.Action` | Check-in action per controller (Nothing/CheckIn/CheckOut/Toggle) |
  | `DoorGuard.LastEventDate`                 | Last processed event timestamp (ISO 8601)                        |

  ### OAuth2 Settings (App Config)

  | Setting                | Purpose              |
  | ---------------------- | -------------------- |
  | `DoorFlow.ClientId`    | OAuth2 client ID     |
  | `DoorFlow.Secret`      | OAuth2 client secret |
  | `DoorFlow.CallbackUrl` | OAuth2 redirect URI  |

  ### Contract-Based Desk Access

  * Desk access determined by active contracts: `coworker.ActiveContracts().SelectMany(x => x.Desks)`
  * **Team billing support**: Customer receives access to desks in paying member's contracts
  * **Multi-location organizations**: Access groups managed per location
  * **Desk mapping**: Each desk mapped to a single group ID

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Groups**: Aggregated list of unique group IDs
  7. **Person provisioning**: Create/update person with aggregated groups
  8. **Card status**: Add/update tokens if cards exist

  ### Event Processing

  * **Event format**: JSON array of event objects
  * **Event date format**: ISO 8601 (e.g., "2024-12-25T14:30:00Z")
  * **Event retention**: Events processed from `lastEventDate`, limited to last 24 hours if gap > 1 day
  * **Pagination**: Results returned in batches of up to 1000
  * **Check-in trigger**: Only "open" events with matching controller configuration
  * **Site filtering**: Events filtered by `Doorflow.CheckinSiteId` setting

  ### Error Handling

  * **Authentication failures**: OAuth2 tokens automatically refreshed
  * **Provisioning errors**: Automatic retry with exponential backoff (5 attempts, 60-second delays)
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Distributed locks**: Prevent concurrent updates to same customer (`doorflow:coworker:{coworkerId}`)
  * **Rate limit handling**: Requests queued with semaphore-based rate limiting

  ### Background Jobs

  * **Queue**: `doorflow` (standard priority) or `1_critical` (high priority)
  * **Debouncing**: 5-second debounce per customer to batch rapid changes
  * **Retry policy**: 5 attempts with 60-second delays between retries
  * **Transaction scope**: Each update runs in its own database transaction (read uncommitted isolation level)

  ### Duplicate Email Handling

  * **Primary lookup**: By system ID (`NX{coworkerId}`)
  * **Secondary lookup**: By email address
  * **Conflict resolution**: If email exists for different person, use `no-reply+doorflow_{coworkerId}@nexudus.com`
  * **Company vs Individual**: Individual records take precedence over company records

  ### Company vs Individual Records

  * **Check**: If customer is a company and an individual record exists with same email
  * **Behavior**: Skip company record, schedule update for individual record instead
  * **Delay**: 5-second delay before processing individual record
  * **Logging**: Warning logged when company record is skipped
</Accordion>


# Gallagher
Source: https://learn.nexudus.com/platform/access-control/integrations/gallagher

Connect Nexudus with Gallagher's on-premises Command Centre access control system through a secure cloud gateway to automate door access based on plans, passes, bookings, and desk assignments

# Gallagher Access Control Integration

## Overview

Gallagher Command Centre is an enterprise-grade on-premises access control platform that provides comprehensive physical security management. Through Gallagher's cloud gateway service, Nexudus can connect to your on-premises Command Centre server to automate credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **On-premises control**: Your Command Centre server remains on your local network
* **Cloud gateway connectivity**: Gallagher's cloud service bridges Nexudus to your on-premises server
* **Multi-region support**: Cloud gateway available in US and AU regions for optimal performance
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Check-in tracking**: Use access zone events to automatically check customers in/out
* **RFID card support**: Multiple RFID cards per customer with configurable card types
* **Group-based permissions**: Map your inventory (passes, resources, desks) to Gallagher access groups
* **Booking-based temporary access**: Automatic access during reservation windows
* **PIN code support**: Optional user code (PIN) for enhanced security

### Integration Type

**On-premises with cloud gateway** — Gallagher Command Centre runs on your local network as an on-premises server. Gallagher provides a cloud gateway service that securely connects Nexudus to your on-premises server without requiring you to open firewall ports or expose your server directly to the internet. The cloud API endpoints are hosted regionally at `commandcentre-api-us.security.gallagher.cloud` or `commandcentre-api-au.security.gallagher.cloud`.

<Note>
  The cloud gateway must be configured by Gallagher before Nexudus can connect to your on-premises Command Centre server. This setup ensures secure communication without compromising your network security.
</Note>

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                      |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                |
| **Visitor access**         | ❌ No       | Not supported by this integration                                          |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ✅ Yes      | Access zone events trigger automatic check-ins                             |
| **Mobile app access**      | ❌ No       | Physical cards/PIN codes required for access                               |
| **Remote door unlock**     | ❌ No       | Physical credentials required for access                                   |

## How It Works

### Access Control Model

Gallagher uses an **access group** model to manage access permissions:

* **Cardholders** represent individuals in the system (mapped to Nexudus customers)
* **Access Groups** define collections of doors that cardholders can access
* **Access Zones** are physical areas monitored for check-in/check-out events
* **Cards** are physical RFID credentials assigned to cardholders
* **Divisions** organize cardholders within your Gallagher account

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their cardholder record in Gallagher with the appropriate access group memberships.

### Multi-Door Support

Gallagher uses **access groups** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Gallagher Command Centre, create an access group (e.g., "24/7 Access")
2. Add the relevant doors to that group in Gallagher
3. In Nexudus, map your pass/resource/desk to that group
4. Customers with that pass automatically get access to all doors in the group

<Note>
  You must configure which doors belong to each access group in the Gallagher Command Centre platform. Nexudus assigns customers to groups, but the door-to-group mapping is managed in Gallagher.
</Note>

## Prerequisites

Before connecting Nexudus to Gallagher, ensure you have:

1. **Gallagher Command Centre server** installed and operational at your location
2. **Cloud gateway configured** — Gallagher must set up the cloud gateway connection to your on-premises server
3. **API key** obtained from Gallagher (used for authentication through the cloud gateway)
4. **Division ID** — The identifier for your organizational division
5. **Card Type ID** — The card type to use when provisioning cards
6. **Region selection** — US or AU based on your cloud gateway region
7. **Gallagher system configured** with access groups and access zones
8. **Nexudus location configured** with plans, passes, and resources

<Warning>
  **Important**: The cloud gateway must be configured by Gallagher support before you can connect Nexudus. The cloud gateway creates a secure tunnel between Nexudus and your on-premises Command Centre server without requiring you to open firewall ports or expose your server to the internet.
</Warning>

<Note>
  Contact Gallagher support to request cloud gateway setup and obtain your API key, Division ID, and Card Type ID.
</Note>

## Configuration

### Step 1: Request Cloud Gateway Setup from Gallagher

Before you can connect Nexudus to your Gallagher Command Centre server, you must request cloud gateway setup from Gallagher support:

1. **Contact Gallagher support** and request cloud gateway setup for Nexudus integration
2. **Provide your details**: Share your on-premises Command Centre server information
3. **Select region**: Choose US or AU based on your location (affects latency)
4. **Receive credentials**: Gallagher will provide:
   * API key for authentication
   * Division ID
   * Card Type ID
   * Confirmation that the cloud gateway is configured and ready

<Note>
  The cloud gateway setup typically takes 1-2 business days. Gallagher will create a secure tunnel between their cloud API and your on-premises server, allowing Nexudus to communicate with your system without exposing it to the internet.
</Note>

### Step 2: Connect Nexudus to Gallagher

Once the cloud gateway is configured by Gallagher:

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Gallagher** in the list of integrations
3. Enable the **Enable Gallagher integration** toggle
4. Enter the connection details provided by Gallagher:
   * **API Key**: Your Gallagher Command Centre API key
   * **Region**: Select **US** or **AU** based on the cloud gateway region configured by Gallagher
   * **Division ID**: The numeric ID of your division in Gallagher
   * **Card Type ID**: The ID of the card type to use when creating cards
   * **Issue Level**: The security level for cards (typically 0 for standard access)
5. Click **Save** to establish the connection

Once saved and connected successfully, the configuration panels for access zones, passes, resources, and desks will appear below.

<Warning>
  If the connection fails, verify with Gallagher support that the cloud gateway has been properly configured and is online. The API key must match the gateway configuration.
</Warning>

### Step 3: Configure Presence Tracking (Optional)

Gallagher can trigger automatic check-ins when customers access specific zones.

1. In the **Presence tracking** section, you'll see all access zones from your Gallagher system
2. For each zone, choose an action:
   * **Nothing**: Zone access is tracked in Gallagher but doesn't affect Nexudus
   * **Check In**: Accessing this zone checks the customer in
   * **Check Out**: Accessing this zone checks the customer out
   * **Toggle**: Accessing switches between checked in and checked out

**Common scenarios:**

* Set the main entrance zone to **Check In**
* Set the exit zone to **Check Out**
* Set internal zones to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires event processing. Nexudus syncs access zone events every 9 minutes. Configure which event types to process using the `Gallagher.AccessEventTypes` setting.
</Note>

### Step 4: Map Passes to Access Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Gallagher access group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select a **Gallagher access group** from the dropdown
   * The dropdown shows all access groups available in your Gallagher system
   * Access groups are automatically retrieved when you save the connection settings
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Gallagher access group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Gallagher Access Group | Purpose                            |
| ------------------- | ---------------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members           | Round-the-clock building access    |
| Business Hours Pass | Business Hours         | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms          | Access to meeting room zones       |

<Note>
  Access groups are automatically retrieved from your Gallagher system. If you don't see a group in the dropdown, verify it exists in Gallagher and re-save your connection settings to refresh the list.
</Note>

<Warning>
  Plans are **not** directly mapped to access groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to access groups (selected from dropdown)
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Gallagher access
</Warning>

### Step 5: Map Resources to Access Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select a **Gallagher access group** from the dropdown
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Gallagher Access Group | Purpose                            |
| ----------------- | ---------------------- | ---------------------------------- |
| Conference Room A | Meeting Room A         | Access to specific meeting room    |
| Event Space       | Event Hall             | Access to event space for bookings |
| Private Office    | Private Offices        | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 6: Map Desks/Units to Access Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks / Offices** section, you'll see all desks from your floor plans
2. For each desk, select a **Gallagher access group** from the dropdown
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Gallagher Access Group | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Gallagher access.
</Warning>

### Step 7: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Gallagher access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Gallagher access groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Gallagher access group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration

### When Access is Revoked

Nexudus automatically revokes Gallagher access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Gallagher access groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Gallagher access group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all Gallagher access removed

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Debouncing**: Rapid changes to the same customer are batched together (5-second delay) to prevent excessive API calls
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## RFID Card Management

Gallagher supports traditional RFID access cards with optional PIN code (user code) support. To assign cards to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678`
5. Optionally, set a PIN code in the **Access PIN Code** field (if enabled)
6. Save the customer profile

**Card behavior:**

* **No card**: Cardholder exists in Gallagher but cannot unlock doors (no physical credentials)
* **Card assigned**: Customer can use physical RFID card to unlock doors
* **PIN code set**: Customer can use user code (PIN) if the feature is enabled
* **Card removed**: Physical access is revoked (cardholder record remains in system)

**Card configuration:**

* **Card Type**: Configured globally using the `Gallagher.CardType` setting
* **Issue Level**: Configured globally using the `Gallagher.IssueLevel` setting (default: 0)
* **User Code (PIN)**: Enable by setting `Gallagher.SetUserCode` to `true`

<Note>
  Unlike cloud-based systems with mobile app support, Gallagher requires physical RFID cards or PIN codes. Customers cannot unlock doors remotely via a mobile app in this integration.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Gallagher access groups
       * **Solution**: Go to Settings > Integrations > Gallagher and select an access group for the relevant passes

    2. **Access group no longer exists**: The selected access group was deleted from Gallagher
       * **Solution**: Select a different group or recreate the group in Gallagher, then refresh the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **Cardholder not created**: The customer wasn't created in Gallagher
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Access group permissions**: The Gallagher access group exists but isn't assigned to any doors
       * **Solution**: In Gallagher Command Centre, verify the access group includes the correct door controllers

    6. **No card assigned**: Customer exists in Gallagher but has no physical credentials
       * **Solution**: Assign an RFID card in the customer's Access Card ID field

    7. **Wrong region**: API key is for a different region (US vs AU)
       * **Solution**: Verify you've selected the correct region in the integration settings

    8. **Division mismatch**: Cardholder created in wrong division
       * **Solution**: Verify the Division ID setting matches your intended division in Gallagher
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to a Gallagher access group
       * **Solution**: Select an access group for the resource in Settings > Integrations > Gallagher

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **No card assigned**: Customer has no physical card to use
       * **Solution**: Assign an RFID card to the customer's profile
  </Accordion>

  <Accordion title="RFID cards not working">
    **Possible causes:**

    1. **Card Type ID incorrect**: The configured card type doesn't match your Gallagher system
       * **Solution**: Verify the `Gallagher.CardType` setting matches a valid card type ID in your Gallagher system

    2. **Card not synced**: Recent card changes haven't been synced to Gallagher
       * **Solution**: Wait a few minutes for sync, or manually trigger by editing and saving the customer profile

    3. **Cardholder inactive**: Customer's cardholder record is marked as unauthorised
       * **Solution**: Verify customer has active passes/contracts that grant access

    4. **Issue Level mismatch**: Card issue level doesn't match door requirements
       * **Solution**: Check the `Gallagher.IssueLevel` setting and door controller requirements

    5. **Card reader issue**: Physical hardware problem
       * **Solution**: Test cards on different readers to isolate hardware issues
  </Accordion>

  <Accordion title="Check-ins not created from zone events">
    **Possible causes:**

    1. **Zone action not configured**: Access zone is set to "Nothing" instead of a check-in action
       * **Solution**: Configure the zone action in Settings > Integrations > Gallagher

    2. **Event types not configured**: The `Gallagher.AccessEventTypes` setting is missing or incorrect
       * **Solution**: Configure which event types to process (contact Gallagher support for event type IDs)

    3. **Sync delay**: Background task runs every 9 minutes
       * **Solution**: Wait up to 9 minutes for the next event sync cycle

    4. **Cardholder description format**: Customer ID not found in cardholder description
       * **Solution**: Verify cardholder descriptions follow the format `NX-{customerId}`
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Cloud gateway not configured**: Gallagher hasn't completed the cloud gateway setup
       * **Solution**: Contact Gallagher support to verify the cloud gateway is configured and online for your on-premises server

    2. **Invalid API key**: The API key is incorrect or has been revoked
       * **Solution**: Obtain a new API key from Gallagher and update in Settings > Integrations > Gallagher

    3. **Wrong region**: API key is for a different region than selected
       * **Solution**: Verify which cloud gateway region Gallagher configured (US or AU) and select the matching region in Nexudus

    4. **On-premises server offline**: Your Command Centre server is not running or unreachable
       * **Solution**: Verify your on-premises Command Centre server is running and accessible from your local network

    5. **API key permissions**: API key doesn't have sufficient permissions
       * **Solution**: Ensure the API key has full cardholder and access group management permissions

    6. **Network connectivity**: Unable to reach Gallagher cloud API gateway
       * **Solution**: Check your internet connection and verify no firewall is blocking access to `*.gallagher.cloud`
  </Accordion>

  <Accordion title="Access group assignments not updating">
    **Possible causes:**

    1. **Access group deleted**: Group was selected but has since been deleted from Gallagher
       * **Solution**: Recreate the group in Gallagher or select a different group in Nexudus

    2. **Stale group list**: Available groups not refreshed after changes in Gallagher
       * **Solution**: Re-save your connection settings to refresh the group list from Gallagher

    3. **API rate limiting**: Too many requests to Gallagher API
       * **Solution**: Wait a few minutes and try again; background jobs will continue processing

    4. **Division mismatch**: Access groups from different division
       * **Solution**: Ensure access groups exist in the division specified by your Division ID setting
  </Accordion>

  <Accordion title="Duplicate email address error">
    **Possible causes:**

    1. **Email already exists in Gallagher**: Another cardholder already uses this email
       * **Solution**: Gallagher uses description field with format `NX-{customerId}` for lookups, not email. The system will find the existing cardholder by description instead.

    2. **Company and individual records**: Customer has both company and individual records with the same email
       * **Solution**: Nexudus automatically prioritizes the individual record and processes it first
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid or expired API keys
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid access group mappings
* **Synchronization problems**: Delays or failures in updating access permissions
* **Event processing errors**: Issues reading or processing access zone events

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations with exponential backoff (60 attempts with 60-second delays). If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Gallagher

When provisioning access, Nexudus shares the following information with Gallagher:

* **Customer data**: First name, last name
* **Description**: Format `NX-{customerId}` (used to link records between systems)
* **RFID cards**: Card IDs from the Access Card ID field
* **User Code**: PIN code from the Access PIN Code field (if enabled)
* **Division**: Organizational division for the cardholder

Nexudus **does not** share:

* Email addresses
* Phone numbers
* Billing information
* Payment details
* CoCloud gateway\*\*: API key authenticates through Gallagher's cloud gateway, which securely connects to your on-premises server
* **HTTPS encryption**: All communication uses HTTPS (TLS)
* **No scheme prefix**: API key sent directly in the Authorization header value
* **Regional endpoints**: API calls routed to US or AU cloud gateway based on configuration
* **No firewall changes**: Cloud gateway connects outbound from your server to Gallagher's cloud, requiring no inbound firewall rules

### API Authentication

* **API Key**: Header-based authentication using custom API key
* **HTTPS encryption**: All communication uses HTTPS (TLS)
* **No scheme prefix**: API key sent directly in the Authorization header value
* **Regional endpoints**: API calls routed to US or AU endpoints based on configuration

### External ID Management

* **Description field**: Format `NX-{customerId}` (e.g., `NX-12345`)
* **Lookup method**: Cardholders retrieved by searching the description field
* **Uniqueness**: Description ensures each Nexudus customer maps to one cardholder

<Warning>
  Keep your Gallagher API key secure. Do not share it publicly or commit it to version control. If compromised, immediately revoke it in Gallagher and generate a new one.
</Warning>

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Access Group Organization

Create access groups in Gallagher based on access levels, not products or plans:

* ✅ **Good**: "24/7 Access", "Business Hours", "Meeting Rooms", "Private Offices"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Multi-Location Management

If you have multiple Nexudus locations using the same Gallagher system:

* Each location can map to the same or different access groups
* The integration handles multiple locations mapping to the same groups automatically
* Use clear naming in Gallagher to distinguish between locations if needed

### Division Structure

* Use divisions in Gallagher to organize cardholders by location or organizational unit
* All cardholders from a Nexudus location will be created in the configured division
* Ensure access groups are accessible from the division you specify

### Card Type Configuration

* Configure a default card type that matches your physical RFID cards
* Use the same card type across all customers unless you have specific security requirements
* Set the issue level appropriately based on your security policies

### User Code (PIN) Support

* Enable user codes only if your Gallagher deployment supports them
* SeDeployment\*\*: On-premises Command Centre server with cloud gateway
* **Base URL**: `https://commandcentre-api-us.security.gallagher.cloud` or `https://commandcentre-api-au.security.gallagher.cloud`
* **Authentication**: Header Value Authentication (API key in Authorization header)
* **API Format**: JSON
* **Content Type**: `application/json`
* **Regional routing**: US or AU based on `Gallagher.Region` setting
* **Gateway connection**: Cloud API acts as secure proxy to your on-premises server
* **Network requirements**: Outbound HTTPS connection from Command Centre server to Gallagher cloud (no inbound ports required)

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URL**: `https://commandcentre-api-us.security.gallagher.cloud` or `https://commandcentre-api-au.security.gallagher.cloud`
  * **Authentication**: Header Value Authentication (API key in Authorization header)
  * **API Format**: JSON
  * **Content Type**: `application/json`
  * **Regional routing**: US or AU based on `Gallagher.Region` setting

  ### Key Endpoints

  * **Cardholders**:
    * GET `/api/cardholders?description="{description}"&fields=accessGroups.href,id,description,shortName,cards.number,cards.href` - Search by description
    * GET `/api/cardholders/{id}` - Get full cardholder record
    * POST `/api/cardholders` - Create cardholder
    * PATCH `/api/cardholders/{id}` - Update cardholder (partial updates)

  * **Access Groups**:
    * GET `/api/access_groups?fields=id,name,href&top=1000` - List all access groups

  * **Access Zones**:
    * GET `/api/access_zones?fields=id,name,href&top=1000` - List all access zones

  * **Events**:
    * GET `/api/events?type={eventTypes}&from={isoDate}` - Get events after a date

  ### Cardholder Model

  ```json theme={null}
  {
    "firstName": "John",
    "lastName": "Doe",
    "description": "NX-12345",
    "authorised": true,
    "usercode": "1234",
    "division": {
      "href": "https://commandcentre-api-us.security.gallagher.cloud/api/divisions/1"
    },
    "cards": [
      {
        "number": "123456",
        "type": {
          "href": "https://commandcentre-api-us.security.gallagher.cloud/api/card_types/1"
        },
        "issueLevel": 0
      }
    ],
    "accessGroups": [
      {
        "accessGroup": {
          "id": "10",
          "name": "24/7 Access",
          "href": "https://commandcentre-api-us.security.gallagher.cloud/api/access_groups/10"
        },
        "href": "..."
      }
    ]
  }
  ```

  ### Update Model (PATCH)

  ```json theme={null}
  {
    "firstName": "John",
    "lastName": "Doe",
    "authorised": true,
    "usercode": "1234",
    "cards": {
      "add": [
        {
          "number": "789012",
          "type": {
            "href": ".../api/card_types/1"
          },
          "issueLevel": 0
        }
      ],
      "remove": [
        {
          "href": ".../api/cards/456"
        }
      ]
    },
    "accessGroups": {
      "add": [
        {
          "accessGroup": {
            "href": ".../api/access_groups/20"
          }
        }
      ],
      "remove": [
        {
          "href": ".../api/cardholders/1/access_groups/10"
        }
      ]
    }
  }
  ```

  ### Business Settings Reference

  | Setting                                   | Purpose                                                    |
  | ----------------------------------------- | ---------------------------------------------------------- |
  | `Gallagher.Enabled`                       | Integration enabled flag ("true"/"false")                  |
  | `Gallagher.ApiKey`                        | API key for authentication                                 |
  | `Gallagher.Region`                        | Region selection ("US" or "AU")                            |
  | `Gallagher.Division`                      | Division ID for cardholders                                |
  | `Gallagher.CardType`                      | Card type ID for new cards                                 |
  | `Gallagher.IssueLevel`                    | Card issue level (default: 0)                              |
  | `Gallagher.SetUserCode`                   | Enable PIN code sync ("true"/"false")                      |
  | `Gallagher.LastEventDate`                 | Last processed event timestamp (ISO 8601)                  |
  | `Gallagher.AccessEventTypes`              | Event types to process (comma-separated)                   |
  | `Gallagher.Controller.Id_{zoneId}.Action` | Check-in action per zone (Nothing/CheckIn/CheckOut/Toggle) |

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Access groups**: Aggregated list of unique group IDs
  7. **Cardholder provisioning**: Create/update cardholder with aggregated groups
  8. **Card management**: Add/remove cards based on AccessCardID field
  9. **Authorization status**: Authorised=true if customer has any groups

  ### External IDs

  * **Description format**: `NX-{coworkerId}` (e.g., `NX-12345`)
  * **Lookup**: Search by description field using exact match
  * **Cardholder ID**: Gallagher-assigned ID, stored separately from Nexudus ID

  ### Card Management Logic

  * **Multiple cards**: Comma-separated list in AccessCardID field
  * **Card sync**: Existing cards compared with current AccessCardID
  * **Add operation**: New cards added via `cards.add` array
  * **Remove operation**: Missing cards removed via `cards.remove` array with href
  * **No cards**: If AccessCardID is empty, all cards are removed
  * **Card properties**: Type and IssueLevel applied to all cards

  ### Access Group Management

  * **Add operation**: Missing groups added via `accessGroups.add` array
  * **Remove operation**: Extra groups removed via `accessGroups.remove` array with href
  * **Group href format**: Full URL to access group resource
  * **Validation**: Invalid group IDs filtered out before sync

  ### Event Processing

  * **Interval**: Background task runs every 9 minutes
  * **Event query**: Events retrieved from `lastEventDate` (ISO 8601 format)
  * **Event retention**: Limited to last 24 hours if gap > 1 day
  * **Event types**: Configurable via `Gallagher.AccessEventTypes` setting
  * **Cardholder lookup**: Extract customer ID from description field (format: `NX-{id}`)
  * **Check-in trigger**: Only events matching configured zone actions
  * **Business validation**: Customer must be registered with the business

  ### Error Handling

  * **Authentication failures**: Logged and integration disabled
  * **Provisioning errors**: Automatic retry with exponential backoff (60 attempts, 60-second delays)
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Distributed locks**: Prevent concurrent updates to same customer (`GALLAGHER:coworker:{coworkerId}`)
  * **Event system**: Raises AccessControlEventData for error tracking

  ### Performance Optimization

  * **Debouncing**: 5-second debounce prevents rapid repeated updates for same customer
  * **Semaphore**: ProcessGallagherBusiness limited to 50 concurrent executions
  * **Access signature**: Hash of group memberships prevents unnecessary updates
  * **Batch processing**: Events processed in bulk per business

  ### Multi-Location Support

  * **Cross-location groups**: System handles customers with groups from multiple locations
  * **Group validation**: Only groups from current Gallagher system included in updates
  * **External groups detection**: UI shows warning if customer has groups from other locations

  ### Region Configuration

  * **US endpoint**: `https://commandcentre-api-us.security.gallagher.cloud`
  * **AU endpoint**: `https://commandcentre-api-au.security.gallagher.cloud`
  * **Selection**: Based on `Gallagher.Region` setting ("US" or "AU")
  * **Default**: US if not specified

  ### Queue Management

  * **Critical queue**: `1_critical` for immediate access updates
  * **Access control queue**: `1_access_control` for standard updates
  * **High priority queue**: `2_high` for event processing
  * **Low priority queue**: `4_low` for business-level processing

  ### Company vs Individual Records

  * **Check**: If customer is a company and an individual record exists with same email
  * **Behavior**: Individual records processed first (ordered by CoworkerType and CreatedOn)
  * **Email handling**: All records with same email processed together
</Accordion>


# Genetec
Source: https://learn.nexudus.com/platform/access-control/integrations/genetec

Connect Nexudus with Genetec's cloud-based Security Center to automate door access based on plans, passes, bookings, and desk assignments

# Genetec Access Control Integration

## Overview

Genetec Security Center is an enterprise-grade unified security platform that provides physical access control, video surveillance, and other security management features through an on-premise installation. The Nexudus integration with Genetec automates cardholder provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **Cloud-based management**: Manage access through Genetec Security Center's web interface
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **RFID card support**: Single RFID card per customer with facility code configuration
* **PIN code support**: Optional PIN codes for keypad access
* **Group-based permissions**: Map your inventory (passes, resources, desks) to Genetec cardholder groups
* **Booking-based temporary access**: Automatic access during reservation windows
* **Partition support**: Multi-site organizations can configure default partitions

### Integration Type

**On-premise with Bridge Support** — Genetec Security Center is installed on-premise at your location. Nexudus connects via Genetec's REST API using either:

* **Network Bridge**: Secure tunnel through `https://bridge.nexudus.com/{device_id}/WebSdk/`
* **Port Forwarding**: Direct connection to `http://public_ip:4590/WebSdk/` (requires firewall configuration)

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                      |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                |
| **Visitor access**         | ❌ No       | Not supported by this integration                                          |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ❌ No       | Door events are not processed for automatic check-ins                      |
| **Mobile app access**      | ❌ No       | No mobile app integration available                                        |
| **Remote door unlock**     | ❌ No       | Physical cards/PIN codes required for access                               |

## How It Works

### Access Control Model

Genetec uses a **cardholder group** model to manage access permissions:

* **Cardholders** represent individuals in the system (mapped to Nexudus customers)
* **Cardholder Groups** define collections of doors that cardholders can access
* **Credentials** are physical access methods (RFID cards, PIN codes) linked to cardholders
* **Partitions** organize entities within multi-site Genetec deployments

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically updates their cardholder record in Genetec with the appropriate group memberships.

### Multi-Door Support

Genetec uses **cardholder groups** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Genetec Security Center, create a cardholder group (e.g., "24/7 Building Access")
2. Add the relevant doors to that group in Genetec
3. In Nexudus, select that group from the dropdown when mapping your pass/resource/desk
4. Customers with that pass automatically get access to all doors in the group

<Note>
  You must configure which doors belong to each group in the Genetec Security Center platform. Nexudus assigns customers to groups by selecting from the available groups retrieved from your Genetec system. The door-to-group mapping is managed in Genetec.
</Note>

## Prerequisites

Before connecting Nexudus to Genetec, ensure you have:

1. **Genetec Security Center installed on-premise** with administrator access
2. **API credentials** (username and password for API authentication)
3. **Network connectivity** — Either:
   * **Network Bridge configured**: Device ID from your [Nexudus Network Bridge](/integrations/network-bridge) installation
   * **Port forwarding configured**: Public IP address with port 4590 forwarded to your Genetec server
4. **Genetec system configured** with door controllers installed and online
5. **Cardholder groups created** in Genetec for different access levels (e.g., 24/7 access, business hours only)
6. **Nexudus location configured** with plans, passes, and resources
7. **(Optional) Default partition GUID** if using Genetec's partition feature for multi-site organizations

## Configuration

### Step 1: Connect to Genetec

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Genetec** in the list and expand the settings
3. Enable the **Enable Genetec integration** toggle
4. Enter your connection details (fields appear when toggle is enabled):
   * **Genetec server address**: Choose one of the following:
     * **Network Bridge**: `https://bridge.nexudus.com/{DEVICE_ID}/WebSdk/` (replace `{DEVICE_ID}` with your Bridge device ID)
     * **Port Forwarding**: `http://YOUR_PUBLIC_IP:4590/WebSdk/` (replace `YOUR_PUBLIC_IP` with your public IP address)
   * **Genetec username**: Your Genetec API username
   * **Genetec password**: Your Genetec API password
   * **Default partition** (optional): The GUID of the default partition for new cardholders (for multi-site Genetec deployments)
5. Click **Save** to establish the connection
6. Once connected successfully, the configuration panels for passes, resources, and desks will load below

<Note>
  The server URL must end with `/WebSdk/` to properly access the Genetec API. If using the Network Bridge, ensure your Bridge Agent is running and registered. If using port forwarding, ensure port 4590 is accessible from the internet.
</Note>

### Step 2: Map Passes to Cardholder Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Genetec cardholder group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select a **Genetec access group** from the dropdown menu
   * The dropdown shows all cardholder groups available in your connected Genetec system
   * Groups are automatically retrieved when you save the connection settings
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Genetec cardholder group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Genetec Group         | Purpose                            |
| ------------------- | --------------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Building Access  | Round-the-clock building access    |
| Business Hours Pass | Business Hours Access | Access only during operating hours |
| Meeting Room Pass   | Meeting Room Zones    | Access to meeting room areas       |

<Note>
  Cardholder groups are identified by GUID internally but displayed by name in the dropdown. If you don't see a group in the dropdown, verify it exists in Genetec Security Center and re-save your connection settings to refresh the list.
</Note>

<Warning>
  Plans are **not** directly mapped to cardholder groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to cardholder groups (selected from dropdown)
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Genetec access
</Warning>

### Step 3: Map Resources to Cardholder Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select a **Genetec access group** from the dropdown menu
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Genetec Group            | Purpose                            |
| ----------------- | ------------------------ | ---------------------------------- |
| Conference Room A | Conference Room A Access | Access to specific meeting room    |
| Event Space       | Event Hall Access        | Access to event space for bookings |
| Private Office    | Private Office Area      | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 4: Map Desks/Units to Cardholder Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select a **Genetec access group** from the dropdown menu
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Genetec Group          | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A Access     | Access to dedicated desk zone A           |
| Studio #5             | Studio Access Area     | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Genetec access.
</Warning>

### Step 5: Save Configuration

1. Review all mappings to ensure they're correct
2. Verify group selections match your intended access levels
3. Click **Save** to apply the configuration
4. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Genetec access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Genetec cardholder groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Genetec cardholder group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration

### When Access is Revoked

Nexudus automatically revokes Genetec access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Genetec cardholder groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Genetec cardholder group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated in Nexudus → cardholder is deactivated in Genetec

### Cardholder Activation Status

Genetec cardholders can be in two states:

* **Active**: Cardholder has at least one group assignment and credentials configured
* **Inactive**: Cardholder has no group assignments or credentials have been removed

Nexudus automatically activates cardholders when they gain access to any groups, and deactivates them when all access is removed.

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## RFID Card and PIN Management

Genetec supports both RFID access cards and PIN codes for physical access.

### Assigning RFID Cards

To assign an RFID card to a customer:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter the following:
   * **Access Card ID**: The card number (e.g., `12345`)
   * **Key Fob Number**: The facility code (e.g., `100`)
4. Save the customer profile

**Card credential format:**

* Genetec uses the **Wiegand Corporate 1000** format by default
* Format: `WiegandCorporate1000CredentialFormat(facilityCode, cardNumber)`
* Both facility code and card number are required

**Single card only:**
Unlike some other systems, Genetec integration supports **one card per customer**. If you need to replace a card, simply update the Access Card ID field.

### Assigning PIN Codes

To assign a PIN code for keypad access:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter a PIN code in the **Access PIN Code** field (e.g., `1234`)
4. Save the customer profile

**PIN behavior:**

* PIN codes are separate credentials from RFID cards
* A customer can have both a card and a PIN code
* PINs are stored as "Keypad" credential type in Genetec
* Removing the PIN code from Nexudus deletes the PIN credential in Genetec

### Credential Management Logic

When you save a customer profile, Nexudus:

1. **Creates cardholder**: If the customer doesn't exist in Genetec (lookup by email)
2. **Updates cardholder**: Updates first name, last name, and email if cardholder exists
3. **Manages card credential**:
   * If card ID is present: Creates or updates the "UndecodedWiegand" credential
   * If card ID is removed: Deletes the card credential
4. **Manages PIN credential**:
   * If PIN is present: Creates or updates the "Keypad" credential
   * If PIN is removed: Deletes the PIN credential
5. **Updates group memberships**: Adds/removes cardholder from groups based on passes, bookings, and desk assignments

<Note>
  Credentials are separate entities in Genetec linked to cardholders. When updating a card or PIN, Nexudus deletes the old credential and creates a new one with the updated values.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Genetec cardholder groups
       * **Solution**: Go to Settings > Integrations > Genetec and select a cardholder group for the relevant passes

    2. **Group no longer exists**: The selected group was deleted from Genetec Security Center
       * **Solution**: Select a different group or recreate the group in Genetec, then refresh the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **Cardholder not created**: The customer wasn't created in Genetec
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Group permissions**: The Genetec cardholder group exists but isn't assigned to any doors
       * **Solution**: In Genetec Security Center, verify the cardholder group includes the correct door controllers

    6. **No credentials assigned**: Customer exists in Genetec but has no card or PIN
       * **Solution**: Assign an RFID card or PIN code in the customer's profile fields

    7. **Cardholder inactive**: Customer's cardholder record is deactivated in Genetec
       * **Solution**: Verify customer has active passes/contracts that grant access; Nexudus should automatically activate the cardholder
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to a Genetec cardholder group
       * **Solution**: Select a cardholder group for the resource in Settings > Integrations > Genetec

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **No credentials assigned**: Customer has no physical card or PIN to use
       * **Solution**: Assign an RFID card or PIN code to the customer's profile
  </Accordion>

  <Accordion title="RFID cards or PINs not working">
    **Possible causes:**

    1. **Missing facility code**: Key Fob Number (facility code) not configured
       * **Solution**: Ensure both Access Card ID and Key Fob Number fields are filled in the customer profile

    2. **Credential format mismatch**: Genetec reader expects a different card format
       * **Solution**: Verify your Genetec system uses Wiegand Corporate 1000 format; contact Genetec support if using a different format

    3. **Credential not synced**: Recent changes haven't been synced to Genetec
       * **Solution**: Wait a few minutes for sync, or manually trigger by editing and saving the customer profile

    4. **Cardholder inactive**: Customer's cardholder is deactivated in Genetec
       * **Solution**: Verify customer has active passes/contracts; Nexudus should automatically activate them

    5. **Card reader issue**: Physical hardware problem
       * **Solution**: Test cards on different readers to isolate hardware issues
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Incorrect server URL**: The Genetec server URL is incorrect or missing `/WebSdk/` endpoint
       * **Solution**: Verify the server URL follows one of these formats:
         * Network Bridge: `https://bridge.nexudus.com/{DEVICE_ID}/WebSdk/`
         * Port Forwarding: `http://YOUR_PUBLIC_IP:4590/WebSdk/`

    2. **Invalid credentials**: Username or password is incorrect
       * **Solution**: Verify credentials have administrative access in Genetec Security Center

    3. **API access disabled**: Your Genetec account doesn't have API access enabled
       * **Solution**: Contact Genetec support to enable API access for your account

    4. **Network connectivity**: Firewall or network issue preventing connection
       * **Solution**: If using port forwarding, verify port 4590 is accessible from the internet. If using Network Bridge, verify the Bridge Agent is running and connected to Nexudus

    5. **License key issue**: Genetec API license key not configured correctly
       * **Solution**: Nexudus uses dedicated API keys embedded in the integration; contact Nexudus support if you see licensing errors
  </Accordion>

  <Accordion title="Cardholder groups not appearing in dropdown">
    **Possible causes:**

    1. **Connection not saved**: Settings haven't been saved to retrieve groups
       * **Solution**: Save the connection settings (server URL, username, password) to retrieve groups from Genetec

    2. **No groups created**: No cardholder groups exist in Genetec Security Center
       * **Solution**: Create cardholder groups in Genetec Security Center, then re-save your Nexudus integration settings

    3. **API permissions**: Genetec user doesn't have permission to read cardholder groups
       * **Solution**: Ensure the API user has administrator permissions in Genetec

    4. **Connection error**: Authentication or network error preventing group retrieval
       * **Solution**: Check connection status and verify credentials are correct
  </Accordion>

  <Accordion title="Customer created but access not granted">
    **Possible causes:**

    1. **Groups not assigned**: Customer's passes/bookings/desks aren't mapped to Genetec groups
       * **Solution**: Map passes, resources, and desks to cardholder groups in Settings > Integrations > Genetec

    2. **Signature unchanged**: Access hasn't changed since last update (optimization)
       * **Solution**: This is normal behavior; if access genuinely changed, save the customer profile to force an update

    3. **Background job delay**: Access update is queued but not yet processed
       * **Solution**: Wait a few minutes for background jobs to process

    4. **Error during provisioning**: API call to Genetec failed
       * **Solution**: Check Business Checkup page for error details
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid credentials or connection errors
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid cardholder group mappings
* **Credential errors**: Failed attempts to create or update cards/PINs

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Genetec

When provisioning access, Nexudus shares the following information with Genetec:

* **Customer data**: First name, last name, email address
* **Credentials**: Card IDs, facility codes, PIN codes
* **External ID**: Nexudus uses the customer's email as the lookup key

Nexudus **does not** share:

* Phone numbers (unless part of customer name fields)
* Billing information
* Payment details
* Contract specifics (only cardholder group assignments)
* Personal notes or custom fields

### Network Security

* **HTTPS encryption**: All communication uses HTTPS (SSL/TLS)
* **Basic authentication**: Username and password sent with each request (over HTTPS)
* **API keys**: Nexudus uses dedicated license keys for Genetec API access
* **Distributed locking**: Prevents race conditions and concurrent updates to the same customer

### Credential Management

* **Physical cards**: Managed in both Nexudus and Genetec; always assign through Nexudus
* **PIN codes**: Stored in Nexudus and synced to Genetec
* **User passwords**: Never shared with Nexudus; authentication is handled by Genetec

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Cardholder Group Organization

Create cardholder groups in Genetec based on access levels, not products or plans:

* ✅ **Good**: "24/7 Building Access", "Business Hours Access", "Meeting Room Zones", "Private Office Areas"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Naming Conventions

* Create descriptive cardholder group names in Genetec that make them easy to identify in the dropdown
* Avoid overly long group names that are difficult to read in the admin panel
* Document group-to-door mappings in Genetec for future reference

### Card Management

* Use consistent facility codes across all cards at a location
* Keep facility code and card number separate (don't combine into Access Card ID)
* Document your facility code for future card provisioning
* Test new cards immediately after provisioning to ensure proper configuration

### Partition Configuration

* If using Genetec partitions for multi-site organizations, configure the Default Partition setting
* Partition GUID should match your primary partition in Genetec Security Center
* All cardholders created by Nexudus will be assigned to this partition

### Access Signature Optimization

* Nexudus uses access signatures to avoid unnecessary API calls
* An access signature is a hash of all groups a customer should have access to
* If the signature hasn't changed, Nexudus skips the update
* This optimization reduces API traffic and improves performance

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Protocol**: HTTPS REST API
  * **Authentication**: HTTP Basic Authentication (username/password)
  * **API Format**: Query-string based parameters (not JSON body)
  * **Base URL**: Configured per business with two options:
    * Network Bridge: `https://bridge.nexudus.com/{DEVICE_ID}/WebSdk/`
    * Port Forwarding: `http://PUBLIC_IP:4590/WebSdk/`
  * **License Keys**: Embedded in integration (Debug and Production keys)

  ### Key Endpoints

  * **Cardholders**:
    * GET `/report/CardholderConfiguration?q=EmailSearchMode=Is,Email={email}` - Find cardholder by email
    * GET `/entity/{guid}` - Get cardholder by GUID
    * POST `/entity?q=entity=NewEntity(Cardholder),Name={name},FirstName={fn},LastName={ln},EmailAddress={email},Status.Activate(),Guid,Name,FirstName,LastName,EmailAddress,State,Groups,Parents,Credentials` - Create cardholder
    * POST `/entity?q=entity={guid},Name={name},FirstName={fn},LastName={ln},EmailAddress={email},Guid,Name,FirstName,LastName,EmailAddress,State,Groups,Parents,Credentials` - Update cardholder
    * POST `/entity?q=entity={guid},Status.Activate()` - Activate cardholder
    * POST `/entity?q=entity={guid},Status.Deactivate()` - Deactivate cardholder
    * DELETE `/entity/{guid}` - Delete cardholder

  * **Cardholder Groups**:
    * GET `/report/EntityConfiguration?q=EntityTypes@CardholderGroup` - List all cardholder groups
    * GET `/entity/{guid}` - Get cardholder group by GUID
    * POST `/entity?q=entity={groupGuid},Members@({cardholderGuid})` - Add member to group
    * POST `/entity?q=entity={groupGuid},Members-({cardholderGuid})` - Remove member from group

  * **Credentials**:
    * GET `/entity/{guid}` - Get credential by GUID
    * POST `/entity?q=entity=NewEntity(Credential),Cardholder={cardholderGuid},Format=KeypadCredentialFormat({pin}),State=Active` - Create PIN credential
    * POST `/entity?q=entity=NewEntity(Credential),Cardholder={cardholderGuid},Format=WiegandCorporate1000CredentialFormat({facilityCode},{cardNumber}),State=Active` - Create card credential
    * DELETE `/entity/{guid}` - Delete credential

  * **Creation Partition**:
    * POST `/creationpartition/{partitionGuid}` - Set default partition for new entities

  ### Cardholder Model

  ```json theme={null}
  {
    "Id": "guid",
    "Name": "First Last",
    "FirstName": "First",
    "LastName": "Last",
    "EmailAddress": "email@example.com",
    "State": "Active",
    "Groups": [],
    "Parents": ["guid1", "guid2"],
    "Credentials": ["credentialGuid1", "credentialGuid2"]
  }
  ```

  **Key fields:**

  * **Parents**: Array of GUIDs representing cardholder groups this cardholder belongs to
  * **Credentials**: Array of GUIDs representing credentials (cards, PINs) assigned to this cardholder
  * **State**: "Active" or "Inactive"

  ### Credential Model

  ```json theme={null}
  {
    "Id": "guid",
    "CardHolder": { "Id": "cardholderGuid" },
    "Type": "Keypad" | "UndecodedWiegand",
    "State": "Active"
  }
  ```

  **Credential types:**

  * **Keypad**: PIN code credential (format: `KeypadCredentialFormat({pin})`)
  * **UndecodedWiegand**: RFID card credential (format: `WiegandCorporate1000CredentialFormat({facilityCode},{cardNumber})`)

  ### Cardholder Group Model

  ```json theme={null}
  {
    "Id": "guid",
    "Name": "Group Name"
  }
  ```

  ### Business Settings Reference

  | Setting                    | Purpose                                                                                                                                                                                         |
  | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `Genetec.Enabled`          | Integration enabled flag ("true"/"false")                                                                                                                                                       |
  | `Genetec.ServerURL`        | Base URL of Genetec Security Center with `/WebSdk/` endpoint. Use either Network Bridge (`https://bridge.nexudus.com/{DEVICE_ID}/WebSdk/`) or port forwarding (`http://PUBLIC_IP:4590/WebSdk/`) |
  | `Genetec.Username`         | API username for authentication (appended with license key)                                                                                                                                     |
  | `Genetec.Password`         | API password for authentication                                                                                                                                                                 |
  | `Genetec.DefaultPartition` | GUID of default partition for new cardholders (optional)                                                                                                                                        |

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Group collection**: Aggregated list of unique cardholder group GUIDs
  7. **Access signature**: Hash of sorted group GUIDs to detect changes
  8. **Skip if unchanged**: If signature matches previous signature, skip update
  9. **Cardholder provisioning**: Create or update cardholder with new information
  10. **Credential management**: Create/update/delete card and PIN credentials
  11. **Group membership sync**: Compare current groups to target groups, add/remove as needed
  12. **Activation status**: Activate if groups exist, deactivate if no groups

  ### External ID System

  * **Lookup key**: Email address is used to find existing cardholders
  * **Create if not found**: New cardholder created if email doesn't exist
  * **No numeric external ID**: Unlike some integrations, Genetec uses email as the unique identifier

  ### Error Handling

  * **Authentication failures**: Logged to business log entries
  * **Provisioning errors**: Automatic retry with distributed locking
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Event system**: OnExceptionHandler raises AccessControlEventData for error tracking
  * **Credential errors**: Separate error handling for card vs. PIN creation/update

  ### Credential Management Logic

  When updating cardholders:

  1. **Fetch current credentials**: Get list of credential GUIDs from cardholder
  2. **Identify credential types**:
     * "Keypad" = PIN credential
     * "UndecodedWiegand" = Card credential
  3. **PIN logic**:
     * If `AccessPincode` is empty and PIN exists: Delete PIN credential
     * If `AccessPincode` is present and PIN exists: Delete old PIN, create new PIN
     * If `AccessPincode` is present and PIN doesn't exist: Create new PIN
  4. **Card logic**:
     * If `AccessCardId` is empty and card exists: Delete card credential
     * If `AccessCardId` is present and card exists: Delete old card, create new card
     * If `AccessCardId` is present and card doesn't exist: Create new card

  <Note>
    Credentials are updated by deleting and recreating rather than in-place updates. This ensures credential format changes are properly applied.
  </Note>

  ### Performance Optimization

  * **Debouncing**: 5-second debounce prevents rapid repeated updates for same customer
  * **Access signature hashing**: Skips API calls when access hasn't changed
  * **Distributed locking**: Prevents concurrent updates to same customer across servers
  * **Background jobs**: Queued in Hangfire for non-blocking execution
  * **Priority queue**: Critical updates use `1_critical` queue for faster processing

  ### License Key Integration

  The integration includes embedded license keys for Genetec API access:

  * **Debug key**: `KxsD11z743Hf5Gq9mv3+5ekxzemlCiUXkTFY5ba1NOGcLCmGstt2n0zYE9NsNimv`
  * **Production key**: `Ww9c2Z9pMRjeMAluH1V7UgCViwOedGiHJ98YwOwBRi8SkEW1TE2cc8B3WY6zlK7r`

  The license key is automatically appended to the username with a semicolon separator based on build configuration.

  ### API Response Formats

  Genetec API uses nested response objects:

  ```json theme={null}
  {
    "Response": {
      "Result": {
        // Actual entity data here
      }
    }
  }
  ```

  For reports/lists:

  ```json theme={null}
  {
    "Results": [
      {
        "Guid": "entity-guid",
        "Name": "Entity Name"
      }
    ]
  }
  ```
</Accordion>


# Kisi
Source: https://learn.nexudus.com/platform/access-control/integrations/kisi

Connect Nexudus with Kisi's cloud-based access control platform to automate door access based on plans, passes, and bookings

# Kisi Access Control Integration

## Overview

Kisi is a cloud-based access control platform that enables modern, keyless physical access management. The Nexudus integration with Kisi automates user provisioning and access group assignments based on customer contracts, passes, and bookings.

### Key Features

* **Cloud-based management**: Manage access through Kisi's web platform and mobile app
* **Mobile access**: Customers can use the Nexudus Passport app to unlock doors remotely
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Check-in tracking**: Door unlock events automatically check customers in/out
* **Group-based permissions**: Map your inventory (passes, resources) to Kisi groups
* **Booking-based temporary access**: Automatic access during reservation windows
* **Booking guest access**: Customers added as booking guests receive access during booking periods

### Integration Type

**Cloud-based** — Kisi operates entirely in the cloud with no on-premises server requirements. The platform uses a REST API at `https://api.getkisi.com`.

### Capabilities

| Feature                    | Supported  | Notes                                                                      |
| -------------------------- | ---------- | -------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                      |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                         |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                |
| **Desk/unit-based access** | ❌ No       | Not supported by this integration                                          |
| **Visitor access**         | ❌ No       | Not supported by this integration                                          |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows |
| **Check-in tracking**      | ✅ Yes      | Door unlock events trigger automatic check-ins                             |
| **Mobile app access**      | ✅ Yes      | Nexudus Passport app integration                                           |
| **Remote door unlock**     | ✅ Yes      | Customers can unlock doors without being physically present                |

## How It Works

### Access Control Model

Kisi uses a **group-based** model to manage access permissions:

* **Users** represent individuals in the system (mapped to Nexudus customers)
* **Groups** define collections of locks (doors) that users can access
* **Role Assignments** link users to groups with specific permissions
* **Locks** are individual access points managed by Kisi controllers
* **Places** organize locks within your Kisi account

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, or their contract renews), the integration automatically creates or updates their user record in Kisi and assigns them to the appropriate groups.

### Multi-Door Support

Kisi uses **groups** to grant permissions to multiple locks. Instead of mapping each lock individually:

1. In Kisi, create a group (e.g., "24/7 Building Access")
2. Add the relevant locks to that group in Kisi
3. In Nexudus, map your pass/resource to that group
4. Customers with that pass automatically get access to all locks in the group

<Note>
  You must configure which locks belong to each group in the Kisi platform. Nexudus assigns customers to groups, but the lock-to-group mapping is managed in Kisi.
</Note>

## Prerequisites

Before connecting Nexudus to Kisi, ensure you have:

1. **Active Kisi account** with administrator access
2. **Kisi API token** obtained from your Kisi account settings
3. **Kisi system configured** with lock controllers installed and online
4. **Groups created** in Kisi for different access levels (e.g., 24/7 access, business hours only)
5. **Nexudus location configured** with plans, passes, and resources

### Obtaining Your Kisi API Token

To get your API token from Kisi:

1. Log in to your Kisi account at [web.getkisi.com](https://web.getkisi.com)
2. Go to **Settings** > **API**
3. Generate a new API token or copy your existing token
4. Keep this token secure - you'll need it for the Nexudus integration

## Configuration

### Step 1: Connect to Kisi

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Kisi** in the list and click to expand the settings
3. Enable the **Enable Kisi integration** toggle
4. Enter your **Kisi API Token** in the API token field
5. (Optional) Configure **No access policy** - choose whether to suspend or delete user accounts when they lose all access
6. (Optional) Enable **Notify customers by email** if you want Kisi to send welcome emails (not recommended)
7. Click **Save** to establish the connection

Once connected, Nexudus can read your Kisi groups and locks and begin provisioning access.

<Note>
  Your API token is stored securely and used for all API calls to Kisi. Never share your API token publicly.
</Note>

### Step 2: Configure Presence Tracking (Optional)

Kisi can trigger automatic check-ins when customers unlock specific doors.

1. In the **Presence Tracking** section, you'll see all locks from your Kisi account
2. For each lock, choose an action:
   * **Nothing**: Door access is tracked in Kisi but doesn't affect Nexudus
   * **Check In**: Unlocking this door checks the customer in
   * **Check Out**: Unlocking this door checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance to **Check In**
* Set the exit door to **Check Out**
* Set internal doors to **Nothing** (access granted but doesn't affect presence)

<Note>
  Check-in tracking requires event processing. Nexudus syncs door events approximately every 9 minutes and triggers the appropriate check-in action based on your configuration.
</Note>

### Step 3: Map Passes to Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Kisi group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the **Kisi access group** that customers should be assigned to when they hold that pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Kisi group, the customer is added to that group
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Kisi Group     | Purpose                            |
| ------------------- | -------------- | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members   | Round-the-clock building access    |
| Business Hours Pass | Business Hours | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms  | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Kisi access
</Warning>

### Step 4: Map Resources to Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select the **Kisi access group** required to access that space
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately
* **Booking guests**: If a customer is added as a guest to a booking, they also receive access during the booking window

**Example mapping:**

| Resource Name     | Kisi Group       | Purpose                            |
| ----------------- | ---------------- | ---------------------------------- |
| Conference Room A | Conference Rooms | Access to meeting room area        |
| Event Space       | Event Hall       | Access to event space for bookings |
| Private Office    | Private Offices  | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window (starting 15 minutes before), even if they don't hold a general access pass.
</Note>

### Step 5: Save Configuration

1. Review all mappings to ensure they're correct
2. Click **Save** to apply the configuration
3. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Kisi access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Kisi groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Kisi group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration
5. **Check-in with pass**: Customer checks in with a pass that grants access → maintains access during the check-in session

### When Access is Revoked

Nexudus automatically revokes Kisi access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Kisi groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Kisi group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Customer deactivated**: Customer account is deactivated → all Kisi access removed (user suspended or deleted based on configuration)
5. **Check-in expires**: If customer checks out, temporary access may be revoked

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs with 5-second debouncing to batch rapid changes
* **Event processing**: Door unlock events are synced approximately every 9 minutes for check-in tracking

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

### No Access Behavior

When a customer loses all access groups (no active passes, bookings, or contracts), Nexudus can handle their Kisi account in two ways:

**Suspend Account (Default)**

* The user's `access_enabled` flag is set to `false` in Kisi
* User record remains in Kisi but cannot unlock doors
* Access can be re-enabled if customer regains access
* Recommended for most use cases

**Delete Account**

* The user is completely removed from Kisi
* User record must be recreated if customer regains access
* Use this option if you need to comply with data retention policies

Configure this behavior in **Settings > Integrations > Kisi > No Access Behaviour**.

## Mobile App Experience

Customers can use the **Nexudus Passport** mobile app to unlock doors remotely.

### Setup for Customers

1. Customer downloads the **Nexudus Passport** app (iOS or Android)
2. Signs in with their Nexudus credentials
3. App detects Kisi integration is active
4. Customer can view available locks and unlock them remotely

### Using Mobile Access

1. Customer opens the Nexudus Passport app
2. Navigates to **Unlock Doors** section
3. Views list of locks they currently have access to
4. Taps **Unlock** to remotely unlock a door

### How It Works

When a customer attempts to unlock a door through the Nexudus Passport app:

1. App requests a device login token from Kisi via Nexudus API
2. Kisi creates a device login associated with the customer's email
3. Customer can then use the app to unlock doors they have group access to
4. No physical credentials (cards, fobs) are required

<Note>
  Mobile access is tied to the customer's email address in both Nexudus and Kisi. Ensure customer email addresses are accurate and up to date.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Kisi groups
       * **Solution**: Go to Settings > Integrations > Kisi and map the relevant passes to groups

    2. **Group no longer exists**: The selected group was deleted from Kisi
       * **Solution**: Recreate the group in Kisi, then refresh the integration by saving settings

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **User not created**: The customer wasn't created in Kisi
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **User suspended**: The customer's Kisi user is marked as `access_enabled: false`
       * **Solution**: User should regain access automatically when they receive a pass; check for integration errors

    6. **Mobile app not authorized**: Customer's device login hasn't been created
       * **Solution**: Customer should open Nexudus Passport app and trigger a new login request
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to a Kisi group
       * **Solution**: Map the resource to a group in Settings > Integrations > Kisi

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **User not in Kisi**: Customer doesn't exist in Kisi yet
       * **Solution**: System should auto-create user; check Business Checkup for errors
  </Accordion>

  <Accordion title="Mobile app showing no locks available">
    **Possible causes:**

    1. **No active access**: Customer doesn't have any passes or bookings that grant access
       * **Solution**: Verify customer has an active pass or upcoming booking mapped to Kisi groups

    2. **User not confirmed**: Customer's Kisi user account is unconfirmed
       * **Solution**: Nexudus creates users with `confirm: true`; check Kisi for user status

    3. **App not refreshed**: Lock list hasn't updated after access was granted
       * **Solution**: Customer should pull down to refresh the lock list in the app

    4. **Device login expired**: Customer's device login token has expired
       * **Solution**: Customer should sign out and sign back in to the Nexudus Passport app
  </Accordion>

  <Accordion title="Check-ins not created from door unlock events">
    **Possible causes:**

    1. **Door action not configured**: Lock is set to "Nothing" instead of a check-in action
       * **Solution**: Configure the lock action in Settings > Integrations > Kisi

    2. **Event processing delay**: Background task runs approximately every 9 minutes
       * **Solution**: Wait up to 9 minutes for the next event sync cycle

    3. **User not found**: Door event references a user not in Nexudus
       * **Solution**: Ensure the email address in Kisi matches the customer's email in Nexudus exactly

    4. **Place filter configured**: Events are filtered to a specific place ID
       * **Solution**: Check the `Kisi.CheckinPlaceId` setting; leave blank to process all events
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Invalid API token**: API token is incorrect or has been revoked
       * **Solution**: Generate a new API token in Kisi and update it in Nexudus settings

    2. **Account access denied**: Your Kisi account doesn't have sufficient permissions
       * **Solution**: Ensure the API token is from an administrator account with full access

    3. **API token expired**: The API token is no longer valid
       * **Solution**: Generate a new API token in Kisi and update it in Settings > Integrations > Kisi

    4. **Rate limiting**: Too many API requests in a short period
       * **Solution**: Wait a few minutes and try again; Nexudus implements rate limiting to prevent this
  </Accordion>

  <Accordion title="User appears multiple times in Kisi">
    **Cause:** Duplicate unconfirmed user accounts were created through legacy endpoints.

    **Solution:**

    * Nexudus automatically detects and deletes unconfirmed duplicate users
    * If issue persists, manually delete unconfirmed users in Kisi platform
    * Save customer profile in Nexudus to trigger a fresh sync
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid credentials or connection errors
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid group mappings
* **Synchronization problems**: Delays or failures in updating access permissions

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

### Auto-Disable on Authentication Failure

If Nexudus detects repeated authentication failures (invalid API token), the integration will be automatically disabled to prevent further errors. You'll need to:

1. Generate a new API token in your Kisi account
2. Re-enable the integration in Settings > Integrations > Kisi
3. Enter the new API token and save

## Security Considerations

### Data Shared with Kisi

When provisioning access, Nexudus shares the following information with Kisi:

* **Customer data**: Full name, email address
* **External ID**: None (users are looked up by email)
* **Notifications**: Optional flag to send welcome emails from Kisi

Nexudus **does not** share:

* Phone numbers
* Billing information
* Payment details
* Contract specifics (only group assignments)
* Personal notes or custom fields

### Network Security

* **HTTPS encryption**: All communication uses HTTPS (SSL/TLS)
* **Bearer token authentication**: API token sent with each request via Authorization header
* **Rate limiting**: Built-in rate limiting prevents API abuse (5 req/sec per org, 1 req/sec for events)
* **Integration identifiers**: Nexudus identifies itself to Kisi via custom headers

### Credential Management

* **No physical credentials**: Kisi is mobile-first; no RFID cards or PINs
* **Email-based identity**: Users are identified and managed by email address
* **Device logins**: Mobile app access uses device-specific login tokens
* **User passwords**: Never shared with Nexudus; authentication is handled by Kisi

## Advanced Configuration

### Notification Settings

Control whether Kisi sends notification emails to customers when they're added to groups:

* **Setting**: `Kisi.Notify` (business setting)
* **Default**: `false` (no notifications)
* **When enabled**: Kisi sends welcome emails and enables password login for customers

<Warning>
  Enabling notifications allows customers to create Kisi app accounts with passwords. This may bypass your intended access control flow. Leave disabled unless you specifically want customers to manage their Kisi access independently.
</Warning>

### Link Email Address

Control whether customer email addresses should be linked for login:

* **Setting**: `Kisi.LinkEmail` (business setting)
* **Default**: `false`
* **When enabled**: Customer email is used for Kisi login authentication

### Place Filtering

If your Kisi account has multiple places, you can filter event processing to a specific place:

* **Setting**: `Kisi.CheckinPlaceId` (business setting)
* **Default**: Empty (process all places)
* **Format**: Numeric place ID from Kisi

This is useful for multi-location businesses where each Nexudus location corresponds to a different Kisi place.

### Rate Limiting Key

Kisi requires an organization identifier for rate limiting:

* **Setting**: `Kisi.RateLimitingKey` (business setting)
* **Format**: Organization identifier from Kisi
* **Purpose**: Ensures API rate limits are applied correctly across distributed servers

<Note>
  This setting is automatically configured when you connect the integration. You typically don't need to modify it manually.
</Note>

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)
* [Nexudus Passport App](/platform/mobile/passport)

## Best Practices

### Group Organization

Create groups in Kisi based on access levels, not products or plans:

* ✅ **Good**: "24/7 Access", "Business Hours", "Meeting Rooms", "Private Offices"
* ❌ **Avoid**: "Hot Desk Plan", "Dedicated Desk Plan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Email Address Management

* Ensure customer email addresses are accurate and lowercase
* Kisi uses email as the primary identifier for users
* Duplicate emails will cause conflicts; ensure each customer has a unique email
* If a customer changes their email, update it in both Nexudus and Kisi

### Booking Access Timing

* Resource access is granted 15 minutes before booking start time
* This lead time ensures customers can access the space even if they arrive early
* Consider this timing when scheduling back-to-back bookings

### Event Processing Optimization

* Event processing runs approximately every 9 minutes
* Don't expect instant check-ins from door unlocks; allow up to 10 minutes
* For time-sensitive scenarios, use manual check-in or other methods

### Access Signature Optimization

Nexudus uses access signatures to avoid unnecessary API calls:

* An access signature is a hash of all groups a customer should have access to
* If the signature hasn't changed, Nexudus skips the update
* This optimization reduces API traffic and improves performance

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Base URL**: `https://api.getkisi.com`
  * **Authentication**: Bearer token (provided directly as API token from Kisi settings)
  * **API Format**: JSON REST API
  * **Rate limiting**:
    * 5 requests per second per organization
    * 1 request per second for `/events` endpoint
    * Enforced via semaphore-based rate limiter across multiple servers

  ### Key Endpoints

  * **Authentication**:
    * POST `/logins` - Create device login for mobile app (used by Nexudus Passport)

  * **Users**:
    * GET `/users?email={email}` - Find users by email
    * POST `/users` - Create new user
    * PUT `/users/{id}` - Update user
    * DELETE `/users/{id}` - Delete user

  * **Groups**:
    * GET `/groups` - List all groups (with pagination)

  * **Places**:
    * GET `/places` - List all places

  * **Locks**:
    * GET `/locks` - List all locks (with pagination)

  * **Role Assignments**:
    * GET `/role_assignments?user_id={userId}` - List user's group assignments
    * POST `/role_assignments` - Assign user to group
    * DELETE `/role_assignments/{id}` - Remove user from group

  * **Events**:
    * POST `/events/sets` - Create event set for processing
    * GET `/events/sets/{id}` - Retrieve event set results

  ### User Model

  ```json theme={null}
  {
    "id": 12345,
    "email": "customer@example.com",
    "name": "John Doe",
    "confirmed": true,
    "access_enabled": true,
    "password_flow_enabled": false,
    "otp_required_for_login": false,
    "groups_count": 2,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
  ```

  **Key fields:**

  * **confirmed**: Whether user has verified their email (Nexudus sets to `true`)
  * **access\_enabled**: Whether user can unlock doors (controlled by Nexudus)
  * **password\_flow\_enabled**: Whether user can log in with password (controlled by notification setting)

  ### Role Assignment Model

  ```json theme={null}
  {
    "id": 67890,
    "role_id": "group_basic",
    "group_id": 123,
    "user_id": 456,
    "notify": false
  }
  ```

  **Key fields:**

  * **role\_id**: Always "group\_basic" for standard group membership
  * **group\_id**: The Kisi group ID
  * **user\_id**: The Kisi user ID
  * **notify**: Whether to send notification emails

  ### Group Model

  ```json theme={null}
  {
    "id": 123,
    "name": "24/7 Building Access",
    "place_id": 789
  }
  ```

  ### Lock Model

  ```json theme={null}
  {
    "id": 456,
    "name": "Main Entrance",
    "place_id": 789,
    "action": 0
  }
  ```

  ### Event Model

  ```json theme={null}
  {
    "id": 11223344,
    "created_at": "2024-01-01T12:00:00Z",
    "actor_type": "User",
    "actor_id": 12345,
    "actor_name": "John Doe",
    "action": "unlock",
    "success": true,
    "object_id": 456,
    "references": [
      {"id": 789, "type": "Place"}
    ]
  }
  ```

  **Key fields:**

  * **actor\_id**: Kisi user ID who performed the action
  * **actor\_name**: Name of the user (used for logging)
  * **object\_id**: Lock ID that was unlocked
  * **success**: Whether unlock was successful (only successful events processed for check-ins)

  ### Business Settings Reference

  | Setting                              | Purpose                                                        |
  | ------------------------------------ | -------------------------------------------------------------- |
  | `Kisi.Enabled`                       | Integration enabled flag ("true"/"false")                      |
  | `Kisi.ApiToken`                      | Bearer token obtained from Kisi account settings               |
  | `Kisi.RateLimitingKey`               | Organization identifier for rate limiting                      |
  | `Kisi.Notify`                        | Send notification emails when adding users ("true"/"false")    |
  | `Kisi.LinkEmail`                     | Link email address for login ("true"/"false")                  |
  | `Kisi.NoAccessBehaviour`             | What to do when customer loses all access ("Suspend"/"Delete") |
  | `Kisi.CheckinPlaceId`                | Filter events to specific place ID (optional)                  |
  | `Kisi.PendingEventSetId`             | ID of event set being processed (internal state)               |
  | `Kisi.LastEventDate`                 | Last processed event timestamp (ISO 8601)                      |
  | `Kisi.Controller.Id_{lockId}.Action` | Check-in action per lock (Nothing/CheckIn/CheckOut/Toggle)     |

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Groups**: Aggregated list of unique group IDs from all sources
  6. **Access signature**: Hash of all group IDs to detect changes
  7. **User provisioning**: Create user if doesn't exist (lookup by email)
  8. **Role management**: Add missing group assignments, remove revoked groups
  9. **Status update**: Enable access if groups exist, suspend/delete if no groups

  ### Event Processing

  * **Task frequency**: Approximately every 9 minutes
  * **Event sets**: Kisi provides events in batches via event sets
  * **Pagination**: Uses cursor-based pagination for large result sets
  * **Place filtering**: Optional filtering by place ID
  * **Success filter**: Only successful unlock events trigger check-ins
  * **Date tracking**: Last event date stored to prevent reprocessing
  * **Ambiguity resolution**: If multiple customers have same email, uses heuristics to determine correct one
  * **Check-in actions**: Configurable per lock (check-in/check-out/toggle/nothing)

  ### Error Handling

  * **Authentication failures**: Auto-disable integration and log error
  * **User creation failures**: Log error and raise domain event for Business Checkup
  * **Rate limiting**: Automatic retry with exponential backoff (up to 5 attempts)
  * **Duplicate users**: Automatically delete unconfirmed duplicates
  * **Event processing errors**: Log and continue with next event
  * **Distributed locks**: Prevent concurrent updates to same customer

  ### Performance Optimization

  * **Debouncing**: 5-second debounce prevents rapid repeated updates for same customer
  * **Access signatures**: Skip API calls when access hasn't changed
  * **Rate limiting**: Prevents API overload with semaphore-based limiting
  * **Background processing**: All access updates run in Hangfire background jobs
  * **Distributed locking**: Ensures single-threaded access per customer across servers

  ### Integration Identifiers

  Nexudus identifies itself to Kisi via custom headers:

  * `X-Kisi-Integration-Identifier`: "Nexudus"
  * `X-Kisi-Integration-Contact`: "[support@nexudus.com](mailto:support@nexudus.com)"
  * `X-Kisi-Org-Identifier`: Rate limiting key

  ### Pagination Strategy

  * **Collections**: Use `X-Collection-Range` header for offset-based pagination
  * **Events**: Use `x-next-cursor` header for cursor-based pagination
  * **Default limit**: Kisi typically returns 100 items per page
</Accordion>


# Access Control Integrations
Source: https://learn.nexudus.com/platform/access-control/integrations/overview

Connect Nexudus with physical access control systems to automate door access based on memberships, passes, and bookings.

## Overview

Access control integrations connect Nexudus with physical smart locks and door controllers. When you integrate an access control system, Nexudus automatically provisions and manages access permissions based on your customers' active inventory — their plans, passes, bookings, and desk assignments.

## Why Access Control Matters

Access control systems solve three critical operational challenges:

### Extended Hours Access

Customers can access your space 24/7, even when your staff isn't physically present. This unlocks revenue opportunities from members who need off-hours access and improves the member experience.

### Enhanced Security

Only customers with valid Plans or resource bookings can unlock relevant doors. Access is automatically revoked when memberships expire, eliminating the need for manual key management or access card recalls.

### Accurate Occupancy Tracking

When customers unlock doors, they're automatically checked in to your Location. This provides real-time occupancy data for resources, desks, and offices — improving your understanding of space utilization.

### Pay-as-You-Go Revenue Stream

Combining occupancy tracking with pay-as-you-go passes unlocks an additional revenue stream for your Location. When customers run out of access passes, Nexudus can automatically sell them new passes as they attempt to access the building. This ensures seamless entry for customers while generating incremental revenue for your business.

Key benefits include:

* **Convenience for Customers** — Customers never have to worry about running out of passes, as new ones are automatically issued when needed.
* **Increased Revenue** — Every additional access attempt translates into a new pass sale, boosting your revenue without requiring manual intervention.
* **Improved Customer Retention** — The frictionless experience encourages customers to continue using your space, knowing they can always gain access when needed.
* **Real-Time Tracking** — Occupancy tracking ensures that every access attempt is logged, providing accurate data on space utilization and customer behavior.

<Note>
  Not all access control integrations support occupancy check-in and check-out. Refer to the comparison tables below to see which providers support this feature.
</Note>

## How Integrations Work

When connected, Nexudus handles three key workflows:

### 1. User Provisioning

When a customer is created or updated in Nexudus, their profile is automatically synchronized to your access control system. This creates their digital identity in the physical access system.

### 2. Access Assignment

When inventory changes (new contract, booking created, pass assigned), Nexudus calculates which doors the customer should access and updates permissions in real-time:

* **Plans** grant ongoing access to specified doors
* **Passes** provide time-limited access during valid hours
* **Bookings** grant temporary access during the booking window
* **Desks** provide access to specific zones or floors

### 3. Presence Tracking (Check-ins)

Door open events from your access control system automatically trigger check-ins in Nexudus, tracking when customers arrive and leave your space.

## Mapping Inventory to Doors

Each type of inventory can be mapped to one or more doors:

| Inventory Type | Access Pattern                       | Duration                 |
| -------------- | ------------------------------------ | ------------------------ |
| **Plans**      | Ongoing access to selected doors     | Active contract duration |
| **Passes**     | Time-bound access during valid hours | Pass validity window     |
| **Resources**  | Temporary access during booking      | Booking start/end time   |
| **Desks**      | Access to zones/floors               | Assignment duration      |

## Supported Integrations

### Cloud-Based Systems

<CardGroup>
  <Card title="ACT365" icon="cloud" href="/platform/access-control/integrations/act365">
    Cloud-based access control with mobile and RFID card support.
  </Card>

  <Card title="Avigilon Alta (OpenPath)" icon="cloud" href="/platform/access-control/integrations/avigilon-alta">
    Cloud-based platform with mobile credentials and no on-premises servers.
  </Card>

  <Card title="Brivo" icon="door-closed" href="/platform/access-control/integrations/brivo">
    Cloud-based access control with mobile app and multi-region support.
  </Card>

  <Card title="Doorflow" icon="cloud" href="/platform/access-control/integrations/doorflow">
    Cloud-based access control with RFID and PIN code support.
  </Card>

  <Card title="Kisi" icon="key" href="/platform/access-control/integrations/kisi">
    Modern keyless access control with mobile unlock.
  </Card>

  <Card title="Salto KS" icon="lock" href="/platform/access-control/integrations/saltov2">
    Wire-free smart locks with mobile keys and smart locker support.
  </Card>

  <Card title="SofiaLocks (Jago)" icon="mobile" href="/platform/access-control/integrations/sofialocks">
    Mobile-first smart lock system with credential-based access control.
  </Card>
</CardGroup>

### On-Premises & Hybrid Systems

<CardGroup>
  <Card title="Avigilon" icon="server" href="/platform/access-control/integrations/avigilon">
    Enterprise on-premises access control with LDAP architecture.
  </Card>

  <Card title="Gallagher" icon="building" href="/platform/access-control/integrations/gallagher">
    Enterprise on-premises Command Centre connected via cloud gateway.
  </Card>

  <Card title="Genetec" icon="shield" href="/platform/access-control/integrations/genetec">
    Unified security platform with access control and video surveillance.
  </Card>

  <Card title="Paxton NET2" icon="server" href="/platform/access-control/integrations/paxton-net2">
    On-premises access control with RFID tokens and area-based permissions.
  </Card>

  <Card title="UniFi Access" icon="network-wired" href="/platform/access-control/integrations/unifi-access">
    Ubiquiti's door control system integrated with UniFi ecosystem.
  </Card>
</CardGroup>

## Comparing Access Control Providers

Choose the right provider based on your Location's needs. Use the comparison tables below to understand the capabilities of each system.

### Access Methods

Different providers support different ways for customers to unlock doors:

| Provider                 | Supported Methods                                    |
| ------------------------ | ---------------------------------------------------- |
| ACT365                   | 💳 Cards, 📱 Mobile App\*, ⚙️ Automation Tiles       |
| Avigilon                 | 💳 Cards, 🔢 PIN                                     |
| Brivo                    | 💳 Cards, 📱 Mobile App, 🔢 PIN                      |
| Doordeck                 | 📱 Mobile App                                        |
| Doorflow                 | 💳 Cards, 🔢 PIN                                     |
| Gallagher                | 💳 Cards, 🔢 PIN                                     |
| Genetec                  | 💳 Cards, 🔢 PIN                                     |
| Kisi                     | 💳 Cards,📱 Mobile App                               |
| Avigilon Alta / OpenPath | 💳 Cards, 📱 Mobile App, 🔗 Via Link\*\*             |
| Padword                  | 💳 Cards, 📱 Mobile App, 🔢 PIN, ⚙️ Automation Tiles |
| Parakey                  | 💳 Cards,📱 Mobile App                               |
| Paxton NET2              | 💳 Cards, 📱 Mobile App, ⚙️ Automation Tiles         |
| Salto KS                 | 💳 Cards,📱 Mobile App, 🔢 PIN\*\*                   |
| SofiaLocks               | 📱 Mobile App, 🏷️ Lock Tags                         |
| Unifi Access             | 💳 Cards, 📱 Mobile App, 🔢 PIN, ⚙️ Automation Tiles |

\* Push to unlock
\*\* Visitors only

<Info>
  Automation Tiles let customers trigger door unlocks through the Passport App without requiring a dedicated SDK. Some
  providers support direct mobile unlocking within the app.
</Info>

### Transferred Entities

Different providers support transferring various Nexudus entities. In the table below, "Booking guests" refers to visitors added as part of a booking.

| Provider                 | Transferred entities                          |
| ------------------------ | --------------------------------------------- |
| ACT365                   | 👤 Customers                                  |
| Avigilon                 | 👤 Customers                                  |
| Brivo                    | 👤 Customers, 🗓️ Booking guests, 👥 Visitors |
| Doordeck                 | 👤 Customers, 🗓️ Booking guests              |
| Doorflow                 | 👤 Customers, 🗓️ Booking guests              |
| Gallagher                | 👤 Customers, 🗓️ Booking guests              |
| Genetec                  | 👤 Customers, 🗓️ Booking guests              |
| Kisi                     | 👤 Customers, 🗓️ Booking guests              |
| Avigilon Alta / OpenPath | 👤 Customers, 🗓️ Booking guests, 👥 Visitors |
| Padword                  | 👤 Customers, 🗓️ Booking guests              |
| Parakey                  | 👤 Customers, 🗓️ Booking guests              |
| Paxton NET2              | 👤 Customers, 🗓️ Booking guests              |
| Salto KS                 | 👤 Customers, 🗓️ Booking guests, 👥 Visitors |
| SofiaLocks               | 👤 Customers, 🗓️ Booking guests, 👥 Visitors |
| Unifi Access             | 👤 Customers, 🗓️ Booking guests              |

### Check-in Support

Some providers automatically check customers in when they unlock doors, improving occupancy accuracy:

| Provider      | Check-in |
| ------------- | :------: |
| ACT365        |     ✅    |
| Avigilon      |     ❌    |
| Brivo         |     ✅    |
| Doordeck      |     ❌    |
| Doorflow      |     ✅    |
| Gallagher     |     ✅    |
| Genetec       |     ❌    |
| Kisi          |     ✅    |
| Avigilon Alta |     ✅    |
| Padword       |     ✅    |
| Parakey       |     ❌    |
| Paxton NET2   |     ✅    |
| Salto KS      |     ✅    |
| SofiaLocks    |     ✅    |
| Unifi Access  |     ✅    |

### Nexudus Items Supported

All providers support linking access groups to the core Nexudus items. Some providers have limitations:

| Provider      | Supported Entities                                         |
| ------------- | ---------------------------------------------------------- |
| ACT365        | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Avigilon      | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Brivo         | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes, 👥 Visitors |
| Doordeck      | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Doorflow      | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Gallagher     | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Genetec       | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Kisi          | 🗓️ Bookings, 🛂 Passes                                    |
| Avigilon Alta | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes, 👥 Visitors |
| Padword       | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Parakey       | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Paxton NET2   | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |
| Salto KS      | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes, 👥 Visitors |
| SofiaLocks    | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes, 👥 Visitors |
| Unifi Access  | 🪑 Contracts & Units, 🗓️ Bookings, 🛂 Passes              |

### Cloud vs On-Premise

Consider your infrastructure preferences and whether you want to host the system yourself:

| Provider      | Deployment  |
| ------------- | ----------- |
| ACT365        | Cloud-based |
| Avigilon      | On-premise  |
| Brivo         | Cloud-based |
| Doordeck      | Cloud-based |
| Doorflow      | Cloud-based |
| Gallagher     | On-premise  |
| Genetec       | On-premise  |
| Kisi          | Cloud-based |
| Avigilon Alta | Cloud-based |
| Padword       | Cloud-based |
| Parakey       | Cloud-based |
| Paxton NET2   | On-premise  |
| Salto KS      | Cloud-based |
| SofiaLocks    | Cloud-based |
| Unifi Access  | On-premise  |

<Tip>On-premise systems can be connected to Nexudus using the [Nexudus Network Bridge](/integrations/network-bridge)</Tip>

### Nexudus Integration Costs

Nexudus charges a subscription fee for each access control integration. This is in addition to any fees charged by the provider themselves:

| Provider      | Monthly Cost |
| ------------- | ------------ |
| ACT365        | €/\$/£50     |
| Avigilon      | €/\$/£50     |
| Brivo         | **FREE**     |
| Doordeck      | €/\$/£50     |
| Doorflow      | **FREE**     |
| Gallagher     | €/\$/£50     |
| Genetec       | €/\$/£50     |
| Kisi          | **FREE**     |
| Avigilon Alta | €/\$/£50     |
| Padword       | €/\$/£50     |
| Parakey       | €/\$/£50     |
| Paxton NET2   | €/\$/£50     |
| Salto KS      | **FREE**     |
| SofiaLocks    | €/\$/£50     |
| Unifi Access  | €/\$/£50     |

<Warning>
  The fees shown above are Nexudus charges only. Contact each access control provider directly for pricing information
  about their services.
</Warning>

## Configuration Workflow

Setting up an access control integration follows these general steps:

1. **Connect** — Enter your access control system credentials in Nexudus
2. **Configure Presence Tracking** — Map physical doors to check-in actions (check in, check out, toggle)
3. **Map Inventory** — Link your plans, passes, resources, and desks to doors or lock tags
4. **Test** — Verify a test customer can access the correct doors
5. **Monitor** — Review access audit logs and check-in reports

## Access Behavior

### When Access is Granted

* **Plans**: Access starts on contract start date, ends on contract end date
* **Passes**: Access limited to pass validity window and allowed hours
* **Bookings**: Access starts 15 minutes before booking, ends at booking end time
* **Visitors**: Access limited to visit window specified by the host

### When Access is Revoked

* Contract is cancelled or expires
* Pass expires or is consumed
* Booking is cancelled or ends
* Visitor access window expires
* Customer is deactivated

## Choosing an Access Control Provider

When selecting an access control provider, consider these factors:

* **Budget** — Determine how much you're willing to spend on both Nexudus integration fees and the provider's own pricing
* **Access Methods** — Choose a provider that supports how your members prefer to unlock doors (mobile app, cards, etc.)
* **Occupancy Tracking** — If real-time occupancy data is important, select a provider with check-in/check-out support
* **Visitor Management** — If you host visitors, ensure your provider supports visitor access
* **Infrastructure** — Decide whether you prefer cloud-based (no hardware) or on-premise solutions
* **Scale** — Consider whether the provider supports all the Nexudus items you plan to use (some have limitations)
* **Integration Depth** — If you want members to use the Passport App, verify Passport integration is available

<Tip>
  We recommend contacting each provider directly to discuss your Location's specific needs before making a decision.
  Each provider has different pricing models and requirements depending on the size of your Location.
</Tip>

## Key Behaviors and Constraints

### Automatic Access Provisioning

Access is granted immediately when a customer:

* Purchases an active Plan linked to an access group
* Books a resource linked to an access group
* Rents a desk linked to an access group
* Receives time credits linked to an access group

### Automatic Access Revocation

Access is automatically removed when:

* A Plan expires or is cancelled
* A desk rental ends
* A resource booking is completed
* Time credits expire

<Warning>
  Ensure your access control provider can sync with Nexudus frequently to catch expiration events quickly. Some
  providers sync in real-time, while others may have delays.
</Warning>

### Multiple Access Methods

A single member can unlock doors using different methods depending on what's available:

* Card readers at physical doors
* Mobile app (if supported)
* Credentials or temporary codes
* Visitor invitations

The method used doesn't affect when access is granted or revoked — only the access group assignment matters.

### Visitor Access

Some providers support temporary visitor access. When enabled, your staff can issue time-limited access to guests without permanent credentials.

## Best Practices

<AccordionGroup>
  <Accordion title="Map inventory consistently">
    Use a consistent approach to mapping plans and passes to doors. For example, map all "Dedicated Desk" plans to the same door set to ensure uniform access.
  </Accordion>

  <Accordion title="Test with a dedicated test customer">
    Create a test customer account and assign/remove inventory to verify access is correctly provisioned before onboarding real customers.
  </Accordion>

  <Accordion title="Configure presence tracking for main entrances only">
    Only map your primary entrance doors to check-in actions. Mapping every door creates noise in your check-in reports.
  </Accordion>

  <Accordion title="Monitor access audit logs">
    Regularly review your access control system's audit logs to catch provisioning issues or unexpected access patterns.
  </Accordion>
</AccordionGroup>

## What to Do Next

To get started with access control in Nexudus:

1. **Review the comparison tables** above to identify 2-3 providers that fit your needs
2. **Contact providers directly** for pricing and technical compatibility with your Location's hardware
3. **Plan your access groups** — Think about which doors should be grouped together for each Plan or resource type
4. **Configure the integration** in your Nexudus admin panel
5. **Link access groups to Nexudus items** so access is automatically granted to customers

For detailed setup instructions for each provider, refer to the provider-specific documentation pages.


# Paxton NET2
Source: https://learn.nexudus.com/platform/access-control/integrations/paxton-net2

Connect Nexudus with Paxton NET2's on-premises access control system to automate door access based on plans, passes, bookings, and desk assignments

# Paxton NET2 Access Control Integration

## Overview

Paxton NET2 is an enterprise-grade access control platform that provides physical security management through on-premises hardware and software. The Nexudus integration with Paxton NET2 automates credential provisioning and area assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **On-premises management**: Dedicated server installed at your location
* **OAuth2-based authentication**: Secure API authentication using Resource Owner Password Credentials flow
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **RFID token support**: Multiple RFID tokens per customer with customizable token types
* **Area-based permissions**: Map your inventory (passes, resources, desks) to Paxton NET2 areas
* **Booking-based temporary access**: Automatic access during reservation windows for booking holders and guests
* **Check-in session tracking**: Maintains access during check-in sessions based on active time passes
* **Team billing support**: Members of team billing groups receive access to all team resources
* **Shared passes**: Team members automatically receive access from shared time passes
* **Timezone support**: Configure access permissions with specific timezone restrictions

### Integration Type

**On-premise with Bridge Support** — Paxton NET2 requires a dedicated server installed at your location. Nexudus connects via Paxton's REST API using either:

* **Network Bridge**: Secure tunnel through `https://bridge.nexudus.com/{device_id}/` (recommended)
* **Port Forwarding**: Direct connection to `https://public_ip:8443/` (requires firewall configuration)

### Capabilities

| Feature                    | Supported  | Notes                                                                            |
| -------------------------- | ---------- | -------------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                            |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                               |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                      |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                      |
| **Visitor access**         | ✅ Yes      | Booking guests receive access during booking windows                             |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during their booking windows |
| **Door event check-ins**   | ❌ No       | Door access events are not sent back to Nexudus to create automatic check-ins    |
| **Mobile app access**      | ❌ No       | No mobile app integration available                                              |
| **Remote door unlock**     | ❌ No       | Physical tokens required for access                                              |

## How It Works

### Access Control Model

Paxton NET2 uses an **area-based** model to manage access permissions:

* **Users** represent individuals in the system (mapped to Nexudus customers)
* **Areas** define collections of doors that users can access
* **Tokens** are physical RFID cards assigned to users
* **Doors** are individual access points managed by door controllers
* **Timezones** define when access is permitted (e.g., 24/7, business hours only)

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, check in, or their contract renews), the integration automatically updates their user record in Paxton NET2 with the appropriate area permissions.

### Access Calculation

The integration evaluates multiple sources to determine a customer's access:

1. **Active Time Passes**: All passes currently valid for the customer
2. **Shared Passes**: Passes shared by paying member in team billing arrangements
3. **Check-in Sessions**: Active check-ins maintain pass-based access for session duration
4. **Upcoming Bookings**: Resources booked by customer (access granted 15 minutes early)
5. **Booking Guest Access**: Resources where customer is added as a guest
6. **Contract Desks**: Desks included in active contracts
7. **Team Billing Desks**: Desks from paying member's contracts for team members

All area permissions from these sources are aggregated and applied to the customer's Paxton NET2 user record.

### Multi-Door Support

Paxton NET2 uses **areas** to grant permissions to multiple doors. Instead of mapping each door individually:

1. In Paxton NET2, create an area (e.g., "Coworking Space Access")
2. Add the relevant doors to that area in Paxton NET2
3. In Nexudus, select that area from the dropdown when mapping your pass/resource/desk
4. Customers with that pass automatically get access to all doors in the area

<Note>
  You must configure which doors belong to each area in the Paxton NET2 system. Nexudus assigns customers to areas by selecting from the available areas retrieved from your Paxton NET2 system. The door-to-area mapping is managed in Paxton NET2.
</Note>

## Prerequisites

Before connecting Nexudus to Paxton NET2, ensure you have:

1. **Paxton NET2 system installed on-premise** with administrator access
2. **Local API enabled** via the NET2 Local API Configuration Utility
3. **Nexudus license file installed** for API access (provided by Nexudus support)
4. **API credentials** (username and password for API authentication)
5. **Network connectivity** — Either:
   * **Network Bridge configured**: Device ID from your [Nexudus Network Bridge](/integrations/network-bridge) installation
   * **Port forwarding configured**: Public IP address with port 8443 (or custom port) forwarded to your Paxton NET2 server
6. **Paxton NET2 configured** with door controllers installed and online
7. **Areas created** in Paxton NET2 for different access levels (e.g., 24/7 access, business hours only)
8. **Timezones configured** in Paxton NET2 for when access should be granted
9. **Nexudus location configured** with plans, passes, and resources

<Note>
  The Local API Configuration Utility is located on the security tab of the NET2 Configuration Utility. The default location on Windows is `C:\Program Files (x86)\Paxton Access\Access Control\SvrConf.exe`. Contact Nexudus support to obtain the license file for API access. After installing the license file, restart the NET2 Service to enable the API.
</Note>

## Configuration

### Step 1: Enable and Connect to Paxton NET2

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Paxton Net2** in the list and expand the settings
3. Enable the **Enable Paxton Net2 integration** toggle
4. Enter your connection details (fields appear when toggle is enabled):
   * **Paxton Net2 server address**: Choose one of the following:
     * **Network Bridge**: `https://bridge.nexudus.com/{DEVICE_ID}/` (replace `{DEVICE_ID}` with your Bridge device ID)
     * **Port Forwarding**: `https://YOUR_PUBLIC_IP:8443/` (replace `YOUR_PUBLIC_IP` with your public IP address and port)
   * **Paxton Net2 username**: Your Paxton NET2 API username
   * **Paxton Net2 password**: Your Paxton NET2 API password
   * **Paxton Net2 Client ID**: Use `8bea7086-c5bb-4d71-98ca-a81be791e82b` (fixed Nexudus identifier)
   * **Token Type** (optional): The token type for RFID cards (defaults to "Unspecified")
5. Click **Save** to establish the connection
6. Once connected successfully, the configuration panels for passes, resources, and desks will load below

<Note>
  If using the Network Bridge, ensure your Bridge Agent is running and registered. If using port forwarding, ensure port 8443 (or your custom port) is accessible from the internet and forwarded to your Paxton NET2 server.
</Note>

### Step 2: Map Passes to Areas

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to one or more Paxton NET2 areas.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select one or more **Paxton NET2 areas** from the dropdown menu
   * The dropdown shows all areas available in your connected Paxton NET2 system
   * Areas are automatically retrieved when you save the connection settings
   * You can select multiple areas for a single pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to Paxton NET2 areas, the customer is granted access to those areas
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Paxton NET2 Areas            | Purpose                                          |
| ------------------- | ---------------------------- | ------------------------------------------------ |
| 24/7 Access Pass    | Main Building, Meeting Rooms | Round-the-clock building and meeting room access |
| Business Hours Pass | Main Building                | Access only during operating hours               |
| Meeting Room Pass   | Meeting Rooms                | Access to meeting room zones only                |

<Note>
  Areas are automatically retrieved from your Paxton NET2 system. If you don't see an area in the dropdown, verify it exists in Paxton NET2 and re-save your connection settings to refresh the list.
</Note>

<Warning>
  Plans are **not** directly mapped to areas. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to areas (selected from dropdown)
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Paxton NET2 access
</Warning>

### Step 3: Map Resources to Areas

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select one or more **Paxton NET2 areas** from the dropdown menu
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately

**Example mapping:**

| Resource Name     | Paxton NET2 Areas         | Purpose                                      |
| ----------------- | ------------------------- | -------------------------------------------- |
| Conference Room A | Floor 2, Meeting Rooms    | Access to second floor and meeting room area |
| Event Space       | Event Hall, Main Entrance | Access to event space and main entrance      |
| Private Office    | Private Office Wing       | Access to private office area                |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 4: Map Desks/Units to Areas

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select one or more **Paxton NET2 areas** from the dropdown menu
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped areas
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Paxton NET2 Areas                | Purpose                                   |
| --------------------- | -------------------------------- | ----------------------------------------- |
| Private Office #101   | Floor 1 Private, Main Building   | Access to first-floor private office area |
| Dedicated Desk Zone A | Coworking Floor 2, Main Building | Access to dedicated desk zone             |
| Studio #5             | Studios, Loading Dock            | Access to studio unit and loading area    |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Paxton NET2 access.
</Warning>

### Step 5: Save Configuration

1. Review all mappings to ensure they're correct
2. Verify area names match exactly with your Paxton NET2 system
3. Click **Save** to apply the configuration
4. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Paxton NET2 access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Paxton NET2 areas
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Paxton NET2 areas
3. **Check-in created**: Customer checks in with a time pass → maintains access to pass areas for the duration of the check-in session
4. **Booking created**: Customer books a resource → granted access to resource's areas 15 minutes before booking start time
5. **Booking guest added**: Customer is added as a guest on a booking → granted access to resource's areas during the booking window
6. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped areas
7. **Team member access**: Paying member's team receives access to all areas from paying member's passes and desks
8. **Shared passes**: Team members receive access from shared passes of their paying member

### When Access is Revoked

Nexudus automatically revokes Paxton NET2 access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Paxton NET2 areas
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Paxton NET2 areas
3. **Check-in ends**: Customer checks out or check-in session expires → pass-based access is re-evaluated
4. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's areas is removed
5. **Booking guest removed**: Customer is removed as a guest from a booking → access to resource's areas is revoked
6. **Desk removed from contract**: Desk is removed from contract → access to desk's areas is revoked
7. **Customer deactivated**: Customer account is deactivated → all Paxton NET2 access removed

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers
* **Debouncing**: 5-second debounce prevents rapid repeated updates for the same customer

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning. Check the Business Checkup page for any integration errors.
</Note>

## RFID Token Management

Paxton NET2 supports traditional RFID access tokens (cards, fobs, tags). To assign tokens to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter token IDs in the **Access Card ID** field
4. Separate multiple tokens with commas: `123456,789012,345678`
5. Save the customer profile

**Token behavior:**

* **No token**: User exists in Paxton NET2 but cannot unlock doors (no physical credentials)
* **Token assigned**: Customer can use physical RFID token to unlock doors
* **Token removed**: Physical access is revoked (user remains in system)
* **Multiple tokens**: Customer can have multiple tokens assigned simultaneously

**Token configuration:**

* **Token Type**: Configurable in integration settings (defaults to "Unspecified")
* Tokens are automatically created/updated/deleted based on the Access Card ID field
* Token IDs should match the format expected by your Paxton NET2 system
* Each token is associated with the customer's user record in Paxton NET2

<Note>
  Unlike cloud-based systems, Paxton NET2 does **not** support mobile access. Customers must use physical RFID tokens to unlock doors.
</Note>

## Timezone Configuration

Paxton NET2 supports timezone-based access restrictions, allowing you to control when customers can access specific areas:

* **Timezone ID**: Configured in the integration settings (defaults to timezone 1)
* Timezones are created in Paxton NET2 (e.g., "24/7 Access", "Business Hours Only", "Weekend Access")
* When customers are assigned to areas, they receive the configured timezone for those permissions
* Different areas can have different timezone restrictions

**Common timezone configurations:**

* **Timezone 1**: Typically configured as 24/7 access
* **Timezone 2**: Business hours only (e.g., Monday-Friday 8 AM - 6 PM)
* **Timezone 3**: Extended hours (e.g., Monday-Sunday 6 AM - 11 PM)

<Note>
  Timezones must be created and configured in your Paxton NET2 system before use. Nexudus applies the configured timezone ID to all area permissions granted through the integration.
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Paxton NET2 areas
       * **Solution**: Go to Settings > Integrations > Paxton Net2 and select areas for the relevant passes

    2. **Area no longer exists**: The selected area was deleted from Paxton NET2
       * **Solution**: Select a different area or recreate the area in Paxton NET2, then refresh the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **User not created**: The customer wasn't created in Paxton NET2
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Area permissions**: The Paxton NET2 area exists but isn't assigned to any doors
       * **Solution**: In Paxton NET2, verify the area includes the correct door controllers

    6. **No token assigned**: Customer exists in Paxton NET2 but has no physical credentials
       * **Solution**: Assign an RFID token in the customer's Access Card ID field

    7. **Network connectivity**: Nexudus cannot reach your Paxton NET2 server
       * **Solution**: Check firewall rules, port forwarding (8443), and verify the Server IP is correct

    8. **Timezone restrictions**: Access is restricted by timezone settings
       * **Solution**: Verify the timezone configured in Paxton NET2 allows access at the current time
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to any Paxton NET2 areas
       * **Solution**: Select areas for the resource in Settings > Integrations > Paxton Net2

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **No token assigned**: Customer has no physical token to use
       * **Solution**: Assign an RFID token to the customer's profile
  </Accordion>

  <Accordion title="RFID tokens not working">
    **Possible causes:**

    1. **Token format**: Token IDs don't match the format expected by your Paxton NET2 system
       * **Solution**: Check your Paxton NET2 system documentation for the correct token ID format

    2. **Token not synced**: Recent token changes haven't been synced to Paxton NET2
       * **Solution**: Wait a few minutes for sync, or manually trigger by editing and saving the customer profile

    3. **Token type mismatch**: Token type configured in Nexudus doesn't match Paxton NET2
       * **Solution**: Verify the Token Type setting matches your Paxton NET2 configuration

    4. **User inactive**: Customer's user account is inactive in Paxton NET2
       * **Solution**: Verify customer has active passes/contracts that grant access

    5. **Token reader issue**: Physical hardware problem
       * **Solution**: Test tokens on different readers to isolate hardware issues
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Incorrect server address**: The server URL is incorrect or malformed
       * **Solution**: Verify the correct URL format:
         * Network Bridge: `https://bridge.nexudus.com/{DEVICE_ID}/`
         * Port Forwarding: `https://YOUR_PUBLIC_IP:8443/`

    2. **Network Bridge not running**: If using the bridge, it may not be online
       * **Solution**: Verify the Bridge Agent is running and registered (check bridge status dashboard)

    3. **Port not forwarded**: If using port forwarding, port 8443 is not accessible
       * **Solution**: Configure port forwarding on your firewall to forward port 8443 to your Paxton NET2 server, or switch to [Network Bridge](/integrations/network-bridge) for easier setup

    4. **Invalid credentials**: Username or password is incorrect
       * **Solution**: Verify credentials have administrative access in Paxton NET2

    5. **Client ID incorrect**: Wrong Client ID entered
       * **Solution**: Ensure you're using `8bea7086-c5bb-4d71-98ca-a81be791e82b` as the Client ID

    6. **License file missing**: Nexudus license file not installed in NET2
       * **Solution**: Contact Nexudus support to obtain the license file and install it via the Local API Configuration Utility

    7. **SSL certificate issues**: Certificate validation failing
       * **Solution**: Ensure valid SSL certificates, or contact support if using self-signed certificates

    8. **Service not running**: Paxton NET2 Service is not running
       * **Solution**: Restart the NET2 Service from Windows Services panel

    9. **API not enabled**: Local API not enabled in NET2 Configuration Utility
       * **Solution**: Enable the Local API via NET2 Local API Configuration Utility and restart the service
  </Accordion>

  <Accordion title="Area assignments not updating">
    **Possible causes:**

    1. **Area deleted**: Area was selected but has since been deleted from Paxton NET2
       * **Solution**: Recreate the area in Paxton NET2 or select a different area in Nexudus

    2. **Stale area list**: Available areas not refreshed after changes in Paxton NET2
       * **Solution**: Re-save your connection settings to refresh the area list from Paxton NET2

    3. **API permissions**: Paxton NET2 user doesn't have permission to modify area assignments
       * **Solution**: Ensure the API user has administrative permissions in Paxton NET2

    4. **Background job delay**: Updates are queued but not yet processed
       * **Solution**: Wait a few minutes for background jobs to process

    5. **Timezone configuration error**: Invalid timezone ID configured
       * **Solution**: Verify the timezone ID exists in your Paxton NET2 system
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid credentials or connection errors
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid area mappings
* **Network connectivity**: Connection timeouts or unreachable server
* **API errors**: Errors returned by the Paxton NET2 API

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

### Data Shared with Paxton NET2

When provisioning access, Nexudus shares the following information with Paxton NET2:

* **Customer data**: First name, last name
* **External ID**: Nexudus customer ID stored in the FAX field (used to link records between systems)
* **RFID tokens**: Token IDs from the Access Card ID field
* **Token type**: Token type from integration settings

Nexudus **does not** share:

* Email addresses
* Phone numbers
* Billing information
* Payment details
* Contract specifics (only area assignments)
* Personal notes or custom fields

### Network Security

* **HTTPS encryption**: All communication uses HTTPS (SSL/TLS)
* **OAuth2 authentication**: Resource Owner Password Credentials flow with access tokens
* **On-premises control**: Your Paxton NET2 system remains on your local network
* **Bridge security**: If using Network Bridge, all traffic is encrypted through secure tunnel (no inbound ports)
* **Port forwarding security**: If using port forwarding, restrict firewall rules to Nexudus IP addresses only

<Note>
  The Network Bridge is recommended for enhanced security as it requires no inbound firewall ports. See [Network Bridge documentation](/integrations/network-bridge) for security details.
</Note>

### Credential Management

* **Physical tokens**: Managed in both Nexudus and Paxton NET2; always assign through Nexudus
* **User passwords**: Never shared with Nexudus; authentication is handled by Paxton NET2
* **API credentials**: Stored securely in Nexudus; transmitted over HTTPS only

## Related Documentation

* [Access Control Overview](/platform/access-control/overview)
* [Network Bridge Setup](/integrations/network-bridge) - For on-premises connectivity without opening firewall ports
* [Passes Configuration](/platform/billing/time-passes)
* [Plans & Contracts](/platform/billing/plans)
* [Resource Bookings](/platform/operations/bookings)
* [Check-ins](/platform/operations/check-ins)

## Best Practices

### Area Organization

Create areas in Paxton NET2 based on access levels, not products or plans:

* ✅ **Good**: "24/7Access", "BusinessHours", "MeetingRooms", "PrivateOffices"
* ❌ **Avoid**: "HotDeskPlan", "DedicatedDeskPlan" (these are billing products, not access types)

This approach lets you grant the same physical access through multiple plans.

### Naming Conventions

* Create descriptive area names in Paxton NET2 that make them easy to identify in the dropdown
* Avoid overly long area names that are difficult to read in the admin panel
* Document area-to-door mappings in Paxton NET2 for future reference
* Use consistent naming across different access control zones

### Token Management

* Assign unique token IDs to each customer
* Keep spare tokens for emergencies
* Regularly audit token assignments and deactivate unused tokens
* Use the correct Token Type for your RFID card system
* Test new tokens immediately after assignment

### Timezone Configuration

* Configure timezones in Paxton NET2 before mapping areas in Nexudus
* Use timezone 1 for 24/7 access (most common)
* Create separate timezones for business hours, extended hours, and weekends
* Document which timezone ID corresponds to which access schedule
* Test timezone restrictions to ensure they work as expected

### Network Connectivity

**Using Network Bridge (Recommended):**

* No firewall configuration required
* Secure outbound connection to Nexudus
* Easy setup and maintenance
* See [Network Bridge documentation](/integrations/network-bridge) for installation

**Using Port Forwarding:**

* Configure firewall to forward port 8443 (or custom port) to Paxton NET2 server
* Restrict access to Nexudus IP addresses only
* Ensure valid SSL certificates for production use
* Use static IP or DNS for consistent connectivity

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * **Protocol**: HTTPS with JSON-based REST API
  * **Authentication**: OAuth2 Resource Owner Password Credentials flow
  * **Token Endpoint**: `{ServerIp}/api/v1/authorization/tokens`
  * **Base URL**: `{ServerIp}/api/` (typically `https://YOUR_IP:8443/api/`)
  * **Client Credential Style**: POST body
  * **Scope**: `offline_access`

  ### User Model

  Paxton NET2 users created by Nexudus:

  * **FirstName**: Customer's first name
  * **LastName**: Customer's last name
  * **Fax**: Nexudus customer ID (used for external reference)
  * **ActivateDate**: Set to 15 minutes before current time
  * **IndividualPermissions**: List of area IDs with timezone restrictions

  ### Token Model

  RFID tokens managed by Nexudus:

  * **TokenValue**: The RFID card number
  * **TokenType**: Configurable type (defaults to "Unspecified")
  * Tokens are created, updated, and deleted based on Access Card ID field
  * Multiple tokens per user supported

  ### Permission Set Model

  ```json theme={null}
  {
    "AccessLevels": [],
    "IndividualPermissions": [
      {
        "Id": 123,
        "TimezoneId": 1
      }
    ]
  }
  ```

  ### Business Settings Reference

  | Setting                 | Purpose                                                          |
  | ----------------------- | ---------------------------------------------------------------- |
  | `PaxtonNet2.Enabled`    | Integration enabled flag ("true"/"false")                        |
  | `PaxtonNet2.Username`   | Administrator username for API authentication                    |
  | `PaxtonNet2.Password`   | Administrator password for API authentication                    |
  | `PaxtonNet2.ServerIp`   | Server URL in format `https://IP:PORT`                           |
  | `PaxtonNet2.ClientId`   | Fixed Nexudus identifier: `8bea7086-c5bb-4d71-98ca-a81be791e82b` |
  | `PaxtonNet2.TokenType`  | RFID token type (defaults to "Unspecified")                      |
  | `PaxtonNet2.TimeZoneId` | Timezone ID for area permissions (defaults to 1)                 |

  ### Access Update Logic

  1. **Passes**: Active passes from contracts + shared passes from paying member
  2. **Check-ins**: Passes from open check-ins (maintains access during session)
  3. **Bookings**: Resources with bookings starting within 15 minutes
  4. **Booking guests**: Resources from bookings where customer is a visitor
  5. **Desks**: Desks from active contracts (own + team billing)
  6. **Areas**: Aggregated list of unique area IDs
  7. **User provisioning**: Create/update user with aggregated area permissions
  8. **Token management**: Create/update/delete tokens based on AccessCardID field
  9. **Signature**: Access signature stored to detect changes

  ### External IDs

  * **Customers**: Fax field set to Nexudus coworker ID (integer as string)
  * **Lookup**: Users retrieved via API filtering on Fax field
  * **Uniqueness**: Fax field ensures no duplicate users

  ### Error Handling

  * **Authentication failures**: Logged to business log entries; integration automatically disabled
  * **Provisioning errors**: Automatic retry with exponential backoff (5 attempts, 60-second delay)
  * **Business Checkup**: Integration errors displayed on dashboard
  * **Event system**: OnExceptionHandler raises AccessControlEventData for error tracking
  * **Distributed locking**: Prevents concurrent updates to same customer

  ### Token Management Logic

  * **Multiple tokens**: Comma-separated list in AccessCardID field
  * **Token sync**: Existing tokens compared with current AccessCardID, unused tokens deleted
  * **No tokens**: If AccessCardID is empty, all tokens are removed
  * **Token creation**: Each token ID gets separate token record with specified type

  ### Performance Optimization

  * **Debouncing**: 5-second debounce prevents rapid repeated updates for same customer
  * **Queue**: Access control updates run in dedicated Hangfire queue (1\_access\_control)
  * **Critical queue**: Immediate updates use priority queue (1\_critical)
  * **Distributed locking**: Prevents concurrent access updates across multiple servers
  * **Read uncommitted**: Uses read uncommitted isolation level for performance

  ### Network Requirements

  **Using Network Bridge:**

  * Bridge Agent must be installed and running on local network
  * Outbound HTTPS connection to `bridge.nexudus.com` (no inbound ports)
  * Local network access to Paxton NET2 server
  * See [Network Bridge documentation](/integrations/network-bridge) for full requirements

  **Using Port Forwarding:**

  * Public IP address with port 8443 (or custom port) forwarded to Paxton NET2 server
  * Firewall configured to allow HTTPS from Nexudus servers
  * Static IP or DNS hostname recommended
  * SSL/TLS certificate (self-signed accepted but not recommended)

  ### License File Installation

  1. Contact Nexudus support to obtain the Nexudus license file for Paxton NET2
  2. Open NET2 Configuration Utility (`SvrConf.exe`)
  3. Navigate to Security tab
  4. Open Local API Configuration Utility
  5. Install the Nexudus-provided license file
  6. Restart NET2 Service
  7. Use the fixed Client ID `8bea7086-c5bb-4d71-98ca-a81be791e82b` in Nexudus integration settings
</Accordion>


# Salto KS
Source: https://learn.nexudus.com/platform/access-control/integrations/saltov2

Connect Nexudus with Salto KS cloud-based access control system to automate door access and manage Eloxx smart lockers based on plans, passes, bookings, and desk assignments

# Salto KS Integration

## Overview

Salto KS (formerly known as Salto Space) is a cloud-based access control platform that provides flexible, wire-free smart locks with mobile and RFID access capabilities. The Nexudus integration with Salto KS automates credential provisioning and access group assignments based on customer contracts, passes, bookings, and desk assignments. It also includes full support for **Salto Eloxx (Gantner) smart lockers**, enabling customers to reserve and unlock lockers directly from the Nexudus Passport app.

### Key Features

* **Cloud-based management**: Manage access from anywhere through Salto's web platform
* **OAuth authentication**: Seamless connection without API keys - just connect and authorize
* **Mobile access**: Customers can use mobile keys through the Salto app integrated with Nexudus Passport
* **Wire-free installation**: Battery-powered smart locks with no wiring required
* **Automatic provisioning**: Access is granted and revoked automatically based on plan changes, bookings, and pass assignments
* **Locker management**: Full support for Salto Eloxx (Gantner) smart lockers with self-service reservations and remote unlock
* **Visitor support**: Time-limited credentials for visitors with automatic expiry
* **Check-in tracking**: Use door unlock events to automatically check customers in/out
* **Multi-site support**: Manage multiple Salto sites from a single Nexudus location
* **RFID card support**: Traditional access cards with tag number assignments
* **Group-based permissions**: Map your inventory (passes, resources, desks) to Salto access groups

### Integration Type

**Cloud-based** — Salto KS operates entirely in the cloud with battery-powered smart locks.

### Capabilities

| Feature                    | Supported  | Notes                                                                             |
| -------------------------- | ---------- | --------------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Primary access mechanism via pass-to-group mapping                                |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                                |
| **Resource-based access**  | ✅ Yes      | Temporary access during bookings with 15-min lead time                            |
| **Desk/unit-based access** | ✅ Yes      | Contract-based access with team billing support                                   |
| **Visitor access**         | ✅ Yes      | Time-limited credentials with access group assignment                             |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during booking windows        |
| **Check-in tracking**      | ✅ Yes      | Lock unlock events trigger automatic check-ins/check-outs                         |
| **Mobile app access**      | ✅ Yes      | Salto mobile keys via Nexudus Passport app integration                            |
| **Remote door unlock**     | ✅ Yes      | Unlock supported via remote access and mobile keys                                |
| **RFID card support**      | ✅ Yes      | Traditional access cards with tag number management                               |
| **PIN code sync**          | ❌ No       | PIN codes are generated by Salto and cannot be set from Nexudus                   |
| **Locker management**      | ✅ Yes      | Full support for Salto Eloxx/Gantner smart lockers with self-service reservations |

## How It Works

### Access Control Model

Salto KS uses a **site users and groups** model:

1. **Sites**: Each physical location is a separate site in Salto (you can have multiple sites)
2. **Site Users**: Each customer is created as a site user with their email, name, and optional RFID tag
3. **Access Groups**: Permissions are organized into groups (e.g., "24/7 Access", "Meeting Room A")
4. **Locks**: Individual smart locks at doors controlled through the cloud platform
5. **Credentials**: Users receive mobile keys, RFID tags, or both to access doors

When a customer should have access (based on their plan, passes, or bookings), Nexudus:

* Creates or updates their Salto site user profile
* Assigns them to the appropriate access groups
* Provisions credentials (mobile key or RFID tag)
* Updates or revokes access when contracts change

### Multi-Door Support

Salto KS uses **access groups** to grant permissions to multiple locks. Instead of mapping each lock individually:

1. In Salto, create an access group (e.g., "Coworking Space Access")
2. Add the relevant locks to that group in Salto
3. In Nexudus, map your pass/resource/desk to that access group
4. Customers with that pass automatically get access to all locks in the group

<Note>
  You must configure which locks belong to each access group in the Salto platform. Nexudus assigns customers to groups, but the lock-to-group mapping is managed in Salto.
</Note>

### Mobile Access Integration

Customers can use the Salto app to unlock doors using their smartphone. The integration works seamlessly with the Nexudus Passport app:

* When a customer signs in to Nexudus Passport, they can connect their Salto account
* Mobile keys are automatically provisioned based on their Nexudus access
* Customers can unlock doors directly from the Salto app on their device
* Mobile access follows the same rules as physical cards (based on passes, bookings, and contracts)

## Prerequisites

Before connecting Nexudus to Salto KS, ensure you have:

1. **Active Salto KS account** with administrator access
2. **Salto site configured** with smart locks installed and online
3. **Access groups created** in Salto for different access levels (e.g., 24/7 access, business hours only)
4. **Nexudus location configured** with plans, passes, and resources

<Note>
  **No API keys required!** Unlike other integrations, Salto KS uses OAuth for authentication. You simply click "Connect" and sign in to your Salto account. The integration is activated automatically as part of the authorization flow.
</Note>

## Configuration

### Step 1: Connect to Salto

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **Salto** in the list and expand the settings
3. Toggle **Enable Salto integration** to ON
4. Click **Connect** button
5. You'll be redirected to Salto's login page
6. Sign in with your Salto administrator credentials
7. Grant Nexudus permission to access your Salto account
8. You'll be redirected back to Nexudus

Once connected, Nexudus can read your Salto sites, locks, and access groups. The connection is maintained through OAuth tokens and will automatically refresh.

<Note>
  The connection process uses secure OAuth 2.0 authentication. Your Salto credentials are never stored in Nexudus - only secure access tokens that can be revoked at any time from your Salto account.
</Note>

### Step 2: Select Your Site

If you have multiple Salto sites:

1. From the **Site** dropdown, select the site that corresponds to this Nexudus location
2. Click **Save** to apply the selection
3. The page will reload showing the locks and access groups for the selected site

<Warning>
  After changing the selected site, you **must save and reload the page** before continuing with the rest of the configuration. The locks and groups displayed are specific to the selected site.
</Warning>

<Note>
  If you have multiple locations in Nexudus and multiple sites in Salto, you can map each Nexudus location to a different Salto site. Configure the integration separately for each location.
</Note>

### Step 3: Configure Presence Tracking (Optional)

Salto can trigger automatic check-ins when customers unlock specific locks.

1. In the **Presence Tracking** section, you'll see all locks from your Salto site
2. For each lock, choose an action:
   * **Nothing**: Lock access is tracked in Salto but doesn't affect Nexudus presence
   * **Check In**: Unlocking this lock checks the customer in
   * **Check Out**: Unlocking this lock checks the customer out
   * **Toggle**: Unlocking switches between checked in and checked out

**Common scenarios:**

* Set the main entrance lock to **Check In**
* Set the exit lock to **Check Out**
* Set internal locks to **Nothing** (access granted but doesn't affect presence)

**How it works:**

* When a customer unlocks a door using their RFID tag, mobile key, or remote unlock, Salto sends an event to Nexudus
* Based on your configuration, Nexudus automatically checks them in, out, or toggles their presence
* The customer is identified by their RFID tag number or email address
* Events are processed in near real-time (typically within seconds)

<Note>
  Check-in tracking works with access via RFID tags, mobile keys, and remote unlock methods. The system matches customers by their tag number or email address registered in both systems.
</Note>

### Step 4: Map Passes to Access Groups

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to a Salto access group.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select the Salto **Access Group** that customers should be assigned to when they hold that pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to a Salto group, the customer is added to that group in Salto
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | Salto Access Group | Purpose                            |
| ------------------- | ------------------ | ---------------------------------- |
| 24/7 Access Pass    | 24/7 Members       | Round-the-clock building access    |
| Business Hours Pass | Business Hours     | Access only during operating hours |
| Meeting Room Pass   | Meeting Rooms      | Access to meeting room zones       |

<Warning>
  Plans are **not** directly mapped to access groups. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to access groups
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated Salto access
</Warning>

### Step 5: Map Resources to Access Groups

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select the Salto **Access Group** required to access that space
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately
* Booking guests also receive the same access for the booking duration

**Example mapping:**

| Resource Name     | Salto Access Group | Purpose                            |
| ----------------- | ------------------ | ---------------------------------- |
| Conference Room A | Meeting Room A     | Access to specific meeting room    |
| Event Space       | Event Hall         | Access to event space for bookings |
| Private Office    | Private Offices    | Access to private office area      |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window (plus the 15-minute lead time), even if they don't hold a general access pass.
</Note>

### Step 6: Map Desks/Units to Access Groups

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select the Salto **Access Group** required to access that area
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped access group
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | Salto Access Group     | Purpose                                   |
| --------------------- | ---------------------- | ----------------------------------------- |
| Private Office #101   | Private Office Floor 1 | Access to first-floor private office area |
| Dedicated Desk Zone A | Desk Area A            | Access to dedicated desk zone A           |
| Studio #5             | Studio Access          | Access to individual studio unit          |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant Salto access.
</Warning>

### Step 7: Configure Visitor Access (Optional)

Salto supports time-limited credentials for visitors.

1. Toggle **Create visitor PIN codes** to ON
2. In the **Visitor Group** dropdown, select the Salto access group that visitors should receive
3. Visitors can be assigned to only one group (unlike customer access which can span multiple groups)

**How visitor access works:**

* When a visitor is registered in Nexudus with an expected arrival time, Nexudus creates a temporary site user in Salto
* The visitor is assigned to the selected visitor access group
* **PIN code generation**: Salto automatically generates a unique PIN code for the visitor, which Nexudus retrieves and includes in the check-in notification sent to the visitor
* Access automatically expires:
  * **Guest on a booking**: Access is revoked when the booking ends
  * **Regular visitor**: Access expires at midnight (location's time zone) on the arrival date
* When the visitor is marked as departed or deleted, their Salto credentials are removed immediately
* Visitors can use the Salto-generated PIN code, mobile keys, or RFID tags depending on how you provision their credentials

<Note>
  Visitors can also be added as **guests on bookings**. When a customer adds a guest to a meeting room booking, the guest receives access to the resource's mapped access group, limited to the booking time window.
</Note>

### Step 8: Save Configuration

1. Review all mappings to ensure they're correct
2. Verify access group names match your Salto system
3. Click **Save** to apply the configuration
4. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants Salto access when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding Salto access groups
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped Salto access group
3. **Booking created**: Customer books a resource → granted access to resource's group 15 minutes before booking start time
4. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped access group
5. **Booking guest added**: Non-customer is added as a guest on a booking → granted access to resource's group for the booking duration
6. **Visitor registered**: Visitor is added with expected arrival date → receives access to visitor group

### When Access is Revoked

Nexudus automatically revokes Salto access when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding Salto access groups
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped Salto access group
3. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's group is removed
4. **Desk removed from contract**: Desk is removed from contract → access to desk's group is revoked
5. **Customer deactivated**: Customer account is deactivated → all Salto access removed
6. **Visitor departed**: Visitor is marked as departed or deleted → Salto credentials removed

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time and revoked 15 minutes after the booking ends
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **OAuth token refresh**: Access tokens are automatically refreshed to maintain continuous connectivity

<Note>
  If a customer should have access but doesn't, check the connection status and verify the site selection. The Business Checkup page will show any integration errors.
</Note>

## RFID Card Management

Salto supports traditional RFID access cards in addition to mobile keys. To assign cards to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter the card tag number in the **Access Card ID** field
4. Separate multiple cards with commas: `123456,789012,345678`
5. Save the customer profile

**Card behavior:**

* **No card or mobile key**: Site user exists in Salto but cannot unlock doors (no credentials)
* **Card assigned**: Customer can use physical RFID card to unlock doors
* **Mobile key**: Customer can use the Salto app on their smartphone to unlock doors
* **Both assigned**: Customer can use either physical card or mobile app
* **Card removed**: Physical card access is revoked (site user and mobile access remain)

**Card numbering:**

* Card IDs are stored in Salto's `tag_number` field on the site user record
* Card IDs should match the format expected by your Salto system
* The same card number can be used across different sites if needed

<Note>
  Customers can have both RFID cards and mobile keys simultaneously. This provides flexibility for customers who prefer physical cards but want the convenience of mobile access.
</Note>

### PIN Code Limitations

<Warning>
  **PIN codes are managed by Salto only.** Unlike some other access control systems, Salto does not allow PIN codes to be set externally. If you have a PIN code configured in a customer's Nexudus profile, it will **not** be synced to Salto. Salto generates its own PIN codes automatically when needed, which cannot be customized or overridden through the API.

  For visitors, however, Salto generates a PIN code automatically when the visitor is created, and Nexudus retrieves this PIN and includes it in the check-in notification sent to the visitor.
</Warning>

## Locker Management (Salto Eloxx/Gantner)

Salto KS includes support for **Salto Eloxx** (also known as Gantner) smart lockers. These battery-powered electronic lockers integrate seamlessly with the Salto access control system, allowing customers to reserve, unlock, and release lockers directly from the Nexudus Passport app.

### Overview

The Salto Eloxx locker integration provides:

* **Automatic locker sync**: Lockers and locker groups are automatically imported from Salto into Nexudus
* **Self-service reservations**: Customers can browse available lockers and reserve them through the Nexudus Passport app
* **Remote unlock**: Customers can unlock their reserved locker remotely from the app
* **Audit trail**: All locker actions (reserve, unlock, release) are logged with timestamps and customer details
* **Push notifications**: Customers receive notifications when they successfully unlock a locker
* **Real-time availability**: View which lockers are available, occupied, or offline

### How Locker Management Works

#### Locker Sync Process

When you connect to Salto, Nexudus automatically:

1. **Retrieves locker groups** from your Salto site
2. **Creates resources** in Nexudus for each locker group (one resource per group)
3. **Creates floor plan desks** for each individual locker within the groups
4. **Syncs locker status** (available, occupied, online/offline)

**Locker hierarchy:**

```
Salto Locker Group → Nexudus Resource → Floor Plan → Individual Lockers (as Floor Plan Desks)
```

Each locker group in Salto becomes:

* A **Resource** in Nexudus with a special locker designation
* A **Floor Plan** containing all lockers in that group
* Individual **Floor Plan Desks** representing each physical locker

<Note>
  Lockers are automatically synced when you first connect the Salto integration. To refresh locker data after adding new lockers in Salto, use the **Sync Salto Eloxx Locker data** button in Settings > Integrations > Salto.
</Note>

#### Locker Reservation Flow

1. **Customer browses available lockers** in the Nexudus Passport app
   * Only lockers the customer has permission to book are displayed
   * Availability is shown in real-time
2. **Customer reserves a locker** by selecting it from the list
   * The locker is assigned to the customer
   * Reservation timestamp is recorded
3. **Customer unlocks the locker** using the "Unlock" button in the app
   * Salto Eloxx lock receives the unlock command
   * Customer receives a push notification confirming the unlock
4. **Customer releases the locker** when finished
   * Locker is unassigned and becomes available for others
   * Release action is audited

### Configuration

#### Step 1: Enable Locker Integration

The locker integration is automatically enabled when you:

1. Connect to Salto KS using OAuth
2. Select a site that has Salto Eloxx lockers installed

No additional configuration is needed - lockers are detected and synced automatically.

#### Step 2: Sync Locker Data

After connecting Salto:

1. Go to **Settings > Integrations**
2. Find the **Salto** integration
3. Click **Sync Salto Eloxx Locker data** button
4. Wait for the sync to complete

This will:

* Create a special resource type called "Salto Eloxx Lockers"
* Import all locker groups as resources
* Create floor plans for each locker group
* Import individual lockers as floor plan desks

<Note>
  The sync is also triggered automatically when you first connect the integration. You only need to manually sync if you add new lockers in Salto after the initial connection.
</Note>

#### Step 3: Configure Locker Permissions

Lockers are linked to **Resources** in Nexudus, which means you can control who can book them using standard resource permissions:

1. Go to **Settings > Resources**
2. Find the resources created for your locker groups (they'll have the locker group name from Salto)
3. Edit each resource to configure:
   * **Visibility**: Control whether the resource appears in the Passport app
   * **Booking permissions**: Set which customer types or plans can book these lockers
   * **Pricing**: Optionally charge for locker usage (per hour, per day, etc.)
   * **Advance booking**: Set how far in advance lockers can be reserved

**Common permission configurations:**

* **All active customers**: Set "Can be booked by" to all customer types
* **Specific plans only**: Restrict booking to customers with certain passes or plans
* **Free vs. paid**: Some locker groups can be free for members, others charged for guests

### Troubleshooting Lockers

<AccordionGroup>
  <Accordion title="Lockers not appearing in Nexudus after connection">
    **Possible causes:**

    1. **Lockers not synced**: The initial sync didn't run or failed
       * **Solution**: Go to Settings > Integrations > Salto and click "Sync Salto Eloxx Locker data"

    2. **No Eloxx lockers in Salto**: Your Salto site doesn't have Eloxx lockers configured
       * **Solution**: Verify in Salto that you have Eloxx locker groups and lockers set up

    3. **Wrong site selected**: The Nexudus location is connected to a different Salto site
       * **Solution**: Verify the selected site has the Eloxx lockers you're expecting
  </Accordion>

  <Accordion title="Customer can't see any available lockers">
    **Possible causes:**

    1. **Resource not visible**: The locker resource is set to hidden
       * **Solution**: Go to Settings > Resources and ensure the locker resource has "Visible" enabled

    2. **No booking permission**: Customer doesn't have permission to book the locker resource
       * **Solution**: Edit the resource and configure "Can be booked by" to include the customer's type or plan

    3. **All lockers occupied**: There are no available lockers in the group
       * **Solution**: Check the floor plan to see if all lockers are assigned, or release some lockers

    4. **Lockers offline**: All lockers in the group have lost connectivity
       * **Solution**: Check Salto to verify locker status and connectivity
  </Accordion>

  <Accordion title="Unlock command not working">
    **Possible causes:**

    1. **Locker offline**: The specific locker has lost connection to Salto
       * **Solution**: Check the locker's battery and connectivity in Salto system

    2. **Not the locker owner**: Someone else reserved the locker
       * **Solution**: Customer can only unlock lockers they have reserved

    3. **OAuth token expired**: The Salto connection needs to be refreshed
       * **Solution**: Reconnect the Salto integration from Settings > Integrations

    4. **Network connectivity**: Temporary network issue between Nexudus and Salto
       * **Solution**: Retry the unlock after a few moments
  </Accordion>

  <Accordion title="Locker stuck as occupied after customer finished">
    **Possible causes:**

    1. **Customer didn't release**: Customer closed the app without releasing the locker
       * **Solution**: Admin can manually release the locker by editing the floor plan desk and removing the customer assignment

    2. **Release failed**: The release action didn't complete successfully
       * **Solution**: Check the audit log for errors, then manually release as admin
  </Accordion>

  <Accordion title="New lockers added in Salto not appearing in Nexudus">
    **Possible causes:**

    1. **Sync not run**: Nexudus doesn't automatically detect new lockers
       * **Solution**: Go to Settings > Integrations > Salto and click "Sync Salto Eloxx Locker data" to import the new lockers
  </Accordion>
</AccordionGroup>

## Mobile Access Setup

### For Administrators

To enable mobile access for your customers:

1. Ensure Salto integration is connected and configured
2. Verify that access groups are properly mapped to passes, resources, and desks
3. Customers will be automatically provisioned as site users in Salto when they receive access

### For Customers

Customers can set up mobile access through the Nexudus Passport app:

1. Download the Nexudus Passport app (iOS or Android)
2. Sign in with their Nexudus credentials
3. Navigate to the access control section
4. Connect to Salto by authorizing their account
5. Their mobile key is automatically provisioned based on their Nexudus access
6. Use the Salto app to unlock doors

**Mobile key features:**

* Real-time access updates based on passes, bookings, and contracts
* Access is automatically revoked when contracts end or passes expire
* Multiple devices can be registered per customer

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any Salto access groups
       * **Solution**: Go to Settings > Integrations > Salto and select an access group for the relevant passes

    2. **Wrong site selected**: The Nexudus location is mapped to a different Salto site than where the customer's locks are located
       * **Solution**: Verify the selected site matches your physical location and locks

    3. **Access group no longer exists**: The selected access group was deleted from Salto
       * **Solution**: Select a different access group or recreate the group in Salto, then refresh the integration

    4. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    5. **Site user not created**: The customer wasn't created in Salto
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    6. **Access group permissions**: The Salto access group exists but isn't assigned to any locks
       * **Solution**: In Salto, verify the access group includes the correct locks

    7. **No credentials**: Customer exists in Salto but has no RFID card or mobile key
       * **Solution**: Assign an RFID card in the customer's Access Card ID field, or have the customer set up mobile access

    8. **OAuth token expired**: The connection between Nexudus and Salto needs to be refreshed
       * **Solution**: Check the integration status. If disconnected, click "Connect" again to re-authorize
  </Accordion>

  <Accordion title="Integration shows as disconnected">
    **Possible causes:**

    1. **OAuth token expired**: Access tokens expire after a period of inactivity
       * **Solution**: Click the "Connect" button again and re-authorize your Salto account

    2. **Salto account changes**: Your Salto account password was changed or permissions were revoked
       * **Solution**: Reconnect the integration by clicking "Connect" and signing in again

    3. **Salto platform maintenance**: Temporary service disruption
       * **Solution**: Wait a few minutes and check the Salto status page, then reconnect if needed
  </Accordion>

  <Accordion title="Check-ins not working when customers unlock doors">
    **Possible causes:**

    1. **Lock not configured**: The lock action is set to "Nothing"
       * **Solution**: Go to Settings > Integrations > Salto > Presence Tracking and set the appropriate action (Check In, Check Out, or Toggle)

    2. **Customer identification failed**: Customer's RFID tag or email doesn't match between systems
       * **Solution**: Verify the customer's Access Card ID in Nexudus matches the tag\_number in Salto, or ensure their email addresses match

    3. **Events not being received**: Webhooks from Salto aren't reaching Nexudus
       * **Solution**: Check with Nexudus support to verify webhook configuration is correct

    4. **Customer already checked in**: The check-in action failed because the customer is already checked in
       * **Solution**: This is normal behavior - check-ins only succeed when the customer's state changes
  </Accordion>

  <Accordion title="Booking guests can't access the space">
    **Possible causes:**

    1. **Resource not mapped**: The resource isn't mapped to any Salto access group
       * **Solution**: Go to Settings > Integrations > Salto > Resources and select an access group for the resource

    2. **Guest not created in system**: Booking guest wasn't properly registered as a contact
       * **Solution**: Ensure the guest has a valid email address and contact record in Nexudus

    3. **Timing issue**: Guest is trying to access before the 15-minute lead time
       * **Solution**: Access is granted 15 minutes before the booking starts - ask the guest to wait

    4. **Guest has no credentials**: Guest doesn't have an RFID card or mobile access
       * **Solution**: Assign an access card or have the guest set up mobile access through their contact profile
  </Accordion>

  <Accordion title="Mobile access not working for customers">
    **Possible causes:**

    1. **Customer hasn't authorized Salto**: The customer needs to connect their Salto account through Nexudus Passport
       * **Solution**: Direct the customer to the Nexudus Passport app to authorize the Salto integration

    2. **Mobile key not provisioned**: The customer's mobile device isn't registered in Salto
       * **Solution**: Have the customer open the Salto app and complete the device registration process

    3. **Access not synced**: The customer's mobile app hasn't synced recent access changes
       * **Solution**: Ask the customer to open the Salto app and pull to refresh their access permissions

    4. **Offline mode**: Customer is trying to unlock without prior sync
       * **Solution**: Mobile keys work offline after initial sync, but the customer needs internet connection for the first sync
  </Accordion>

  <Accordion title="Changes to pass mappings not taking effect">
    **Possible causes:**

    1. **Settings not saved**: Changes were made but not saved
       * **Solution**: Click the "Save" button at the bottom of the integration settings

    2. **Background job delay**: Access updates are processed asynchronously
       * **Solution**: Wait a few minutes for the background job to process the changes

    3. **Site not selected**: You changed mappings before selecting a site
       * **Solution**: Ensure a site is selected from the dropdown, then review and save the mappings again
  </Accordion>

  <Accordion title="Visitor access not working">
    **Possible causes:**

    1. **Visitor PIN codes not enabled**: The feature is toggled off
       * **Solution**: Go to Settings > Integrations > Salto and toggle "Create visitor PIN codes" to ON

    2. **No visitor group selected**: A visitor access group hasn't been chosen
       * **Solution**: Select a Salto access group from the "Visitor Group" dropdown

    3. **Visitor hasn't arrived yet**: Access hasn't started
       * **Solution**: Visitor access begins at the expected arrival time - wait until then

    4. **Visitor access expired**: Access was time-limited and has ended
       * **Solution**: Regular visitors lose access at midnight on their arrival date. Re-register for a new visit or mark as departed and re-add

    5. **No credentials provisioned**: Visitor doesn't have a way to unlock doors
       * **Solution**: Provision an RFID card or mobile key for the visitor through their contact profile
  </Accordion>
</AccordionGroup>

## Best Practices

### Access Group Organization

* Create separate access groups for different zones (e.g., "Lobby", "Coworking Floor 1", "Private Offices")
* Use descriptive names that make it clear what area each group grants access to
* Document which locks belong to each group in Salto
* Review and update access group mappings when you add new locks

### Pass Mapping Strategy

* Map general membership passes to broad access groups (e.g., "24/7 Access")
* Map specialized passes to restricted areas (e.g., "Meeting Room Pass" → "Conference Rooms")
* Use time-based passes for temporary access needs (e.g., "Day Pass" with validity window)
* Avoid mapping too many passes to the same group unless they represent the same level of access

### Resource and Desk Mapping

* Map resources to the most specific access group needed (don't over-grant access)
* Consider that booking guests will receive the same access as the resource grants
* Map desks to access groups that cover common areas plus the specific desk location
* For team billing, ensure desk access groups cover areas that team members need

### Mobile Access Rollout

* Educate customers on how to set up mobile access through Nexudus Passport
* Provide clear instructions in your welcome emails and onboarding materials
* Offer RFID cards as a backup option for customers who prefer physical credentials
* Monitor adoption rates and provide support for customers who have trouble connecting

### Monitoring and Maintenance

* Regularly check the Business Checkup page for integration errors
* Review access logs in Salto to ensure access is being granted and revoked properly
* Test the integration periodically with a test customer account
* Keep your Salto access groups organized and documented
* Verify the OAuth connection is active - reconnect if the integration shows as disconnected

### Security Considerations

* Review who has administrator access to both Nexudus and Salto
* Audit access group assignments periodically to ensure customers have appropriate access
* Remove access immediately when customers leave or contracts are terminated
* Use mobile access for enhanced security (can be revoked instantly, no lost cards)
* Monitor check-in tracking for unusual patterns that might indicate security issues

<Note>
  Regular audits of access permissions help maintain security and ensure customers only have the access they need based on their current contracts and passes.
</Note>

## Additional Resources

* [Salto KS Documentation](https://saltosystems.com) - Official Salto platform documentation
* [Nexudus Passport App](/apps/passport) - Mobile app for customer access
* [Access Control Overview](/platform/access-control) - General access control concepts in Nexudus
* [Pass Management](/platform/billing/passes) - How to configure passes in Nexudus
* [Resource Bookings](/platform/spaces/resources) - Managing bookable resources


# SofiaLocks
Source: https://learn.nexudus.com/platform/access-control/integrations/sofialocks

Connect SofiaLocks (powered by Jago Cloud) to automate door access and track customer presence in real-time.

## Overview

SofiaLocks is a mobile-first smart lock system powered by Jago Cloud. The Nexudus integration automatically provisions customers in your SofiaLocks account and manages their access permissions based on their active plans, passes, bookings, and contract desk assignments.

Key features:

* **Mobile app access** — customers unlock doors from the Nexudus Passport Whitelabel app
* **Credential-based access control** — fine-grained permission management via lock tags
* **Time-bound visitor access** — temporary access codes for guests
* **Automatic check-ins** — door open events trigger check-ins in Nexudus

### Capabilities

| Feature                    | Supported  | Notes                                                        |
| -------------------------- | ---------- | ------------------------------------------------------------ |
| **Pass-based access**      | ✅ Yes      | Primary access mechanism via lock tag mapping                |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include           |
| **Resource-based access**  | ✅ Yes      | Temporary access during bookings with 15-min lead time       |
| **Desk/unit-based access** | ✅ Yes      | Contract-based access with team billing support              |
| **Visitor access**         | ✅ Yes      | Time-limited credentials with automatic expiry               |
| **Booking guest access**   | ✅ Yes      | Non-customers can access spaces during booking windows       |
| **Check-in tracking**      | ✅ Yes      | Door events trigger automatic check-ins (polled every 9 min) |
| **Mobile app access**      | ✅ Yes      | Native integration via Nexudus Passport app                  |
| **Remote door unlock**     | ❌ No       | Customers must be physically near doors to unlock            |

## How It Works

### Access Control Model

SofiaLocks uses **credential rules** to grant access:

1. Each customer is provisioned as a user in SofiaLocks
2. Each door has associated **lock tags** that control access
3. When you map inventory (passes, resources, desks) to lock tags, Nexudus creates credential rules linking the customer to those lock tags
4. When the customer opens the Nexudus Passport app, they see only the doors they have access to

**Note:** Desk access is granted through active contracts—customers receive access to desks included in their own contracts or, for team billing, desks in the paying member's contracts.

### Multi-Door Support

A single inventory item (like a pass, resource, or desk) can grant access to multiple doors. For example, a "Full Access" pass might provide access to the main entrance, office floors, and meeting rooms.

## Prerequisites

Before connecting Nexudus to SofiaLocks, you'll need:

* An active SofiaLocks account with administrative access
* Your **Location ID** (visible in your SofiaLocks dashboard URL: `api-{location_id}.jago.cloud`)
* Your SofiaLocks **username** and **password**
* At least one smart lock installed and configured in SofiaLocks

## Configuration

### Step 1: Connect to SofiaLocks

1. Go to **Settings > Integrations** in the Nexudus dashboard
2. Find **SofiaLocks** and click **Configure**
3. Enter your credentials:
   * **Location ID** — the identifier from your SofiaLocks URL
   * **Username** — your SofiaLocks admin username
   * **Password** — your SofiaLocks admin password
4. Click **Connect**

Nexudus will authenticate with SofiaLocks and retrieve your doors and lock tags.

<Note>
  The authentication token is permanent and stored securely. You won't need to re-authenticate unless you change your SofiaLocks credentials.
</Note>

### Step 2: Configure Presence Tracking

Presence tracking controls which door events trigger check-ins in Nexudus.

For each door, select an action:

| Action        | Behavior                                                 |
| ------------- | -------------------------------------------------------- |
| **Nothing**   | Door opens don't trigger check-ins (default)             |
| **Check In**  | Opening this door checks the customer in                 |
| **Check Out** | Opening this door checks the customer out                |
| **Toggle**    | Opening this door toggles between check-in and check-out |

<Note>
  Door events are polled from SofiaLocks every 9 minutes. Check-ins triggered by door opens may have a short delay.
</Note>

**Best practice:** Only configure check-in tracking for your main entrance. Tracking every door creates excessive check-in records.

### Step 3: Map Passes to Lock Tags

Passes are the primary mechanism for granting access in Nexudus:

1. In the **Passes** section, locate the pass you want to configure
2. Select the lock tags for doors this pass should unlock
3. Access is automatically limited to the pass's validity window

**Important:** Plans (membership tiers) grant access indirectly through the passes they include. When a customer signs a contract on a plan, they automatically receive the passes associated with that plan, which then determines their door access.

**Example mapping:**

* **Day Pass** → Main entrance only
* **24/7 Access Pass** → Main entrance + Office floors
* **Premium Access Pass** → Main entrance + Office floors + Meeting rooms

### Step 4: Map Resources to Lock Tags

Resources (meeting rooms, equipment) grant temporary access during bookings:

1. In the **Resources** section, locate the resource
2. Select the lock tags for doors related to this resource
3. Customers will receive access during their booking window (starting 15 minutes before)

### Step 5: Map Desks to Lock Tags

Floor plan desks can grant access to specific zones or floors:

1. In the **Desks / Offices** section, find the desk
2. Select the lock tags for the zone or floor where the desk is located
3. Customers with contracts that include these desks will receive ongoing access

**Team billing:** If a customer is part of a team using merged billing (where one member pays for others), they also receive access to any desks assigned to the paying member's contracts.

## Visitor Access

When you create a visitor in Nexudus:

1. The visitor is automatically provisioned in SofiaLocks
2. They receive time-limited access based on the visit window
3. Access expires automatically after the visit ends
4. The system removes their access and user profile shortly after expiry

Visitors don't need a full customer account — they receive temporary credentials valid only during their scheduled visit.

### How Visitor Access is Determined

SofiaLocks determines which doors a visitor can access using this priority:

1. **Booking-based visitors** (guests invited to a booking):
   * If the booking is for a resource (meeting room), the visitor gets access to that resource's lock tags
   * If the booking includes a desk assignment, the visitor gets access to that desk's lock tags
   * This gives visitors access only to the specific areas they need during their booking

2. **General visitors** (not linked to a booking):
   * They receive access to the **default visitor lock tags** configured in your SofiaLocks settings
   * Use this for reception areas or common visitor zones

### Access Time Windows

Visitor access includes a 15-minute buffer:

* Access starts 15 minutes before the expected arrival time
* Access ends 15 minutes after the departure time (or midnight following arrival if no departure specified)
* This buffer ensures visitors can enter slightly early or leave slightly late without issues

## How Access is Managed

### When Access is Granted

Nexudus grants access when:

* **A contract starts**: Customer receives the passes included in the plan, which grant access to configured doors
* **A pass is assigned directly**: Access granted during the pass validity window
* **A booking is created**: Access 15 minutes before booking start until booking end
* **A contract includes desks/units**: Immediate access to lock tags mapped to those desks (both from customer's own contracts and, for team billing, from the paying member's contracts)
* **An active check-in**: If a customer checks in with a specific pass, they maintain access to that pass's doors even if time-limited

### When Access is Revoked

Nexudus revokes access when:

* **A contract ends or is cancelled**: Customer loses the passes from that plan and any desk-based access from that contract
* **A pass expires or is fully consumed**: Access to those doors is removed
* **A booking is cancelled or ends**: Temporary resource/desk access is removed
* **A desk is removed from a contract**: Access to that desk's lock tags is removed
* **A customer is deactivated**: All access is revoked

**Synchronization:** Access changes are debounced by 5 seconds to batch multiple rapid changes together. Updates typically complete within 10-15 seconds of the inventory change in Nexudus.

**No-access behavior:** When a customer loses all access, you can configure whether to suspend their SofiaLocks account or delete it entirely (configured via `SofiaLocks.NoAccessBehaviour` setting).

## Mobile App Experience

Customers use the **Nexudus Passport Whitelabel app** to unlock doors:

1. Install your space's branded Nexudus Passport app (iOS or Android)
2. Sign in with the email address registered in Nexudus
3. The app obtains a SofiaLocks access token automatically
4. The app shows only doors they currently have access to based on their active passes, bookings, and desk assignments
5. Tap a door to unlock it
6. Each unlock triggers a check-in event in Nexudus (if the door is configured for presence tracking)

<Note>
  The Nexudus Passport app integrates with SofiaLocks behind the scenes. Customers don't need to install or interact with the SofiaLocks app directly.
</Note>

**Note:** Remote opening (unlocking doors from within the app without being physically present) is not supported for SofiaLocks. Customers must be near the door to unlock it.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer can't see any doors in the app">
    **Check:**

    * The customer has an active plan, pass, booking, or contract with desks
    * The inventory (passes/resources/desks) is mapped to lock tags
    * The customer has signed in to the Nexudus Passport app with their Nexudus credentials
    * The customer's account is active (not deactivated)
    * For team billing: If the customer is part of a team, check that the paying member has active contracts with desks mapped to lock tags
  </Accordion>

  <Accordion title="Door opens don't trigger check-ins">
    **Check:**

    * The door is configured with a check-in action (not "Nothing")
    * The customer has a valid pass that covers the location
    * The customer's pass has not been consumed or expired
  </Accordion>

  <Accordion title="Access not updating after plan change">
    **Check:**

    * The passes included in the new plan are mapped to lock tags (not the plan itself)
    * The customer has received the passes from the new plan (check their active passes)
    * Wait 10-15 seconds for synchronization
    * Check the customer's profile in SofiaLocks directly to verify credential rules
  </Accordion>

  <Accordion title="Visitor can't access the space">
    **Check:**

    * The visitor record in Nexudus has a valid visit time window
    * The host's booking (if any) is mapped to lock tags
    * The current time is within the visitor's access window
    * The visitor has been granted access and can see the doors in the Nexudus Passport app
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Expired credentials or invalid API tokens
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid access group/lock tag mappings
* **Synchronization problems**: Delays or failures in updating access permissions

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

### Check-In Audit Trail

* **Nexudus check-in records**: Show when customers accessed the space (if doors are configured for presence tracking)
* **SofiaLocks door event logs**: Available in your SofiaLocks dashboard showing every unlock attempt

**Note:** Door events from SofiaLocks are polled every 9 minutes, so check-in records may appear with a slight delay compared to the actual door open time.

<Note>
  Nexudus automatically retries failed operations. If errors persist, check the Business Checkup page for detailed information and follow the suggested resolution steps.
</Note>

## Security Considerations

* **Access is inventory-driven** — customers can only access doors if they have active inventory
* **No permanent mobile credentials** — access is managed by cloud rules, not device tokens
* **Automatic expiry** — all time-bound access (visitors, bookings) expires automatically
* **Audit trail** — every door open is logged with customer identity and timestamp

## Technical Details

<Accordion title="For developers and IT administrators">
  ### API Architecture

  * Authentication: OAuth2 Resource Owner Password flow with username/password
  * Base URL: `https://api-{location_id}.jago.cloud`
  * Token type: Bearer token (stored in `SofiaLocks.ApiToken` setting)
  * Credential rules endpoint: `/api/v2/credentialRules`
  * Users endpoint: `/api/v2/users`
  * Smart locks endpoint: `/api/v2/smartLocks`
  * Lock tags endpoint: `/api/v2/lockTags`

  ### Synchronization

  * Access changes are debounced by 5 seconds per customer to batch rapid updates
  * Distributed locking prevents race conditions in multi-server deployments
  * Background task polls door events every 9 minutes for check-in tracking
  * User provisioning happens on first inventory assignment (lazy creation)
  * Credential rules are created/updated/deleted as inventory changes
  * Access signature hashing prevents unnecessary API calls when access hasn't changed

  ### No-Access Behavior

  When a customer loses all access, the system can:

  * **Suspend** (default): Disable the user in SofiaLocks but keep the account
  * **Extended Suspend**: Same as suspend (for compatibility)
  * **Delete**: Remove the user from SofiaLocks entirely

  Configured via `SofiaLocks.NoAccessBehaviour` business setting.

  ### External IDs

  * Customers: `extId` set to Nexudus coworker ID (integer)
  * Visitors: `extId` set to `NEXVIS-{visitorId}` for both user and credential rule
  * Credential rules: `extId` set to coworker ID for customer rules, `NEXVIS-{visitorId}` for visitor rules

  ### Lock Tags vs Locks

  * **Locks** (smart hardware) are configured for presence tracking (check-in/check-out actions)
  * **Lock Tags** (logical groups) are used for access control and credential rules
  * Inventory (passes, resources, desks) is mapped to lock tags, not locks directly
  * One lock tag can represent multiple physical doors
  * Multiple lock tags can be assigned to a single inventory item (comma-separated)

  ### Contract-Based Desk Access

  * Desk access is determined by active contracts, not direct desk assignments
  * Customer receives access to desks in: `coworker.ActiveContracts().SelectMany(x => x.Desks)`
  * For team billing (merged billing), customer also receives access to: `GetPayingMember().ActiveContracts().SelectMany(x => x.Desks)`
  * This is checked via `coworker.PaysInvoicesViaTeam()` in the access update logic
  * Each desk can be mapped to multiple lock tags (comma-separated lock tag IDs)

  ### Visitor Time Window Calculation

  * Arrival: `ExpectedArrival` or current UTC time if not set
  * Departure: `DepartureDate` if set, otherwise midnight following arrival in business local time
  * Buffer: ±15 minutes added to both arrival and departure
  * Credential rule uses both date interval (specific dates) and time interval (00:00-23:59)

  ### Business Settings Reference

  | Setting                                    | Purpose                                                    |
  | ------------------------------------------ | ---------------------------------------------------------- |
  | `SofiaLocks.Enable`                        | Integration enabled flag ("true"/"false")                  |
  | `SofiaLocks.LocationId`                    | SofiaLocks location identifier                             |
  | `SofiaLocks.Username`                      | Admin username for authentication                          |
  | `SofiaLocks.Password`                      | Admin password for authentication                          |
  | `SofiaLocks.ApiToken`                      | OAuth2 bearer token (auto-generated)                       |
  | `SofiaLocks.GuestRoleId`                   | Role ID for visitors (default: 5)                          |
  | `SofiaLocks.CompanyName`                   | Company name sent to SofiaLocks                            |
  | `SofiaLocks.DefaultVisitorLockTagIds`      | Comma-separated lock tag IDs for non-booking visitors      |
  | `SofiaLocks.NoAccessBehaviour`             | What to do when customer loses all access (Suspend/Delete) |
  | `SofiaLocks.LastEventDate`                 | Last processed event timestamp (epoch millis)              |
  | `SofiaLocks.Controller.Id_{lockId}.Action` | Check-in action per lock (Nothing/CheckIn/CheckOut/Toggle) |
</Accordion>

## Next Steps

<CardGroup>
  <Card title="Check-In Methods" icon="fingerprint" href="/platform/access-control/check-in-methods">
    Configure how check-ins are tracked and validated
  </Card>

  <Card title="Passes" icon="clock" href="/platform/billing/time-passes">
    Create time passes that control access hours
  </Card>

  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Set up membership plans with door access
  </Card>

  <Card title="Visitors" icon="user-group" href="/platform/operations/visitors">
    Manage visitor access and approvals
  </Card>
</CardGroup>


# UniFi Access
Source: https://learn.nexudus.com/platform/access-control/integrations/unifi-access

Connect Nexudus with Ubiquiti's UniFi Access on-premises door control system to automate access based on plans, passes, bookings, and desk assignments

# UniFi Access Integration

## Overview

UniFi Access is Ubiquiti's enterprise door access control system that integrates with the broader UniFi IT management ecosystem. The Nexudus integration with UniFi Access automates credential provisioning and access policy assignments based on customer contracts, passes, bookings, and desk assignments.

### Key Features

* **On-premises management**: Deployed on your local network using UniFi infrastructure
* **Network Bridge connectivity**: Secure communication through Nexudus Bridge (no port forwarding required)
* **Automatic provisioning**: Access policies granted and revoked based on plan changes, bookings, and pass assignments
* **Multi-credential support**: NFC cards, PIN codes, and mobile app access (UniFi Identity)
* **Policy-based permissions**: Map your inventory (passes, resources, desks) to UniFi Access policies
* **Booking-based temporary access**: Automatic access during reservation windows for booking holders and guests
* **Check-in session tracking**: Maintains access during check-in sessions based on active time passes
* **Team billing support**: Members of team billing groups receive access to all team resources
* **Shared passes**: Team members automatically receive access from shared time passes
* **Mobile app support**: Optional UniFi Identity app integration for smartphone-based door unlock

### Integration Type

**On-premise with Network Bridge** — UniFi Access requires UniFi infrastructure (Dream Machine Pro, UniFi Cloud Key, or UniFi OS Console) at your location. Nexudus connects via the UniFi Access API using the [Nexudus Network Bridge](/integrations/network-bridge) at `https://bridge.nexudus.com/{device_id}/`.

### Capabilities

| Feature                    | Supported  | Notes                                                                            |
| -------------------------- | ---------- | -------------------------------------------------------------------------------- |
| **Pass-based access**      | ✅ Yes      | Customers receive access based on their active passes                            |
| **Plan-based access**      | ✅ Indirect | Plans grant access through the passes they include                               |
| **Resource-based access**  | ✅ Yes      | Grants temporary access during reservations                                      |
| **Desk/unit-based access** | ✅ Yes      | Includes support for team billing contracts                                      |
| **Visitor access**         | ✅ Yes      | Booking guests receive access during booking windows                             |
| **Booking guest access**   | ✅ Yes      | Customers added as booking guests can access spaces during their booking windows |
| **Door event check-ins**   | ❌ No       | Door unlock events are not sent back to Nexudus for automatic check-ins          |
| **Mobile app access**      | ✅ Yes      | Optional UniFi Identity app integration for mobile unlock                        |
| **Remote door unlock**     | ✅ Yes      | Customers can unlock doors remotely through the Members Portal                   |
| **NFC card support**       | ✅ Yes      | Supports RFID/NFC access cards                                                   |
| **PIN code access**        | ✅ Yes      | Optional PIN code synchronization from customer pincode field                    |

## How It Works

### Access Control Model

UniFi Access uses an **access policy-based** model to manage permissions:

* **Users** represent individuals in the system (mapped to Nexudus customers)
* **Access Policies** define collections of doors and resources that users can access
* **Credentials** include NFC cards, PIN codes, and mobile app identities
* **Doors** are individual access points managed by door controllers
* **Resources** are doors, floors, or zones controlled by the access system

When a customer's access needs change in Nexudus (e.g., they purchase a pass, book a resource, check in, or their contract renews), the integration automatically updates their user record in UniFi Access with the appropriate access policy assignments.

### Access Calculation

The integration evaluates multiple sources to determine a customer's access:

1. **Active Time Passes**: All passes currently valid for the customer
2. **Shared Passes**: Passes shared by paying member in team billing arrangements
3. **Check-in Sessions**: Active check-ins maintain pass-based access for session duration
4. **Upcoming Bookings**: Resources booked by customer (access granted 15 minutes early)
5. **Booking Guest Access**: Resources where customer is added as a guest
6. **Contract Desks**: Desks included in active contracts
7. **Team Billing Desks**: Desks from paying member's contracts for team members

All access policies from these sources are aggregated and applied to the customer's UniFi Access user record.

### Multi-Door Support

UniFi Access uses **access policies** to grant permissions to multiple doors and resources. Instead of mapping each door individually:

1. In UniFi Access, create an access policy (e.g., "Coworking Space Access", "Meeting Room Access")
2. Add the relevant doors and resources to that policy in UniFi Access
3. In Nexudus, select that access policy from the dropdown when mapping your pass/resource/desk
4. Customers with that pass automatically get access to all doors and resources in the policy

<Note>
  You must configure which doors belong to each access policy in the UniFi Access system. Nexudus assigns customers to policies by selecting from the available policies retrieved from your UniFi Access installation. The door-to-policy mapping is managed in UniFi Access.
</Note>

## Prerequisites

Before connecting Nexudus to UniFi Access, ensure you have:

1. **UniFi Access system deployed** with administrator access:
   * UniFi Dream Machine Pro, Cloud Key, or UniFi OS Console
   * UniFi Access application installed and configured
   * At least one UniFi Access Hub connected
   * Door controllers and readers installed and online

2. **API credentials** created in UniFi Access:
   * Local user account with API access permissions
   * API key generated for the user account

3. **Network Bridge installed and configured**:
   * [Nexudus Network Bridge](/integrations/network-bridge) agent running on your local network
   * Bridge device ID registered in your Nexudus dashboard
   * Bridge configured to forward requests to your UniFi Access API endpoint

4. **UniFi Access configured** with:
   * Access policies created for different access levels (e.g., "Full Access", "Meeting Rooms Only")
   * Door controllers provisioned and online
   * Readers associated with doors

5. **Nexudus location configured** with:
   * Plans, passes, and resources defined
   * Customers enrolled

<Note>
  The UniFi Access API is accessed through your local UniFi controller. The default API endpoint is typically `https://[controller-ip]:12445` where `[controller-ip]` is the IP address of your UniFi Dream Machine Pro, Cloud Key, or Console. The Network Bridge will forward requests to this endpoint securely.
</Note>

## Configuration

### Step 1: Set Up the Network Bridge

The UniFi Access integration requires the [Nexudus Network Bridge](/integrations/network-bridge) to securely connect your on-premises UniFi infrastructure to Nexudus.

1. Download and install the [Network Bridge agent](/integrations/network-bridge) on a computer in your location's network
2. When the agent starts, it will display a unique **Device ID**
3. Copy this Device ID — you'll need it for both the bridge configuration and the UniFi Access integration settings
4. In Nexudus, go to [Settings → Devices](https://dashboard.nexudus.com/settings/4/7/0) and click **Register Device**
5. Enter the Device ID to register the bridge
6. Configure the bridge to point to your UniFi Access API endpoint (typically `https://[controller-ip]:12445`)
7. Save the configuration and verify the bridge shows as "Connected"

<Warning>
  Do not use a trailing slash in the UniFi Access API URL. The correct format is `https://[controller-ip]:12445` (not `https://[controller-ip]:12445/`).
</Warning>

### Step 2: Enable and Connect to UniFi Access

1. In the Nexudus dashboard, go to **Settings > Integrations**
2. Find **UniFi Access** in the list and expand the settings
3. Enable the **Enabled** toggle
4. Enter your connection details (fields appear when toggle is enabled):
   * **API Key**: Your UniFi Access API key (generated in UniFi Access console)
   * **Bridge Device ID**: The device ID from your Network Bridge installation (from Step 1)
5. Click **Save** to establish the connection
6. Once connected successfully, the configuration panels for passes, resources, and desks will load below

<Note>
  The connection URL is automatically constructed as `https://bridge.nexudus.com/{DEVICE_ID}/` where `{DEVICE_ID}` is your Bridge device ID. The bridge agent forwards these requests to your local UniFi Access API.
</Note>

### Step 3: Configure Optional Features

After enabling the integration, configure optional features based on your needs:

#### PIN Code Synchronization

Enable **Set PIN based on customer Pincode** if you want Nexudus to synchronize customer PIN codes to UniFi Access:

* When enabled, the first 4 digits of the customer's **Access Pincode** field are synced to UniFi Access
* Customers can then use their PIN to unlock doors (if your UniFi Access readers support PIN entry)
* PINs are updated automatically when changed in the customer's Nexudus profile
* If a customer's pincode is shorter than 4 digits or empty, their UniFi Access PIN is cleared

#### UniFi Identity Mobile App

Enable **Send UniFi Identity invite email to new customers** to automatically invite customers to use the UniFi Identity mobile app:

* When enabled, new users created in UniFi Access receive an email invitation to download the UniFi Identity app
* Customers can then use their smartphone to unlock doors without physical credentials
* The invitation includes instructions for downloading the app and completing setup
* This feature requires the UniFi Identity service to be enabled in your UniFi Access system

<Warning>
  The UniFi Identity invitation sends an email directly from the UniFi Access system (not from Nexudus). Ensure your UniFi Access email settings are configured correctly, or customers may not receive the invitation.
</Warning>

### Step 4: Map Passes to Access Policies

Passes are the primary way customers receive access in Nexudus. Each pass can be mapped to one or more UniFi Access policies.

1. In the **Passes** section, you'll see all passes configured for this location
2. For each pass, select one or more **UniFi Access policies** from the dropdown menu
   * The dropdown shows all access policies available in your connected UniFi Access system
   * Policies are automatically retrieved when you save the connection settings
   * You can select multiple policies for a single pass
3. Leave blank if a pass should not grant physical access

**How it works:**

* When a customer has an active contract on a plan that includes passes, they automatically receive those passes
* If the pass is mapped to UniFi Access policies, the customer is granted access to those policies
* When the pass expires or is consumed, access is revoked
* Time-limited passes (e.g., day passes with validity windows) automatically grant and revoke access at the appropriate times

**Example mapping:**

| Pass Name           | UniFi Access Policies               | Purpose                                          |
| ------------------- | ----------------------------------- | ------------------------------------------------ |
| 24/7 Access Pass    | Full Building Access, Meeting Rooms | Round-the-clock building and meeting room access |
| Business Hours Pass | Business Hours Access               | Access only during operating hours               |
| Meeting Room Pass   | Meeting Room Access                 | Access to meeting room zones only                |

<Note>
  Access policies are automatically retrieved from your UniFi Access system. If you don't see a policy in the dropdown, verify it exists in UniFi Access and re-save your connection settings to refresh the list.
</Note>

<Warning>
  Plans are **not** directly mapped to access policies. Instead:

  1. Plans include passes via the plan configuration
  2. Passes are what get mapped to access policies (selected from dropdown)
  3. When a customer starts a contract on a plan, they receive the passes included in that plan
  4. Those passes then grant the associated UniFi Access permissions
</Warning>

### Step 5: Map Resources to Access Policies

Resources (meeting rooms, event spaces, etc.) can require specific access permissions for bookings.

1. In the **Resources** section, you'll see all resources configured for this location
2. For each resource, select one or more **UniFi Access policies** from the dropdown menu
3. Leave blank if resource bookings should not grant physical access

**How it works:**

* When a customer books a resource, Nexudus grants them access 15 minutes before the booking starts
* Access is automatically revoked when the booking ends
* If the booking is cancelled, access is removed immediately
* Booking guests also receive access to the resource's policies during the booking window

**Example mapping:**

| Resource Name     | UniFi Access Policies               | Purpose                                      |
| ----------------- | ----------------------------------- | -------------------------------------------- |
| Conference Room A | Floor 2 Access, Meeting Room Access | Access to second floor and meeting room area |
| Event Space       | Event Hall Access, Main Entrance    | Access to event space and main entrance      |
| Private Office    | Private Office Zone                 | Access to private office area                |

<Note>
  Resource-based access is temporary and booking-specific. A customer only receives access during their booking window, even if they don't hold a general access pass.
</Note>

### Step 6: Map Desks/Units to Access Policies

Floor plan desks and units can grant access to specific areas when included in a customer's contract.

1. In the **Desks/Units** section, you'll see all desks from your floor plans
2. For each desk, select one or more **UniFi Access policies** from the dropdown menu
3. Leave blank if desk assignments should not grant physical access

**How it works:**

* When a desk is added to a customer's contract, they receive access to the mapped policies
* Access is granted when the contract starts and revoked when it ends
* **Team billing support**: If a customer uses team billing (merged billing), they also receive access to desks included in the paying member's contracts

**Example mapping:**

| Desk/Unit Name        | UniFi Access Policies                 | Purpose                                   |
| --------------------- | ------------------------------------- | ----------------------------------------- |
| Private Office #101   | Floor 1 Private Access, Main Building | Access to first-floor private office area |
| Dedicated Desk Zone A | Coworking Floor 2, Main Building      | Access to dedicated desk zone             |
| Studio #5             | Studio Access, Loading Dock           | Access to studio unit and loading area    |

<Warning>
  Desk access is based on **contract assignments**, not direct desk bookings. Customers must have the desk included in an active contract to receive access. Ad-hoc desk bookings (if using desk booking) do not automatically grant UniFi Access access.
</Warning>

### Step 7: Save Configuration

1. Review all mappings to ensure they're correct
2. Verify policy names match exactly with your UniFi Access system
3. Click **Save** to apply the configuration
4. Nexudus will immediately start provisioning access for customers based on the new mappings

## How Access is Managed

### When Access is Granted

Nexudus automatically grants UniFi Access permissions when:

1. **Contract starts**: Customer begins a contract on a plan → receives passes included in that plan → assigned to corresponding UniFi Access policies
2. **Pass activated**: Customer receives a pass directly (not via a contract) → assigned to the mapped UniFi Access policies
3. **Check-in created**: Customer checks in with a time pass → maintains access to pass policies for the duration of the check-in session
4. **Booking created**: Customer books a resource → granted access to resource's policies 15 minutes before booking start time
5. **Booking guest added**: Customer is added as a guest on a booking → granted access to resource's policies during the booking window
6. **Desk added to contract**: Desk is added to an active contract → customer receives access to the desk's mapped policies
7. **Team member access**: Paying member's team receives access to all policies from paying member's passes and desks
8. **Shared passes**: Team members receive access from shared passes of their paying member

### When Access is Revoked

Nexudus automatically revokes UniFi Access permissions when:

1. **Contract ends or cancelled**: Customer loses passes from that contract → removed from corresponding UniFi Access policies
2. **Pass expires**: Pass validity ends or usage is consumed → removed from mapped UniFi Access policies
3. **Check-in ends**: Customer checks out or check-in session expires → pass-based access is re-evaluated
4. **Booking ends or cancelled**: Booking time expires or is cancelled → access to resource's policies is removed
5. **Booking guest removed**: Customer is removed as a guest from a booking → access to resource's policies is revoked
6. **Desk removed from contract**: Desk is removed from contract → access to desk's policies is revoked
7. **Customer deactivated**: Customer account is deactivated → all UniFi Access permissions removed

### Access Update Timing

* **Immediate updates**: Contract changes, pass assignments, and customer deactivations trigger access updates within seconds
* **Booking lead time**: Booking access is granted 15 minutes before the booking start time
* **Background processing**: Access updates are queued in background jobs to handle high volumes efficiently
* **Distributed locking**: Prevents concurrent updates to the same customer across multiple servers
* **Debouncing**: 5-second debounce prevents rapid repeated updates for the same customer
* **Automatic retries**: Failed updates are automatically retried with exponential backoff

<Note>
  If a customer should have access but doesn't, the system automatically retries access provisioning up to 5 times. Check the Business Checkup page for any integration errors.
</Note>

## Credential Management

UniFi Access supports multiple credential types that customers can use to unlock doors. You can configure which types are enabled for your integration.

### NFC Cards

To assign NFC access cards to customers:

1. Go to **Operations > Customers**
2. Select the customer
3. In their profile, enter card IDs in the **Access Card ID** field
4. Separate multiple cards with commas: `1234567890,0987654321,1122334455`
5. Save the customer profile

**Card behavior:**

* **No card**: User exists in UniFi Access but cannot unlock doors with a physical card
* **Card assigned**: Customer can use NFC card to unlock doors
* **Card removed**: Physical access via that card is revoked (user remains in system)
* **Multiple cards**: Customer can have multiple cards assigned simultaneously

**Card format:**

* Card IDs must match the format used by your UniFi Access system
* Common formats include: Facility Code + Card Number, or raw card number
* Cards can be identified by their **Display ID** or **Alias** in UniFi Access
* The integration searches for matching cards by both fields

<Note>
  Cards must first exist in your UniFi Access system (either enrolled manually or automatically detected by readers). Nexudus assigns existing cards to users but does not create new card records.
</Note>

### PIN Codes

If you enable **Set PIN based on customer Pincode**, customers can unlock doors using a PIN:

1. Go to **Operations > Customers**
2. Select the customer
3. Enter a PIN in the **Access Pincode** field (at least 4 digits)
4. Save the customer profile

**PIN behavior:**

* Only the first 4 digits are synchronized to UniFi Access
* PINs are updated automatically when changed in Nexudus
* If the pincode is shorter than 4 digits or cleared, the UniFi Access PIN is removed
* PINs only work if your door readers support PIN entry

### Mobile App (UniFi Identity)

If you enable **Send UniFi Identity invite email**, customers can use the UniFi Identity mobile app:

1. When a new user is created in UniFi Access, they automatically receive an email invitation
2. The customer downloads the UniFi Identity app (iOS/Android)
3. They follow the setup instructions in the invitation email
4. Once configured, they can unlock doors using their smartphone via Bluetooth or QR code

**Mobile app requirements:**

* UniFi Identity service must be enabled in your UniFi Access system
* Email settings must be configured in UniFi Access
* Customers need a smartphone with Bluetooth or camera (for QR code)
* Readers must support Bluetooth or QR code unlock

<Warning>
  Mobile app invitations are sent by UniFi Access, not Nexudus. Ensure your UniFi Access email configuration is working before enabling this feature.
</Warning>

## Remote Door Unlock

Customers can unlock doors remotely through the Nexudus Members Passport App without needing to be physically present at the door.

### How It Works

1. **Customer logs in** to the Members Portal (web or mobile app)
2. **Views available doors** - Only doors they have permission to access are shown
3. **Selects a door** and taps "Unlock"
4. **Door unlocks immediately** - The system triggers the UniFi Access door controller to unlock
5. **Confirmation displayed** - Customer sees success or error message

### Requirements

* Customer must have **active access permissions** to the door (via passes, bookings, or desk assignments)
* Customer must be **logged in** to the Members Portal
* The door must be **online** and reachable by UniFi Access controllers
* Network Bridge must be **running and connected**

### Access Verification

Before unlocking a door, the system verifies:

* The customer has at least one access policy that grants access to the requested door
* The customer's account is active
* The door exists in the customer's list of accessible doors

If verification fails, the unlock request is denied with an "Access Denied" message.

### Use Cases

* **Letting in deliveries**: Customer can unlock the front door for a delivery person without leaving their desk
* **Early arrival**: Customer can unlock doors before physically arriving at the space
* **Remote assistance**: Staff can help customers who are locked out by unlocking doors remotely
* **Guest access**: Customer can unlock doors for guests they're expecting

<Note>
  Remote unlock requires the same permissions as physical access. Customers can only unlock doors they would be able to access with their NFC card, PIN, or mobile app.
</Note>

<Warning>
  Remote unlock bypasses physical presence verification. Consider your security policies when enabling this feature. Doors unlock immediately without requiring the customer to be at the door location.
</Warning>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Customer has an active contract but can't access doors">
    **Possible causes:**

    1. **Pass not mapped**: The passes included in the customer's plan are not mapped to any UniFi Access policies
       * **Solution**: Go to Settings > Integrations > UniFi Access and select policies for the relevant passes

    2. **Policy no longer exists**: The selected policy was deleted from UniFi Access
       * **Solution**: Select a different policy or recreate the policy in UniFi Access, then refresh the integration

    3. **Pass expired or inactive**: The customer's pass has expired or hasn't started yet
       * **Solution**: Check the customer's passes under their profile to verify validity windows

    4. **User not created**: The customer wasn't created in UniFi Access
       * **Solution**: Check the Business Checkup page for integration errors, or manually trigger an update by editing and saving the customer's profile

    5. **Policy permissions**: The UniFi Access policy exists but isn't assigned to any doors/resources
       * **Solution**: In UniFi Access, verify the policy includes the correct doors and resources

    6. **No credentials assigned**: Customer exists in UniFi Access but has no credentials (NFC card, PIN, or mobile app)
       * **Solution**: Assign an NFC card in the customer's Access Card ID field, or enable PIN/mobile app features

    7. **Network connectivity**: Nexudus cannot reach your UniFi Access system
       * **Solution**: Check Network Bridge status, verify the bridge is running and connected

    8. **Customer inactive**: Customer account is deactivated in Nexudus
       * **Solution**: UniFi Access automatically deactivates users when their customer account is inactive. Reactivate the customer in Nexudus.

    9. **Access signature unchanged**: Recent changes haven't triggered an update
       * **Solution**: Edit and save the customer's profile to force a synchronization
  </Accordion>

  <Accordion title="Booking access not working">
    **Possible causes:**

    1. **Resource not mapped**: The booked resource is not mapped to any UniFi Access policies
       * **Solution**: Select policies for the resource in Settings > Integrations > UniFi Access

    2. **Booking too far in future**: Access is only granted 15 minutes before booking start time
       * **Solution**: Wait until booking is within 15 minutes of start time

    3. **Booking not confirmed**: Some resources require booking confirmation
       * **Solution**: Confirm the booking if it's in pending state

    4. **No credentials assigned**: Customer has no credentials to use (no card, PIN, or mobile app)
       * **Solution**: Assign at least one credential type to the customer's profile

    5. **Booking cancelled**: Access is immediately removed when bookings are cancelled
       * **Solution**: Verify the booking is still active and not cancelled
  </Accordion>

  <Accordion title="NFC cards not working">
    **Possible causes:**

    1. **Card doesn't exist in UniFi Access**: Card must be enrolled in UniFi Access first
       * **Solution**: Either manually enroll the card in UniFi Access, or present it to a reader to auto-enroll (if enabled)

    2. **Card ID format mismatch**: Card ID entered in Nexudus doesn't match the Display ID or Alias in UniFi Access
       * **Solution**: Check the card's Display ID and Alias in UniFi Access, and use the exact format in the customer's Access Card ID field

    3. **Card not synced**: Recent card changes haven't been synced to UniFi Access
       * **Solution**: Wait a few minutes for sync, or manually trigger by editing and saving the customer profile

    4. **Card already assigned**: The card is assigned to a different user in UniFi Access
       * **Solution**: Remove the card from the other user in UniFi Access first, or use a different card

    5. **User inactive**: Customer's user account is inactive in UniFi Access (due to no active passes/contracts)
       * **Solution**: Verify customer has active passes or contracts that grant access

    6. **Reader issue**: Physical hardware problem
       * **Solution**: Test cards on different readers to isolate hardware issues
  </Accordion>

  <Accordion title="Integration connection failing">
    **Possible causes:**

    1. **Network Bridge not running**: The bridge agent is offline or not configured
       * **Solution**: Verify the Bridge Agent is running on your local network and shows as connected

    2. **Bridge not pointing to UniFi Access**: Bridge is configured but not forwarding to the correct endpoint
       * **Solution**: Check the bridge configuration — it should point to `https://[controller-ip]:12445`

    3. **Invalid API key**: API key is incorrect or expired
       * **Solution**: Generate a new API key in UniFi Access and update the integration settings

    4. **API access disabled**: The UniFi Access API is not enabled
       * **Solution**: Enable API access in your UniFi Access controller settings

    5. **Incorrect device ID**: Bridge device ID entered in integration settings doesn't match registered bridge
       * **Solution**: Verify the device ID matches the one from your Network Bridge installation

    6. **SSL certificate issues**: Certificate validation failing
       * **Solution**: Ensure the UniFi Access controller has valid SSL certificates

    7. **UniFi Access service not running**: The access control service is offline
       * **Solution**: Restart the UniFi Access application or controller

    8. **Network firewall**: Local firewall blocking bridge agent from reaching UniFi Access API
       * **Solution**: Ensure the computer running the bridge can access the UniFi controller on the API port
  </Accordion>

  <Accordion title="Policy assignments not updating">
    **Possible causes:**

    1. **Policy deleted**: Policy was selected but has since been deleted from UniFi Access
       * **Solution**: Recreate the policy in UniFi Access or select a different policy in Nexudus

    2. **Stale policy list**: Available policies not refreshed after changes in UniFi Access
       * **Solution**: Re-save your connection settings to refresh the policy list from UniFi Access

    3. **API permissions**: UniFi Access API user doesn't have permission to modify user assignments
       * **Solution**: Ensure the API user has administrative permissions in UniFi Access

    4. **Background job delay**: Updates are queued but not yet processed
       * **Solution**: Wait a few minutes for background jobs to process

    5. **Debounce delay**: Multiple rapid changes are being debounced
       * **Solution**: Wait 5 seconds after the last change for the update to process

    6. **Distributed lock contention**: Another server is updating the same customer
       * **Solution**: Wait for the other update to complete (usually a few seconds)
  </Accordion>

  <Accordion title="PIN codes not syncing">
    **Possible causes:**

    1. **Feature not enabled**: PIN code sync feature is disabled
       * **Solution**: Enable "Set PIN based on customer Pincode" in integration settings

    2. **PIN too short**: PIN code in customer profile is less than 4 digits
       * **Solution**: Enter a PIN with at least 4 digits (only first 4 are used)

    3. **Reader doesn't support PIN**: Door readers don't have PIN entry capability
       * **Solution**: Verify your UniFi Access readers support PIN entry, or use NFC cards instead

    4. **User not created**: Customer doesn't exist in UniFi Access yet
       * **Solution**: Ensure customer has active passes or contracts that create them in UniFi Access
  </Accordion>

  <Accordion title="UniFi Identity app invites not received">
    **Possible causes:**

    1. **Feature not enabled**: UniFi Identity invite feature is disabled
       * **Solution**: Enable "Send UniFi Identity invite email to new customers" in integration settings

    2. **Email not configured**: UniFi Access email settings are not configured or invalid
       * **Solution**: Configure SMTP settings in your UniFi Access controller

    3. **User already exists**: Invites are only sent for newly created users
       * **Solution**: Manually send an invite from the UniFi Access console for existing users

    4. **UniFi Identity disabled**: UniFi Identity service is not enabled in UniFi Access
       * **Solution**: Enable the UniFi Identity service in your UniFi Access settings

    5. **Spam filter**: Invitation email was caught by spam filter
       * **Solution**: Check customer's spam/junk folder, or whitelist UniFi Access email address
  </Accordion>

  <Accordion title="Remote unlock not working">
    **Possible causes:**

    1. **Customer lacks access permissions**: Customer doesn't have an active pass, booking, or desk assignment that grants access to the door
       * **Solution**: Verify customer has active passes or bookings that map to access policies including the door

    2. **Door offline**: UniFi Access controller or door reader is offline
       * **Solution**: Check UniFi Access controller status and verify door controllers are online

    3. **Network Bridge down**: Bridge agent is not running or not connected
       * **Solution**: Verify Network Bridge status and restart if necessary

    4. **Door not in access policy**: The door isn't included in any of the customer's access policies
       * **Solution**: Check the access policy configuration in UniFi Access and ensure the door is added to relevant policies

    5. **Customer account inactive**: Customer's Nexudus account is deactivated
       * **Solution**: Reactivate the customer account in Nexudus

    6. **Door ID mismatch**: The door ID in the unlock request doesn't match any doors in UniFi Access
       * **Solution**: This is typically a system issue; contact Nexudus support if persists

    7. **API permissions**: UniFi Access API user doesn't have permission to unlock doors
       * **Solution**: Verify the API user has administrative permissions in UniFi Access
  </Accordion>
</AccordionGroup>

## Monitoring Integration Errors

Nexudus monitors your access control integration and alerts you to any issues that need attention.

### Business Checkup Dashboard

Access control integration errors are displayed on the **Business Checkup** page:

1. Go to **Home > Important Items** in the dashboard, or
2. Navigate directly to [dashboard.nexudus.com/dashboards/checkup](https://dashboard.nexudus.com/dashboards/checkup)
3. Look for the **Access Control Integration** tile
4. If there are errors, the tile will be displayed in red

### What Gets Flagged

* **Authentication failures**: Invalid API key or connection errors
* **Provisioning errors**: Failed attempts to create or update customer access
* **Configuration issues**: Missing or invalid policy mappings
* **Network connectivity**: Connection timeouts or unreachable bridge
* **API errors**: Errors returned by the UniFi Access API

Each error includes:

* The customer affected
* The nature of the problem
* When the error occurred
* Suggested actions to resolve it

<Note>
  Nexudus automatically retries failed operations up to 5 times with exponential backoff (15-second delays). If errors persist after retries, they appear on the Business Checkup page.
</Note>

## Security Considerations

### Data Shared with UniFi Access

When provisioning access, Nexudus shares the following information with UniFi Access:

* **Customer data**: First name, last name, email address
* **Employee number**: Nexudus customer ID (stored in the Employee Number field for reference)
* **NFC cards**: Card tokens from the Access Card ID field (assigned to user)
* **PIN codes**: First 4 digits of Access Pincode (if PIN sync enabled)

Nexudus **does not** share:

* Phone numbers
* Billing information
* Payment details
* Contract specifics (only policy assignments)
* Personal notes or custom fields

### Network Security

* **HTTPS encryption**: All communication uses HTTPS (SSL/TLS)
* **Bearer token authentication**: Secure API authentication using API keys
* **On-premises control**: Your UniFi Access system remains on your local network
* **Network Bridge security**: All traffic is encrypted through secure tunnel with no inbound firewall ports required
* **No port forwarding**: Unlike direct API access, the Network Bridge eliminates the need for exposing your network

<Note>
  The [Network Bridge](/integrations/network-bridge) is required for UniFi Access integration and provides enhanced security by creating an outbound-only encrypted tunnel. See the Network Bridge documentation for complete security details.
</Note>

### Credential Management

* **NFC cards**: Managed in both Nexudus and UniFi Access; always assign through Nexudus
* **PIN codes**: Synced from Nexudus to UniFi Access when feature is enabled
* **Mobile app**: Provisioned by UniFi Access after Nexudus creates the user
* **Credential isolation**: Customers can only access doors permitted by their assigned policies
* **Automatic deactivation**: Credentials become inactive when customer account is deactivated

### Privacy Considerations

* Customer data is only sent to your on-premises UniFi Access system (not to external services)
* Access logs remain in your UniFi Access system under your control
* Mobile app invitations are sent by your UniFi Access system using your SMTP settings
* No customer data is shared with Ubiquiti cloud services without your explicit configuration

## Best Practices

### Policy Organization

* **Create granular policies**: Use separate policies for different access levels (24/7 vs business hours, full access vs meeting rooms only)
* **Use descriptive names**: Name policies clearly (e.g., "24/7 Full Building", "Business Hours Meeting Rooms")
* **Test before production**: Create test passes and verify door access before rolling out to customers
* **Document mappings**: Keep a record of which passes/resources map to which policies

### Credential Management

* **Prefer mobile app**: Enable UniFi Identity invites for a better customer experience (no physical cards to manage)
* **Use consistent card IDs**: Establish a standard format for entering card IDs (Display ID vs Alias)
* **PIN codes for convenience**: Enable PIN sync for customers who need quick access without carrying cards
* **Multiple credentials**: Assign both card and PIN as backup options

### Access Policy Design

* **Group similar permissions**: Create policies that group doors customers need together (avoid creating a policy per door)
* **Separate by time**: Use different policies for 24/7 access vs business hours (managed in UniFi Access policy schedules)
* **Balance security and convenience**: Don't grant more access than necessary, but avoid creating too many complex policies

### Booking Access

* **15-minute buffer**: Remember that booking access starts 15 minutes early — consider this when booking back-to-back resources
* **Clear policy naming**: Make it obvious which resources require which access (helps when troubleshooting)
* **Test guest access**: Verify booking guests receive proper access during their booking windows

### Team Billing

* **Consistent desk policies**: Ensure all desks used by a team have the same access policies
* **Test paying member access**: Verify team members receive all access from the paying member's passes and desks
* **Document team access**: Make it clear in your plans which desks/passes grant which access

### Monitoring

* **Check Business Checkup regularly**: Review integration errors at least weekly
* **Test new configurations**: When adding new passes/resources, test with a test customer first
* **Monitor UniFi Access logs**: Check UniFi Access audit logs for denied access attempts
* **Keep bridge running**: Ensure the Network Bridge agent runs as a Windows service for reliability

<Warning>
  Always test access changes with a test customer before applying to production. Create a test pass, assign it to a test customer, and verify they can unlock the expected doors.
</Warning>

## Additional Resources

* [Network Bridge Documentation](/integrations/network-bridge) — Learn more about the Nexudus Network Bridge
* [Access Control Overview](/platform/access-control/overview) — Understand how access control works in Nexudus
* [UniFi Access Documentation](https://ui.com/access) — Official Ubiquiti UniFi Access documentation
* [Business Checkup Dashboard](https://dashboard.nexudus.com/dashboards/checkup) — Monitor integration health

<Note>
  For additional support with the UniFi Access integration, contact Nexudus support at [support@nexudus.com](mailto:support@nexudus.com) or through the dashboard help widget.
</Note>


# Access Control
Source: https://learn.nexudus.com/platform/access-control/overview

Control and monitor how customers access your coworking space — from check-ins to smart locks and IoT sensors.

## Overview

Access control in Nexudus covers everything related to physical and digital access to your space — including how customers check in, which doors they can open, WiFi authentication, and space occupancy monitoring.

From here you can:

* Track when customers arrive and leave with check-ins
* Connect smart locks and access control systems
* Manage WiFi access codes and authentication
* Monitor space usage with IoT sensors

## Sections

<CardGroup>
  <Card title="Check-In Methods" icon="fingerprint" href="/platform/access-control/check-in-methods">
    Configure how customers check in to your space — via mobile app, kiosk, NFC, or QR code.
  </Card>

  <Card title="Integrations" icon="plug" href="/platform/access-control/integrations/overview">
    Connect physical access control systems like smart locks and door controllers.
  </Card>

  <Card title="WiFi Access" icon="wifi" href="/platform/access-control/wifi">
    Manage network access with WiFi access codes and authentication integrations.
  </Card>

  <Card title="Sensors" icon="radar" href="/platform/access-control/sensors">
    Track occupancy and environmental conditions with IoT sensors.
  </Card>
</CardGroup>

## How Access Control Works

Access control in Nexudus is driven by **inventory assignments**:

* When you assign a customer a **plan**, **pass**, or **booking**, you're also granting them physical access
* Each inventory item can be mapped to specific **doors** or **lock tags** in your access control system
* The system automatically provisions and de-provisions access as inventory changes
* Check-ins track when customers actually use the space

## Common Use Cases

### Membership-Based Access

Grant access based on active plans:

* Map each membership plan to specific doors
* Access is automatically granted when a contract starts
* Access is revoked when a contract ends or is cancelled

### Booking-Based Access

Grant temporary access for meeting room bookings:

* Map resources (rooms) to specific doors
* Access is granted only during the booking window
* Access expires automatically when the booking ends

### Pass-Based Access

Control access hours with time passes:

* Map passes to specific doors or zones
* Access is limited to the pass's valid hours
* Check-ins consume pass time allowances

### Visitor Access

Provide temporary access for guests:

* Visitors receive time-limited access codes
* Access is automatically revoked after the visit window
* Hosts can approve or deny visitor access requests


# Agent Types Reference
Source: https://learn.nexudus.com/platform/ai/agent-types

Comprehensive reference guide for all available proactive AI agents, what they monitor, when they trigger, and recommended configuration settings.

## Overview

This page provides detailed information about every available proactive agent in Nexudus. Each agent monitors different patterns in your coworking space and proposes actions tailored to that situation.

Agents are organized by category below. Some agents are **Live** and available now; others are marked as **Coming Soon** and will be available in future releases.

Use this page to:

* Understand what each agent watches for
* Decide which agents are right for your space
* Learn recommended configuration settings
* Understand what variables are available for customization
* See which agents are safe for auto-execute

<CardGroup>
  <Card title="Configure Agents" icon="gear" href="https://dashboard.nexudus.com/operations/configureAgents">
    Enable and customize each agent's behavior.
  </Card>

  <Card title="Configuring Agents" icon="sliders" href="/platform/ai/configuring-agents">
    Step-by-step guide to agent configuration.
  </Card>

  <Card title="AI Inbox" icon="inbox" href="https://dashboard.nexudus.com/operations/inbox">
    Review and approve proposed actions.
  </Card>
</CardGroup>

***

## Quick Reference Table

| Agent                                                        | Category   | Status    |
| ------------------------------------------------------------ | ---------- | --------- |
| [Due Invoice Reminders](#-due-invoice-reminders)             | Billing    | ✅ Live    |
| [Contract Renewal](#-contract-renewal)                       | Billing    | ✅ Live    |
| [Support Pattern Detection](#-support-pattern-detection)     | Support    | ✅ Live    |
| [Support Category Spike](#-support-category-spike)           | Support    | ✅ Live    |
| [FAQ Gap Detection](#-faq-gap-detection)                     | Knowledge  | ✅ Live    |
| [Lead Follow-up](#-lead-follow-up)                           | Sales      | 🔜 Coming |
| [Onboarding Nudges](-#onboarding-nudges)                     | Engagement | 🔜 Coming |
| [Tour Reminders](#-tour-reminders)                           | Sales      | 🔜 Coming |
| [Tour No-Show Follow-up](#-tour-no-show-follow-up)           | Sales      | 🔜 Coming |
| [Booking No-Show Follow-up](#-booking-no-show-follow-up)     | Engagement | 🔜 Coming |
| [At-Risk Member Detection](#-at-risk-member-detection)       | Retention  | 🔜 Coming |
| [Upsell Opportunities](#-upsell-opportunities)               | Revenue    | 🔜 Coming |
| [Cancellation Risk Detection](#-cancellation-risk-detection) | Retention  | 🔜 Coming |
| [Lead Qualification Scoring](#-lead-qualification-scoring)   | Sales      | 🔜 Coming |

***

## Billing Agents

### 🟢 Due Invoice Reminders

**Status:** ✅ Live\
**Category:** Billing\
**Channel:** Email (default), WhatsApp, Voice supported\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Monitors unpaid invoices and sends friendly payment reminders when invoices become overdue. Escalates through multiple reminder tiers based on how long the invoice has been outstanding.

#### When It Triggers

* **Tier 1 (Friendly Reminder):** Invoice is 3+ days overdue (default)
* **Tier 2 (Follow-up):** Invoice is 7+ days overdue (default)
* **Tier 3 (Critical Escalation):** Invoice is 14+ days overdue (default)
* Tiers are fully configurable via **Days Overdue — Tier 1**, **Tier 2**, and **Tier 3** settings
* Tier 3 triggers regardless of minimum amount; Tiers 1–2 respect **Minimum Due Amount** threshold
* Only non-draft, non-void invoices with a past due date

#### What It Monitors

* Invoice status and due dates
* Payment history patterns
* Outstanding balance amounts
* Previous reminder history

#### Message Content

Each reminder includes:

* Friendly greeting with customer name
* Outstanding invoice details (amount, due date, invoice number)
* Payment link for immediate settlement
* Contact information if the customer has questions
* Escalating urgency based on tier

#### Recommended Settings

| Setting                  | Recommended Value | Why                                                    |
| ------------------------ | ----------------- | ------------------------------------------------------ |
| **Cooldown**             | 24–48 hours       | Prevents duplicate reminders for same invoice          |
| **Max Actions/Day**      | 20–50             | Scales with your customer base size                    |
| **Auto-Execute**         | ✅ Enabled         | Safe for all tiers after testing period                |
| **Confidence Threshold** | 70–85%            | Auto-generated per candidate (0.70–0.95 based on tier) |

#### Configuration Parameters

| Parameter                                       | Default | Description                                                                   |
| ----------------------------------------------- | ------- | ----------------------------------------------------------------------------- |
| **Minimum Due Amount**                          | `0`     | Invoices below this amount are ignored for Tiers 1–2. Tier 3 always triggers. |
| **Days Overdue — Tier 1 (Friendly Reminder)**   | `3`     | Days past due before a friendly payment reminder                              |
| **Days Overdue — Tier 2 (Follow-up)**           | `7`     | Days past due before a follow-up with urgency                                 |
| **Days Overdue — Tier 3 (Critical Escalation)** | `14`    | Days past due before a critical escalation                                    |

#### Available Variables

Use these in custom prompts or voice messages:

* `{{customer_name}}` — Full name of the customer
* `{{customer_email}}` — Customer email address
* `{{invoice_number}}` — Invoice reference identifier
* `{{invoice_amount}}` — Outstanding balance formatted with currency (e.g. `USD 150.00`)
* `{{invoice_description}}` — Invoice description
* `{{due_date}}` — Original due date (formatted as `MMMM dd, yyyy`, e.g. `June 14, 2026`)
* `{{days_overdue}}` — Number of days past due
* `{{reminder_tier}}` — Current escalation tier (1, 2, or 3)
* `{{company_name}}` — Name of your space/location
* `{{session_id}}` — Unique session identifier for voice calls

#### Best Practices

* Enable immediately for all locations with invoicing
* Start with manual review for the first 10 actions to verify quality
* Monitor payment response rates weekly
* Adjust cooldown if customers report too many reminders
* Consider increasing confidence threshold to 90% for auto-execute once comfortable
* Set **Minimum Due Amount** to filter out small invoices from automated reminders (Tier 3 still triggers for critical cases)
* Proposed actions expire after 3 days if not reviewed — consider reviewing older candidates promptly

***

### 🟢 Contract Renewal

**Status:** ✅ Live\
**Category:** Billing\
**Channel:** Email (default), WhatsApp, Voice supported\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Proactively reaches out to customers when their contract is approaching expiry, with context about their tenure, plan details, and pricing to start a renewal conversation. Helps prevent churn by engaging members before their contract ends.

#### When It Triggers

* When contract expiry falls within the configured number of days (default: 30 days)
* Only for active contracts with a price
* Contracts that are not cancelled and have a valid contract term
* Not sent if a recent action has already been proposed for the same contract or member

#### What It Monitors

* Contract end dates (ContractTerm field)
* Customer tenure and start date
* Contract pricing and plan details
* Contract active and cancellation status
* Previous outreach cooldown per member

#### Configuration Parameters

| Parameter              | Default | Description                                                                                              |
| ---------------------- | ------- | -------------------------------------------------------------------------------------------------------- |
| **Days Before Expiry** | `30`    | How many days before contract expiration the agent starts proposing renewal outreach. Range: 1–180 days. |

#### Message Content

Each renewal outreach includes:

* Personal greeting acknowledging the member's time with you
* Contract end date reminder with formatted date
* Summary of their tenure (total days as a member)
* Plan name and pricing details
* Invitation to discuss renewal needs
* Non-pushy, value-focused messaging (avoid mentioning price or discounts in custom prompts)

#### Recommended Settings

| Setting                  | Recommended Value       | Why                                                               |
| ------------------------ | ----------------------- | ----------------------------------------------------------------- |
| **Cooldown**             | 72–168 hours (3–7 days) | Allows multiple touches over renewal window                       |
| **Max Actions/Day**      | 10–15                   | Realistic for renewal conversations                               |
| **Auto-Execute**         | ✅ Enabled               | Safe for relationship-building after testing                      |
| **Confidence Threshold** | 80–97%                  | Increases as expiry approaches (0.85 base, up to 0.97 for urgent) |

#### Available Variables

Use these in custom prompts or voice messages:

* `{{customer_name}}` — Full name of the customer
* `{{customer_email}}` — Customer email address
* `{{contract_name}}` — Current plan or membership name
* `{{expiry_date}}` — When contract expires (formatted as `MMMM dd, yyyy`, e.g. `July 15, 2026`)
* `{{days_until_expiry}}` — Number of days remaining until contract expires
* `{{start_date}}` — When they joined your space (formatted as `MMMM dd, yyyy`)
* `{{tenure_days}}` — Total days as a member
* `{{contract_price}}` — Contract price formatted with currency (e.g. `USD 299.00`)
* `{{contract_quantity}}` — Number of contracts/units
* `{{company_name}}` — Name of your space/location (for voice messages)
* `{{session_id}}` — Unique session identifier (for voice messages)

#### Prompt Guidance

When customizing prompts, focus on:

* The value the member has received during their tenure
* A helpful, non-pushy tone about renewal
* **Do not** mention price or discounts — the operator handles negotiation

#### Best Practices

* Enable for all locations with active contracts
* Test first 5–10 renewals manually before enabling auto-execute
* Personalize the first message for VIP or high-value customers
* Monitor renewal conversion rates as a key performance indicator
* Consider adding promotional incentives in custom messages during slower periods
* Priority increases as expiry approaches: Critical (≤7 days), High (≤14 days), Medium (≤21 days), Low (>21 days)

***

## Support Agents

### 🟢 Support Pattern Detection

**Status:** ✅ Live\
**Category:** Support\
**Channel:** Email (default), WhatsApp, Voice supported\
**Auto-Execute Safe?** ❌ No

#### What It Does

Detects when a customer has submitted an unusually high number of support tickets within a configurable timeframe and proposes a proactive check-in to address underlying issues. The agent evaluates ticket frequency, priority levels, and open status to determine the appropriate outreach confidence and urgency.

#### When It Triggers

* Customer submits N+ support tickets within a configurable lookback window (default: 3 tickets in 14 days)
* Tickets are not already handled by AI chat sessions
* No recent proactive outreach has occurred for this member (deduplication by week)
* Daily action rate limit has not been reached

#### What It Monitors

* Support ticket frequency and recency within the lookback window
* Ticket priority levels (High and Critical increase confidence)
* Open vs. closed ticket status (open tickets indicate unresolved issues)
* Ticket subjects (top 3 most recent, used in criteria payload)
* Member's historical outreach cooldown status

#### Configuration Parameters

| Parameter                | Default | Description                                                        | Range        |
| ------------------------ | ------- | ------------------------------------------------------------------ | ------------ |
| **Minimum Ticket Count** | `3`     | Number of support tickets a member must submit to trigger outreach | 1–50 tickets |
| **Lookback Window**      | `14`    | Number of days to look back for ticket activity                    | 1–90 days    |

#### Message Content

The proposed outreach includes:

* Empathetic acknowledgment of recent support interactions
* Offer to help resolve any ongoing concerns
* Assurance that their experience matters
* Focus on listening, not listing specific ticket details or technical information

**Prompt Guidance:** The system prompt emphasizes empathy and offering help. Do not list specific ticket subjects or technical details. The goal is to make the member feel heard, not to troubleshoot.

#### Voice Message Content

When using the Voice channel, the system:

* Asks if now is a good time to speak
* Confirms speaking with the right person before discussing details
* Expresses genuine concern about recent experience
* Asks open-ended questions about how things are going
* Does NOT reference specific ticket numbers, technical details, or individual issues
* Offers to arrange a follow-up with the team if concerns remain unresolved
* Detects voicemails and hangs up immediately without leaving a message

#### Recommended Settings

| Setting                  | Recommended Value  | Why                                                              |
| ------------------------ | ------------------ | ---------------------------------------------------------------- |
| **Cooldown**             | 168 hours (1 week) | Prevents duplicate outreach to same member                       |
| **Max Actions/Day**      | 5–10               | Requires thoughtful review and personalization                   |
| **Auto-Execute**         | ❌ Disabled         | Always review context before sending                             |
| **Confidence Threshold** | 70–95%             | Auto-calculated based on ticket count, priority, and open status |

#### Confidence Scoring

Confidence is automatically calculated based on:

* **Base confidence:** 70% (threshold met)
* **+5%** for each ticket above the minimum (up to +15%)
* **+5%** if any tickets are High or Critical priority
* **+3%** if member has open (unresolved) tickets
* **Maximum:** 95%

#### Priority Determination

Priority is automatically determined based on:

* **High:** Ticket count ≥ 2x threshold OR any Critical-priority tickets
* **Medium:** Default for standard patterns

#### Available Variables

Use these in custom prompts or voice messages:

* `{{customer_name}}` — Full name of the customer
* `{{customer_email}}` — Customer email address
* `{{ticket_count}}` — Number of recent support tickets
* `{{lookback_days}}` — Configured lookback window in days
* `{{company_name}}` — Name of your space/location (voice messages)
* `{{session_id}}` — Unique session identifier (voice messages)

#### Best Practices

* Always review before sending — understand the context and ticket severity
* Escalate to your most senior support person or manager for high-priority cases
* Consider a phone call instead of email for critical patterns or repeated issues
* Track whether your outreach resolves the underlying issue and reduces ticket volume
* Adjust the Minimum Ticket Count and Lookback Window based on your space's support volume
* Use voice outreach for high-value members or critical situations

***

### 🟢 Support Category Spike

**Status:** ✅ Live\
**Category:** Support\
**Channel:** Internal note only\
**Auto-Execute Safe?** ✅ Yes (Internal only)

#### What It Does

Detects statistically significant spikes in support issues within specific categories compared to a rolling average baseline. When a spike is detected, it creates an internal alert for operators—not an outbound message to customers—to notify them of potential systemic issues requiring attention.

Support tickets are automatically classified into categories using AI analysis (Printing, WiFi, Access, Billing, Noise, HVAC, Cleaning, Booking, or Other). The agent then compares current weekly ticket volume against the historical average to identify anomalies.

**Example alert:** "Printing issues increased 300% this week (12 tickets vs. average 3). Possible printer problem."

#### When It Triggers

* A support category's weekly ticket count exceeds the rolling average by the configured spike multiplier (default: 2x increase)
* The historical baseline has at least the minimum number of tickets (default: 3) to ensure statistical significance
* Only formal support tickets are analyzed (tickets handled entirely by AI chat are excluded)
* One alert per category per week (deduplication prevents duplicate alerts)

#### What It Monitors

* Support ticket categories (auto-classified by AI on first evaluation)
* Current week's ticket count per category
* Rolling average baseline (configurable: 2–12 weeks, default 4 weeks)
* Spike magnitude (ratio of current week vs. baseline average)
* Ticket classification accuracy and confidence scores

#### Configuration Parameters

| Parameter                    | Default | Description                                                                                                | Range        |
| ---------------------------- | ------- | ---------------------------------------------------------------------------------------------------------- | ------------ |
| **Baseline Weeks**           | `4`     | Number of historical weeks to calculate the rolling average baseline                                       | 2–12 weeks   |
| **Spike Multiplier**         | `2`     | How many times above the baseline average to trigger an alert (e.g., 2x means 200% increase)               | 1.5–5x       |
| **Minimum Baseline Tickets** | `3`     | Minimum average tickets per week in baseline to trigger alerts (prevents noise from low-volume categories) | 1–10 tickets |

#### Message Content

Creates an internal note for operators with:

* Category name (e.g., "WiFi Access Issues")
* Current week's ticket count
* Historical baseline average for comparison
* Percentage increase (e.g., "300% increase")
* Sample ticket subjects from the spike period (top 3 most recent)
* Confidence score based on statistical significance
* Priority level (High for large spikes, Medium for moderate increases)

#### Recommended Settings

| Setting                  | Recommended Value  | Why                                          |
| ------------------------ | ------------------ | -------------------------------------------- |
| **Cooldown**             | 168 hours (1 week) | One alert per category per week              |
| **Max Actions/Day**      | 3–5                | Prevents alert fatigue across all categories |
| **Auto-Execute**         | ✅ Enabled          | Internal notes are safe to auto-create       |
| **Confidence Threshold** | N/A                | Not applicable for internal notes            |

#### Available Variables

Use these in internal note templates:

* `{{category}}` — Support issue category name (Printing, WiFi, Access, Billing, Noise, HVAC, Cleaning, Booking, or Other)
* `{{ticket_count}}` — Number of tickets in current week for this category
* `{{baseline_average}}` — Historical average tickets per week (rounded to nearest whole number)
* `{{percentage_increase}}` — Spike magnitude as percentage (e.g., "300%")
* `{{spike_multiplier}}` — Current week as multiple of baseline (e.g., "4x")
* `{{baseline_weeks}}` — Number of weeks used for baseline calculation
* `{{sample_subjects}}` — Top 3 most recent ticket subjects in this category
* `{{confidence_score}}` — Statistical confidence score (0–100%)
* `{{priority_level}}` — Alert priority (High or Medium)

#### Support Issue Categories

The AI classifier automatically categorizes support tickets into these 9 categories:

| Category     | Examples                                                                                      |
| ------------ | --------------------------------------------------------------------------------------------- |
| **Printing** | Printers, print jobs, print credit, scanners, copiers, paper jams, toner, print quality       |
| **WiFi**     | Internet connectivity, WiFi password, slow internet, network access, VPN, ethernet            |
| **Access**   | Building access, key cards, door codes, access control, entry/exit issues, badge problems     |
| **Billing**  | Invoice questions, payment issues, subscription problems, refunds, pricing, charges           |
| **Noise**    | Noise complaints, loud members, phone booth availability, quiet area violations, music volume |
| **HVAC**     | Temperature issues, AC problems, heating, ventilation, air quality                            |
| **Cleaning** | Dirty spaces, trash collection, spills, restroom cleanliness, desk maintenance, kitchen mess  |
| **Booking**  | Meeting room bookings, calendar conflicts, cancellations, availability, desk reservations     |
| **Other**    | General inquiries, suggestions, events, amenities, parking, mail/delivery, coffee/supplies    |

#### Best Practices

* Enable immediately for all locations with support ticket volume
* Review alerts daily and assign to appropriate team members (e.g., IT for WiFi or Printing spikes)
* Track whether alerts correlate with infrastructure issues or maintenance needs
* Use spike patterns to schedule proactive maintenance before customer complaints increase
* Adjust **Baseline Weeks** based on your space's seasonality (longer baselines for more stable averages)
* Lower **Minimum Baseline Tickets** if you want alerts for lower-volume categories
* Consider increasing **Spike Multiplier** if you receive too many alerts (e.g., from 2x to 3x)
* Review classification accuracy periodically — AI can be retrained if categories need refinement
* For multi-location businesses, alerts are business-wide; monitor per-location trends in your analytics dashboard

***

## Knowledge Agents

### 🟢 FAQ Gap Detection

**Status:** ✅ Live\
**Category:** Knowledge\
**Channel:** Internal note only\
**Auto-Execute Safe?** ✅ Yes (Internal only)

#### What It Does

Detects recurring questions that members ask but have no FAQ article to answer. When the same question theme is asked multiple times across different conversations within a configurable window, it creates an internal note for operators proposing a new FAQ article with an AI-generated draft based on available business information.

Rather than simply alerting you to gaps, this agent composes a ready-to-review FAQ draft using your space's resources, plans, opening hours, and previously answered support tickets as context.

**Example output:** "Members are asking about guest day-pass pricing (asked 8 times this week). Suggested FAQ draft attached."

#### When It Triggers

* The same question theme is asked N+ times (default: 3 times) within a configurable lookback window (default: 7 days)
* Questions are collected from two sources:
  * **HelpDesk auto-reply failures** — Where the AI could not find a matching FAQ to auto-reply
  * **AI Chat FAQ tool failures** — Where the interactive chat's FAQ lookup returned no relevant article
* Questions are clustered by semantic similarity (e.g., "What time do you open?", "Opening hours?", "When does the space close?" are grouped together)
* One internal note per question theme per evaluation cycle (deduplication prevents duplicate suggestions)

#### What It Monitors

* HelpDesk messages where AI auto-reply failed (FAQ embedding match below threshold)
* AI Chat sessions where the FAQ tool returned no relevant article
* Question semantic similarity across all unanswered questions
* Frequency of each question theme within the lookback window

#### Configuration Parameters

| Parameter                    | Default | Description                                                                          | Range            |
| ---------------------------- | ------- | ------------------------------------------------------------------------------------ | ---------------- |
| **Minimum Occurrences**      | `2`     | Number of times a question theme must be asked to trigger a suggestion               | 1–50 occurrences |
| **Lookback Window**          | `21`    | Number of days to look back for unanswered questions                                 | 1–90 days        |
| **Similarity Threshold**     | `0.70`  | How similar questions must be to be grouped together (higher = stricter matching)    | 0.50–0.95        |
| **Max Questions to Process** | `100`   | Maximum number of unanswered questions to analyze per evaluation (most recent first) | 10–500           |

#### Message Content

Creates an internal note for operators with:

* **Question theme** — Normalized label for the recurring question (e.g., "Guest day-pass pricing")
* **Occurrence count** — How many times this question was asked in the lookback window
* **Sample questions** — Up to 5 actual questions from real conversations showing how members phrased the question
* **AI-generated FAQ draft** including:
  * **Title** — Clear, searchable question title (e.g., "What are the opening hours?")
  * **Summary** — 1–2 sentence answer
  * **Full Text** — Detailed answer using business context (resources, plans, opening hours, etc.)
* **Context sources used** — Which business data was used to compose the draft (e.g., "Used opening hours, resource list, and 2 previously answered support tickets")
* **"Needs Operator Input" markers** — Sections marked `[NEEDS OPERATOR INPUT]` where the AI didn't have enough context to answer accurately
* **"Create FAQ" action button** — Routes to the FAQ editor with pre-filled title and body for quick review and publishing

#### Draft Generation Context

The AI draft is composed using the following business information:

| Context Source                          | Data Used                              | Why                                                  |
| --------------------------------------- | -------------------------------------- | ---------------------------------------------------- |
| **Business details**                    | Name, opening hours, address, timezone | Many questions relate to basic location info         |
| **Resources**                           | Resource names, descriptions, types    | "How do I book the meeting room?" needs room names   |
| **Plans**                               | Plan names, descriptions, prices       | Pricing and plan questions are common                |
| **Previously answered support tickets** | Human answers to similar questions     | Excellent source material for FAQ content            |
| **Sample unanswered questions**         | Actual member phrasing (top 5)         | Ensures the draft addresses how members actually ask |

#### Recommended Settings

| Setting                  | Recommended Value  | Why                                                          |
| ------------------------ | ------------------ | ------------------------------------------------------------ |
| **Cooldown**             | 168 hours (1 week) | Batch review of content gaps; prevents duplicate suggestions |
| **Max Actions/Day**      | 3–5                | Manageable for content team review                           |
| **Auto-Execute**         | ✅ Enabled          | Internal notes create no customer impact                     |
| **Confidence Threshold** | N/A                | Not applicable for internal notes                            |

#### Available Variables

Use these in internal note templates:

* `{{question_theme}}` — Normalized topic label (e.g., "Guest day-pass pricing")
* `{{occurrence_count}}` — Number of times this question was asked
* `{{lookback_days}}` — Configured lookback window in days
* `{{sample_questions}}` — Up to 5 actual questions from real conversations
* `{{draft_title}}` — AI-generated FAQ title
* `{{draft_summary}}` — AI-generated 1–2 sentence summary
* `{{draft_full_text}}` — AI-generated full FAQ article text
* `{{needs_operator_input}}` — Boolean indicating if the draft has sections needing human input
* `{{context_sources_used}}` — List of business data sources used for the draft
* `{{similarity_threshold}}` — Configured similarity threshold for clustering

#### Best Practices

* Enable immediately for all locations with AI chat or HelpDesk auto-reply enabled
* Review detected gaps weekly as a batch rather than individually
* Prioritize by frequency — most-asked questions should become FAQs first
* Assign FAQ creation to your content manager or knowledge owner
* Use the "Create FAQ" action button to publish drafts quickly after review
* Track FAQ implementation and remeasure after 2 weeks to verify the gap is closed
* Measure reduction in unanswered questions as your success metric
* Adjust **Minimum Occurrences** based on your space's question volume (lower for busier spaces)
* Lower **Similarity Threshold** if you want broader question grouping (e.g., 0.75 instead of 0.80)
* Increase **Lookback Window** if you want to detect slower-building patterns (e.g., 14 days instead of 7)
* Review `[NEEDS OPERATOR INPUT]` sections and fill in missing information before publishing

***

## Sales Agents

### 🔜 Lead Follow-up

**Status:** 🔜 Coming Soon\
**Category:** Sales\
**Channel:** Email\
**Auto-Execute Safe?** ⚠️ With caution

#### What It Does

Proposes follow-up messages for potential leads who inquired but haven't converted. Monitors AI sessions from non-members who asked about tours, pricing, or availability.

#### When It Triggers

* Lead completed AI session asking about tours, pricing, or plans
* No conversion occurred (no booking or membership signup)
* Configurable dormancy period has passed (e.g., 7 days)
* Lead hasn't already received recent outreach

#### What It Monitors

* AI conversation intent from non-members
* Engagement level in AI chat
* Topics discussed (pricing, availability, tour interest)
* Time since last interaction
* Conversion status

#### Message Content

Follow-up includes:

* Reference to their earlier inquiry
* Personalized response to their specific questions
* Clear call-to-action (schedule tour, get pricing, start trial)
* Offer to answer remaining questions
* Time-limited incentive (if configured)

#### Recommended Settings

| Setting                  | Recommended Value  | Why                                  |
| ------------------------ | ------------------ | ------------------------------------ |
| **Cooldown**             | 168 hours (1 week) | Respects lead fatigue                |
| **Max Actions/Day**      | 10–20              | Scales with lead flow                |
| **Auto-Execute**         | ⚠️ Use caution     | Safe once you've validated messaging |
| **Confidence Threshold** | 80%+               | Only for high-intent leads           |

#### Available Variables

* `{{lead_name}}` — Lead's full name
* `{{inquiry_topic}}` — What they asked about (tour, pricing, etc.)
* `{{inquiry_date}}` — When they inquired
* `{{inquiry_details}}` — Specific questions they asked
* `{{available_tours}}` — Upcoming tour dates
* `{{pricing_link}}` — Link to pricing page

#### Best Practices

* Start with manual review — validate that message quality is good
* Personalize responses based on what they actually asked
* Don't enable auto-execute until you've reviewed 20+ proposed messages
* Monitor conversion rates to leads you follow up with
* Segment leads by intent level (tour interest vs. general inquiry)
* Adjust timing based on sales cycle length

***

### 🔜 Tour Reminders

**Status:** 🔜 Coming Soon\
**Category:** Sales\
**Channel:** Email\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Sends friendly reminders before scheduled tours with helpful preparation information. Monitors upcoming tour bookings and proposes reminder messages at configurable intervals.

#### When It Triggers

* Tour is scheduled for future date
* Reminder timing configured (e.g., 24 hours before, 1 hour before)
* Tour hasn't been cancelled
* Previous reminder hasn't already been sent

#### What It Monitors

* Tour booking schedules
* Prospect contact information
* Tour timing and location details
* Tour cancellation status

#### Message Content

Reminders include:

* Personalized greeting to the prospect
* Tour date, time, and location
* Parking information and directions
* What to bring (ID, questions to prepare)
* Building access instructions
* Contact number if they need to reschedule
* Optional: virtual tour link if they can't attend in person

#### Recommended Settings

| Setting                  | Recommended Value | Why                             |
| ------------------------ | ----------------- | ------------------------------- |
| **Cooldown**             | 24 hours          | One reminder per day            |
| **Max Actions/Day**      | 20–50             | Scales with tour volume         |
| **Auto-Execute**         | ✅ Enabled         | Helpful, low-risk communication |
| **Confidence Threshold** | 85%+              | High confidence in tour details |

#### Available Variables

* `{{prospect_name}}` — Tour attendee's name
* `{{tour_time}}` — Scheduled date and time
* `{{tour_location}}` — Address and directions
* `{{parking_info}}` — Parking instructions
* `{{building_access}}` — How to enter the building
* `{{reschedule_link}}` — Link to reschedule if needed
* `{{contact_number}}` — Your phone number
* `{{location_name}}` — Name of your space

#### Best Practices

* Enable immediately — tour reminders are universally appreciated
* Send first reminder 24 hours before tour
* Consider second reminder 1 hour before for same-day confirmation
* Include parking and access details to reduce no-shows
* Monitor tour attendance and no-show rates
* Adjust reminder timing based on your show-up rate

***

### 🔜 Tour No-Show Follow-up

**Status:** 🔜 Coming Soon\
**Category:** Sales\
**Channel:** Email\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Reaches out to prospects who scheduled a tour but did not show up. Detects when a tour booking occurred but the prospect didn't check in or arrive, and proposes a friendly follow-up.

#### When It Triggers

* Tour booking was scheduled
* Tour time has passed
* No check-in or arrival was recorded
* Booking is marked as "no-show"

#### What It Monitors

* Tour booking schedules vs. actual attendance
* Check-in records
* Prospect contact information
* No-show status

#### Message Content

Follow-up includes:

* Friendly, non-judgmental tone
* Acknowledgment of missed tour
* Offer to reschedule with specific available times
* Question about what might have prevented attendance
* Assurance of willingness to accommodate their schedule
* Alternative: virtual tour option

#### Recommended Settings

| Setting                  | Recommended Value | Why                               |
| ------------------------ | ----------------- | --------------------------------- |
| **Cooldown**             | 24 hours          | Send day-of or day-after          |
| **Max Actions/Day**      | 10–20             | Depends on no-show rate           |
| **Auto-Execute**         | ✅ Enabled         | Helpful follow-up, safe messaging |
| **Confidence Threshold** | 90%+              | Only for confirmed no-shows       |

#### Available Variables

* `{{prospect_name}}` — Name of prospect who missed tour
* `{{tour_date}}` — Date they were scheduled for
* `{{tour_time}}` — Time of missed tour
* `{{available_times}}` — Next available tour times
* `{{reschedule_link}}` — Link to reschedule
* `{{contact_number}}` — Your phone number
* `{{virtual_tour_link}}` — Link to virtual tour if available
* `{{location_name}}` — Name of your space

#### Best Practices

* Enable immediately — follow-up quickly after no-show
* Keep tone friendly and understanding
* Offer multiple rescheduling options (dates and times)
* Include virtual tour link as alternative
* Track reschedule conversion rate
* Consider reaching out via phone call for high-value leads

***

### 🔜 Lead Qualification Scoring

**Status:** 🔜 Coming Soon\
**Category:** Sales\
**Channel:** Internal note only\
**Auto-Execute Safe?** ✅ N/A (Internal only)

#### What It Does

Scores and qualifies leads based on conversation interactions and enrichment data. Analyzes AI chat sessions with prospects to extract qualification signals and determine sales priority.

#### When It Triggers

* Lead completes an AI conversation (or reaches certain length/engagement)
* Sufficient signals extracted to score lead quality
* Score changes lead's tier (hot → warm, warm → cold, etc.)
* Integration with CRM systems for pipeline sync

#### What It Monitors

* AI chat session length and engagement
* Budget mentions and price sensitivity
* Team size and space requirements
* Move-in timeline and urgency
* Must-have features and nice-to-haves
* Decision-maker presence
* Objection handling

#### Message Content

Creates internal note with:

* Lead qualification score (Hot/Warm/Cold)
* Key signals and reasoning
* Recommended next action
* Suggested follow-up timing
* CRM sync status
* Priority assignment for sales team

#### Recommended Settings

| Setting                  | Recommended Value | Why                                 |
| ------------------------ | ----------------- | ----------------------------------- |
| **Cooldown**             | 24 hours          | Re-score only once per day          |
| **Max Actions/Day**      | 50+               | Can handle volume of prospects      |
| **Auto-Execute**         | ✅ Enabled         | Internal notes, auto-create is safe |
| **Confidence Threshold** | N/A               | Not applicable                      |

#### Available Variables

* `{{prospect_name}}` — Prospect's name
* `{{score_tier}}` — Hot/Warm/Cold
* `{{confidence_score}}` — Numeric confidence (0-100%)
* `{{key_signals}}` — Main qualifying factors
* `{{recommended_action}}` — Next step (call, follow-up, etc.)
* `{{suggested_timeline}}` — When to follow up

#### Best Practices

* Enable to segment leads by priority
* Set up CRM integration for automatic pipeline sync
* Use Hot tier for immediate sales outreach
* Monitor scoring accuracy — adjust signals quarterly
* Train sales team on how to interpret scoring signals
* Track conversion by lead tier to validate scoring model

***

## Engagement Agents

### 🔜 Onboarding Nudges

**Status:** 🔜 Coming Soon\
**Category:** Engagement\
**Channel:** Email\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Sends helpful reminders when new customers haven't completed expected first-week actions. Tracks onboarding milestones for new members and proposes nudge messages when expected actions haven't been completed.

#### When It Triggers

* New customer joins your space
* First-week milestone actions are tracked:
  * First booking not made within 3 days
  * WiFi not connected within 2 days
  * App not downloaded within 3 days
  * Welcome email not opened within 1 day
* Customizable thresholds for each milestone

#### What It Monitors

* Customer account creation date
* First booking date
* App downloads and logins
* WiFi network connections
* Email opens and clicks
* Member portal access

#### Message Content

Nudges include:

* Friendly, encouraging tone
* What milestone is missing
* Why it matters (benefits of completing)
* Step-by-step instructions to complete
* Link or direct path to take action
* Offer to help if stuck

#### Recommended Settings

| Setting                  | Recommended Value | Why                                 |
| ------------------------ | ----------------- | ----------------------------------- |
| **Cooldown**             | 24 hours          | One nudge per day per milestone     |
| **Max Actions/Day**      | 10–20             | Scales with new member rate         |
| **Auto-Execute**         | ✅ Enabled         | Helpful, low-risk engagement        |
| **Confidence Threshold** | 85%+              | High confidence in onboarding needs |

#### Available Variables

* `{{customer_name}}` — New member's first name
* `{{signup_date}}` — When they joined
* `{{missing_milestone}}` — What they haven't done yet
* `{{milestone_benefit}}` — Why they should do it
* `{{action_link}}` — Direct link to complete action
* `{{phone_number}}` — Your phone number
* `{{location_name}}` — Name of your space

#### Best Practices

* Enable immediately for all new customers
* Customize milestones based on your onboarding flow
* Keep instructions short and clear
* Link directly to actions (WiFi setup, app store, etc.)
* Track completion rates by milestone
* Consider phone check-in for VIP or corporate memberships
* Adjust thresholds based on your space's typical onboarding timeline

***

### 🔜 Booking No-Show Follow-up

**Status:** 🔜 Coming Soon\
**Category:** Engagement\
**Channel:** Email\
**Auto-Execute Safe?** ✅ Yes

#### What It Does

Follows up with customers who booked a resource (meeting room, desk, etc.) but did not check in or show up. Monitors bookings and detects no-shows, then proposes a check-in message.

#### When It Triggers

* Resource booking is scheduled (past date/time)
* No check-in or arrival recorded
* Booking is marked as "no-show"
* Previous follow-up hasn't already been sent

#### What It Monitors

* Resource booking schedules
* Check-in records
* Customer history of no-shows
* Booking cancellation vs. no-show pattern

#### Message Content

Follow-up includes:

* Friendly check-in tone
* Acknowledgment of missed booking
* Confirmation that space is still available if rescheduled
* Reminder about cancellation policies
* Option to reschedule for future date
* Offer of assistance with future bookings

#### Recommended Settings

| Setting                  | Recommended Value | Why                               |
| ------------------------ | ----------------- | --------------------------------- |
| **Cooldown**             | 48 hours          | Not too aggressive                |
| **Max Actions/Day**      | 10–15             | Depends on no-show rate           |
| **Auto-Execute**         | ✅ Enabled         | Helpful, low-risk follow-up       |
| **Confidence Threshold** | 85%+              | High confidence in no-show status |

#### Available Variables

* `{{customer_name}}` — Member's name
* `{{resource_name}}` — Room or desk booked
* `{{booking_date}}` — Date of booking
* `{{booking_time}}` — Time of booking
* `{{cancellation_policy}}` — Your cancellation terms
* `{{reschedule_link}}` — Link to reschedule
* `{{contact_number}}` — Your phone number
* `{{location_name}}` — Name of your space

#### Best Practices

* Enable immediately — follow-up quickly after no-show
* Use friendly, understanding tone
* Include clear cancellation policy reminders
* Make rescheduling easy with direct link
* Track no-show patterns by customer
* Consider charging cancellation fee only after pattern of no-shows
* Proactively reach out to repeat offenders via phone

***

## Retention Agents

### 🔜 At-Risk Member Detection

**Status:** 🔜 Coming Soon\
**Category:** Retention\
**Channel:** Email\
**Auto-Execute Safe?** ❌ No

#### What It Does

Identifies customers showing declining engagement and proposes proactive retention outreach. Analyzes usage patterns and detects statistically significant drops compared to historical baseline.

#### When It Triggers

* Usage metrics show significant decline:
  * Check-in frequency down 50%+ from previous period
  * Booking frequency down significantly
  * Payment patterns change (late payments, disputes)
* Change is sustained over configurable period (e.g., 2 weeks)
* Customer is not already flagged for other retention efforts
* No recent proactive outreach attempted

#### What It Monitors

* Historical check-in patterns
* Booking frequency trends
* Invoice payment history
* Resource usage intensity
* Time since last check-in
* Contract approaching expiry

#### Message Content

Retention outreach includes:

* Personalized acknowledgment of customer
* Specific observation about their changing usage
* Offer of help to understand barriers
* Highlighting unused benefits or features
* Suggestion to adjust plan if needs have changed
* Value reminder and company culture fit
* Direct access to manager for one-on-one discussion

#### Recommended Settings

| Setting                  | Recommended Value  | Why                              |
| ------------------------ | ------------------ | -------------------------------- |
| **Cooldown**             | 168 hours (1 week) | Space out retention efforts      |
| **Max Actions/Day**      | 5–10               | Requires thoughtful review       |
| **Auto-Execute**         | ❌ Disabled         | Always requires personal context |
| **Confidence Threshold** | N/A                | Manual review only               |

#### Available Variables

* `{{customer_name}}` — Member's name
* `{{previous_avg_checkins}}` — Historical check-in rate
* `{{current_checkins}}` — Recent check-in rate
* `{{usage_change}}` — Percentage decline
* `{{days_since_checkin}}` — Days inactive
* `{{unused_features}}` — Benefits they don't use
* `{{plan_name}}` — Current plan
* `{{manager_name}}` — Manager's name for personal outreach
* `{{location_name}}` — Name of your space

#### Best Practices

* Never auto-execute — always review for context
* Personalize based on their specific usage pattern
* Highlight specific benefits they're not using
* Offer plan adjustment or flexibility
* Consider offering temporary rate discount or waived fees
* Escalate to manager for high-value customers
* Track whether retention efforts successfully re-engage customer

***

### 🔜 Cancellation Risk Detection

**Status:** 🔜 Coming Soon\
**Category:** Retention\
**Channel:** Internal note only\
**Auto-Execute Safe?** ✅ N/A (Internal only)

#### What It Does

Identifies early warning signals that a customer might cancel their contract. Uses multiple signals to predict cancellation risk and creates internal alerts for high-risk members.

#### When It Triggers

* Multiple risk signals detected (weighted scoring):
  * Declining usage (50 points)
  * Overdue payment (40 points)
  * Support ticket sentiment negative (30 points)
  * Contract approaching end date (20 points)
  * Failed payment methods (30 points)
* Total risk score exceeds threshold (e.g., 75 points = high risk)
* Risk is flagged for internal action

#### What It Monitors

* Check-in trends and patterns
* Invoice payment status
* Support ticket sentiment and frequency
* Contract end date proximity
* Payment method status
* Engagement in location events
* NPS/survey scores if available

#### Message Content

Creates internal alert with:

* Customer name and contract details
* Risk score and severity (Low/Medium/High)
* Specific risk signals triggered
* Days until contract renewal opportunity
* Suggested retention actions
* Recommended next step (call, offer, etc.)

#### Recommended Settings

| Setting                  | Recommended Value  | Why                                 |
| ------------------------ | ------------------ | ----------------------------------- |
| **Cooldown**             | 168 hours (1 week) | Weekly risk assessment              |
| **Max Actions/Day**      | 5–10               | Depends on customer base size       |
| **Auto-Execute**         | ✅ Enabled          | Internal notes, auto-create is safe |
| **Confidence Threshold** | N/A                | Not applicable                      |

#### Available Variables

* `{{customer_name}}` — Member's name
* `{{risk_score}}` — Numeric risk (0-100) |
* `{{risk_tier}}` — Low/Medium/High
* `{{risk_factors}}` — List of triggers
* `{{days_to_expiry}}` — Days until renewal
* `{{recommended_action}}` — Suggested next step
* `{{manager_assignment}}` — Recommended manager to handle

#### Best Practices

* Review high-risk members immediately
* Assign to manager for proactive outreach
* Don't wait until contract renewal deadline
* Offer preventative incentives before ask for retention
* Track which interventions are most effective
* Monitor risk score trends over time
* Celebrate successes when at-risk customer re-engages

***

## Revenue Agents

### 🔜 Upsell Opportunities

**Status:** 🔜 Coming Soon\
**Category:** Revenue\
**Channel:** Email\
**Auto-Execute Safe?** ❌ No

#### What It Does

Detects when customer usage patterns suggest they would benefit from an upgrade. Monitors usage intensity and frequency to identify customers who consistently need more than their current plan offers.

#### When It Triggers

* Customer usage exceeds plan limits:
  * Frequently books last-minute resources (capacity constraint)
  * Day passes purchased alongside main plan (coverage gap)
  * Extra hour credits purchased frequently (time gap)
  * Meeting room requests denied due to availability
* Pattern sustained over configurable period (e.g., 30 days)
* Upgrade plan is relevant to their usage pattern
* Customer not recently offered upsell

#### What It Monitors

* Booking frequency relative to plan allowance
* Day pass and credit purchases
* Resource availability and booking denials
* Usage growth trends
* Customer segment and plan tier
* Contract tenure and growth trajectory

#### Message Content

Upsell opportunity includes:

* Data-driven observation: "You've booked a meeting room 15 times in the past month, but your plan includes 5. We noticed you're consistently running out..."
* Specific upgrade recommendation with ROI
* Comparison of current plan vs. recommended plan
* Cost savings from consolidating separate purchases
* Trial period offer if new plan type
* Success story from similar customer
* Limited-time upgrade incentive

#### Recommended Settings

| Setting                  | Recommended Value  | Why                           |
| ------------------------ | ------------------ | ----------------------------- |
| **Cooldown**             | 168 hours (1 week) | Don't be aggressive           |
| **Max Actions/Day**      | 5–10               | Requires personalization      |
| **Auto-Execute**         | ❌ Disabled         | Sensitive to customer context |
| **Confidence Threshold** | N/A                | Manual review recommended     |

#### Available Variables

* `{{customer_name}}` — Member's name
* `{{current_plan}}` — Their current plan
* `{{recommended_plan}}` — Suggested upgrade
* `{{usage_metric}}` — What exceeded (bookings, credits, etc.)
* `{{usage_amount}}` — How much they used
* `{{plan_limit}}` — Plan limit exceeded
* `{{roi_savings}}` — Monthly savings if upgraded
* `{{upgrade_link}}` — Link to upgrade
* `{{trial_period}}` — Any trial offer

#### Best Practices

* Never auto-execute — upsells need personalization
* Start with data (show their actual usage)
* Lead with value, not price
* Offer trial period for new plan types
* Consider proactive discount for price-sensitive customers
* Group related upsells together
* Track conversion rate by segment
* Monitor churn after rejected upsells (might indicate pricing issue)

***

## Configuration Summary by Category

### Safe for Auto-Execute

These agents are good candidates for auto-execute after initial testing:

* ✅ **Due Invoice Reminders** — Factual, expected
* ✅ **Contract Renewal** — Relationship-building, timely
* ✅ **Onboarding Nudges** — Helpful, low-risk
* ✅ **Tour Reminders** — Expected, appreciated
* ✅ **Tour No-Show Follow-up** — Friendly, helpful
* ✅ **Booking No-Show Follow-up** — Gentle check-in

### Requires Manual Review

These agents benefit from human judgment before sending:

* ❌ **Support Pattern Detection** — Needs context understanding
* ❌ **At-Risk Member Detection** — Personal touch needed
* ❌ **Upsell Opportunities** — Sensitive to customer relationship
* ⚠️ **Lead Follow-up** — Quality control important
* 📝 **Internal agents** — Review before action taken

### Internal Notes Only

These create notes for your team, not customer messages:

* 📝 **Support Category Spike**
* 📝 **FAQ Gap Detection**
* 📝 **Cancellation Risk Detection**
* 📝 **Lead Qualification Scoring**

***

## Getting Started with Agents

### Week 1: Foundation

1. Enable **Due Invoice Reminders** and **Contract Renewal**
2. Keep both on manual review for first 10 actions each
3. Review AI Inbox daily to understand agent quality
4. Monitor customer responses and feedback

### Week 2–3: Expansion

1. If satisfied with quality, enable auto-execute at 85% threshold
2. Monitor approval rates and adjust confidence threshold as needed
3. Consider enabling **Tour Reminders** if you conduct tours
4. Keep other agents on manual review for learning

### Week 4+: Optimization

1. Analyze approval rates and rejection patterns
2. Adjust cooldowns and rate limits based on your workflow
3. Consider expanding to engagement agents (Onboarding Nudges, etc.)
4. Build custom prompts to match your location's voice

***

## Related Documentation

* [Configuring Agents](/platform/ai/configuring-agents) — Step-by-step configuration guide
* [Proactive Agents Overview](/platform/ai/proactive-agents) — How the system works
* [AI Inbox](/platform/ai/inbox) — Review and approve proposed actions
* [AI Conversations](/platform/ai/ai-conversations) — View two-way conversations


# Business Hours for Voice Calls
Source: https://learn.nexudus.com/platform/ai/business-hours

Learn how Nexudus ensures outbound voice calls from AI agents only happen during acceptable hours in the recipient's local timezone, including calling windows, holiday detection, and deferral rules.

<Frame>
  <img alt="AI Calling Hours" />
</Frame>

## Overview

When AI agents initiate outbound voice calls to your members or contacts, Nexudus automatically checks that the call is being made during acceptable hours **in the recipient's local timezone**. This protects your reputation, respects your members' boundaries, and helps you comply with legal restrictions on calling times in different jurisdictions.

Calls that fall outside the configured calling hours are **automatically deferred** until the next available window — they are never rejected or lost.

<Info>
  Business hours enforcement applies to **all** outbound voice calls from AI agents, whether automated or manually approved. You can disable enforcement entirely in settings, but it's enabled by default for safety.
</Info>

## How It Works

The system uses three pieces of information to decide when a call can be made:

1. **Recipient's timezone** — Determined from the recipient's primary location (Invoicing Business). All calling hours are evaluated in the recipient's local time, not yours.
2. **Your calling window** — The start and end times you configure for when calls are acceptable (default: 9:00am – 5:00pm).
3. **Holiday and closure periods** — If the recipient's location is marked as closed on a particular day, or if there's an active holiday period, calls are blocked during that time.

### The Decision Flow

When an AI agent proposes a voice call, the system checks:

1. **Is enforcement enabled?** — If you've disabled business hours checks, the call proceeds immediately.
2. **Is the recipient's location on a holiday?** — Checks against any active Booking Availability Exceptions (like "Christmas Day" or "Bank Holiday").
3. **Is it a weekend?** — If weekend calls are disabled and today is Saturday or Sunday, the call is deferred.
4. **Is the recipient's location closed today?** — Uses the per-day opening hours configured for the recipient's business.
5. **Is it within the calling window?** — Checks if the current time (in recipient's local timezone) falls between your configured start and end times.

If any check fails, the call is **deferred** with a reason, and a scheduled time is set for the next available window.

## Configuration

Business hours settings are configured per location in the Dashboard. Navigate to **Settings → AI Assistants → Voice Agent** to find the calling hours section.

### Calling Hours Settings

| Setting                                | Default           | Description                                                                                                        |
| -------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Disable Business Hours Enforcement** | Off               | When turned on, calls can be made at any time. Only disable for testing or if you manage calling hours externally. |
| **Calling Window Start**               | 9:00am (540 min)  | Earliest time to make calls in the recipient's local timezone.                                                     |
| **Calling Window End**                 | 5:00pm (1020 min) | Latest time to make calls in the recipient's local timezone.                                                       |
| **Allow Weekend Calls**                | Off               | Permit calls on Saturday and Sunday during the calling window.                                                     |
| **Allow Calls During Holidays**        | Off               | Permit calls during periods marked as holidays at the recipient's location.                                        |
| **Maximum Deferral Hours**             | 72 hours          | Maximum time to wait for the next calling window before expiring a deferred action.                                |

### Timezone Handling

The system automatically handles timezone conversions and daylight saving time (DST) changes. For example:

* Your location is in London (BST, UTC+1)
* Your member is in New York (EDT, UTC-4)
* You schedule a call at 3:00pm London time on a summer day

The system converts 3:00pm BST to 10:00am EDT and checks whether 10:00am falls within **the member's** calling window — not yours.

## What Happens When a Call Is Deferred

When a call cannot be made immediately, the system:

1. **Changes the action status** to "Deferred" in your AI Inbox
2. **Records the reason** — For example, "After calling hours (closed at 5:00pm recipient time)" or "Recipient location is on holiday"
3. **Schedules the next attempt** — Sets a `ScheduledExecutionTime` for the next available calling window
4. **Tracks deferral count** — Increments a counter so you can see how many times an action has been delayed

### Viewing Deferred Actions

Deferred actions appear in your [AI Inbox](/platform/ai/inbox) with:

* A **Deferred** badge showing the next scheduled execution time
* The **reason** for deferral (e.g., "Outside calling hours")
* The **recipient's local time** when the check was performed
* The **next execution time** in both UTC and recipient local time

### Manual Execution

If you manually approve or execute a deferred voice action from the Inbox:

* Business hours checks are **still applied**
* If it's still outside calling hours for the recipient, the action returns to Deferred status with an updated scheduled time
* The only way to bypass enforcement is to disable it entirely in settings

## Holiday Detection

Nexudus uses **Booking Availability Exceptions** to detect holiday and closure periods. When you mark a period as a holiday at a recipient's location (for example, "Christmas Day" or a "Bank Holiday"), the system treats that entire period as a time when calls should not be made.

If **Allow Calls During Holidays** is enabled, holiday periods are ignored and calls proceed according to the normal calling window.

## Closed Days

The system respects the per-day opening hours configured for each business. If a recipient's location is marked as closed on a particular day of the week (for example, closed on Sundays), calls are automatically blocked on that day.

When calculating the next available calling time, the system skips over closed days and finds the next day the recipient's location is open and within the calling window.

## Best Practices

* **Keep enforcement enabled** — Business hours protection is a safety feature that helps maintain professional standards and legal compliance.
* **Set appropriate calling windows** — Consider the jurisdictions your members are in and set calling hours that respect local norms.
* **Use holiday detection** — Mark closure periods in Booking Availability Exceptions so the system knows not to schedule calls during those times.
* **Review deferred actions** — Regularly check your AI Inbox for deferred actions and verify that the deferral reasons make sense for each recipient.
* **Be careful with weekend calls** — If your members span multiple timezones, enabling weekend calls may result in calls being made at unexpected times in some regions.

## Related Features

* [Proactive Agents](/platform/ai/proactive-agents) — How AI agents monitor patterns and propose actions
* [AI Inbox](/platform/ai/inbox) — Review and manage proposed actions
* [Configuring Agents](/platform/ai/configuring-agents) — Set up and customize your AI agents
* [Booking Availability Exceptions](/platform/operations/bookings#availability-exceptions) — Configure holiday and closure periods


# Configuring Agents
Source: https://learn.nexudus.com/platform/ai/configuring-agents

Step-by-step guide to enabling agents, setting confidence thresholds, configuring rate limits, and customizing message behavior.

<Frame>
  <img alt="AI Agent Configuration" />
</Frame>

## Overview

Once you've identified which proactive AI agents are right for your space, the next step is configuring each one to match your operational needs. The configuration panel lets you control **when** an agent acts, **how often**, **through which channel**, and **what tone** its messages use.

This page walks you through every setting available in the **Agent Configuration** panel, from enabling an agent to testing voice calls.

**Route:** [Configure Agents](https://dashboard.nexudus.com/operations/configureAgents) (click any agent card to open its configuration)

<CardGroup>
  <Card title="Agent Types Reference" icon="list" href="/platform/ai/agent-types">
    Detailed guide to all available agents, what they do, and recommended settings.
  </Card>

  <Card title="AI Inbox" icon="inbox" href="https://dashboard.nexudus.com/operations/inbox">
    Review and manage proposed actions from your agents.
  </Card>
</CardGroup>

***

## Enabling an Agent

Before you can configure an agent, you need to enable it.

1. Navigate to **Operations > AI Agents**
2. Find the agent you want to enable in the grid
3. Click the **toggle switch** on the agent card
4. The status badge changes from **Inactive** (grey) to **Active** (green)

When you enable an agent for the first time, Nexudus automatically creates a configuration with **default settings** specific to that agent. These defaults are a safe starting point — you can customize them after enabling.

> **Tip:** Enable one agent at a time. This lets you understand how each agent behaves before adding more.

***

## Opening the Configuration Panel

After enabling an agent (or if it's already enabled), click anywhere on the agent card to open its **Configuration Panel**. The panel is organized into three sections:

1. **Basic Settings** — Enable/disable and view agent description
2. **Execution & Behavior** — Auto-execute, confidence threshold, cooldown, and rate limits
3. **Communication Settings** — Channel, voice scripts, and custom instructions (outbound agents only)

At the bottom of the panel, you'll also find a **Test Configuration** section for verifying voice call quality.

***

## Basic Settings

### Enable / Disable

The master switch for the agent. When disabled, the agent stops evaluating criteria and proposing actions immediately. Re-enabling it resumes monitoring from that point forward.

* **Active** (green badge) — Agent is monitoring and proposing actions
* **Inactive** (grey badge) — Agent is paused

> **Note:** Disabling an agent does **not** delete your configuration. All your custom settings are preserved and will be applied when you re-enable it.

***

## Execution & Behavior

These settings control **when** and **how often** the agent takes action. They appear once the agent is enabled.

### Auto-Execution

Auto-execute allows high-confidence actions to be sent automatically without waiting for your manual approval in the AI Inbox. This is useful for routine, low-risk actions where you trust the AI's judgment.

**How it works:**

1. The agent detects a pattern and calculates a confidence score (0–100%)
2. If auto-execute is enabled and the score meets or exceeds your threshold, the action is sent immediately
3. Actions below the threshold still appear in your AI Inbox for manual review

**When to enable auto-execute:**

**Good candidates:**

* Payment reminders (factual, expected communication)
* Contract renewal outreach (timely, relationship-building)
* Onboarding nudges (helpful, low-risk)

**Keep manual review for:**

* At-risk member detection (needs personal context)
* Support pattern outreach (requires understanding of issue severity)
* Any agent where the message tone needs your personal touch

**Minimum Confidence Threshold**

When auto-execute is enabled, a slider appears allowing you to set the minimum confidence level required for automatic sending.

| Threshold   | What it means                                                                            |
| ----------- | ---------------------------------------------------------------------------------------- |
| **50%**     | Very permissive — half of all detected patterns are auto-executed                        |
| **75%**     | Moderate — only reasonably confident actions are sent automatically                      |
| **85%–90%** | Conservative — only high-confidence actions are auto-executed (recommended for starting) |
| **100%**    | No auto-execute — all actions require manual review                                      |

**Recommended approach:**

1. Start with auto-execute **disabled** while you learn how the agent behaves
2. After 1–2 weeks of manual review, enable auto-execute at **85%**
3. Adjust up or down based on how many actions you're approving vs. rejecting

<CardGroup>
  <Card title="Start Safe" icon="check">
    Enable auto-execute only after testing with manual review for 1–2 weeks.
  </Card>

  <Card title="High Threshold = Fewer Actions" icon="arrowUp">
    Higher confidence thresholds mean fewer auto-executions but higher quality.
  </Card>
</CardGroup>

### Rate Limiting

Rate limiting prevents your agents from over-communicating with customers. Two settings control this:

#### Cooldown Period (Hours)

The minimum number of hours that must pass before the same agent can act on the **same customer** again.

* **Range:** 1–720 hours (1 hour to 30 days)
* **Default:** Varies by agent (e.g., 48 hours for Due Invoice Reminders, 72 hours for Contract Renewal)

**How it works:** If the Due Invoice Reminders agent sends a reminder to a customer at 10:00 AM on Monday with a 48-hour cooldown, it won't propose another action for that same customer until 10:00 AM on Wednesday — even if new patterns are detected.

**Recommended cooldowns by scenario:**

| Scenario           | Recommended Cooldown    |
| ------------------ | ----------------------- |
| Payment reminders  | 24–48 hours             |
| Contract renewals  | 72–168 hours (3–7 days) |
| Onboarding nudges  | 24 hours                |
| At-risk detection  | 168 hours (1 week)      |
| Support follow-ups | 168 hours (1 week)      |

#### Maximum Actions Per Day

The upper limit on how many actions this agent can propose across **all customers** in a single day.

* **Range:** 1–1,000
* **Default:** Varies by agent (e.g., 20 for Due Invoice Reminders, 10 for Contract Renewal)
* **Leave empty** for unlimited (not recommended for most agents)

**Why set a limit?** Without a cap, a single event (like a payment processing outage) could trigger hundreds of reminder actions at once. A daily limit ensures your communication stays controlled and prevents message fatigue.

**Recommended daily limits:**

| Agent Volume                         | Recommended Max Actions/Day |
| ------------------------------------ | --------------------------- |
| High-volume (payment reminders)      | 20–50                       |
| Medium-volume (renewals, follow-ups) | 10–20                       |
| Low-volume (at-risk, upsell)         | 5–10                        |

***

## Communication Settings

These settings appear only for agents that send **outbound messages** (email, WhatsApp, or voice). Internal-only agents (like FAQ Gap Detection) skip this section entirely.

### Preferred Channel

Override the default communication channel for this agent.

| Option       | When to Use                                                                           |
| ------------ | ------------------------------------------------------------------------------------- |
| **Default**  | Let the agent use its recommended channel (recommended for most cases)                |
| **Email**    | Force all actions to be sent as email, even for agents that support voice or WhatsApp |
| **WhatsApp** | Force all actions to be sent via WhatsApp messages                                    |
| **Voice**    | Force all actions to be sent as AI voice calls                                        |

**When to use WhatsApp:**

* Customers who prefer instant messaging over email
* Mobile-first communication for quick engagement
* Time-sensitive messages that need immediate attention
* Personal, conversational touch for relationship-building
* Requires WhatsApp channel configuration on your location
* Subject to WhatsApp Business API 24-hour messaging window rules

**When to use Voice:**

* High-priority, urgent matters (e.g., tour reminders before an appointment)
* Personal touch for VIP or long-term customers
* After email attempts have not been acknowledged
* Requires voice channel configuration on your location

> **Note:** Not all agents support all channels. The channel badge on each agent card shows its default channel. WhatsApp messages follow Business API rules: free-form messages can only be sent within 24 hours of the customer's last message; otherwise, a pre-approved template is sent to initiate the conversation.

### Available Placeholders

When configuring voice scripts, you'll see a list of **placeholders** specific to this agent. These are dynamic variables that get replaced with actual customer data when the message is sent.

To copy a placeholder, click on it. It will be copied to your clipboard and show a green checkmark briefly.

Common placeholders include:

| Placeholder             | Example Value                                             |
| ----------------------- | --------------------------------------------------------- |
| `{{customer_name}}`     | "John Smith"                                              |
| `{{company_name}}`      | "Acme Workspace"                                          |
| `{{invoice_number}}`    | "INV-2026-0042"                                           |
| `{{invoice_amount}}`    | "€149.00"                                                 |
| `{{contract_end_date}}` | "July 15, 2026"                                           |
| `{{payment_link}}`      | "[https://pay.nexudus.com/](https://pay.nexudus.com/)..." |

> **Tip:** Each agent type has different available placeholders. The list shown in the configuration panel is specific to the agent you're configuring.

### Opening Message

> **Voice only** — This setting applies exclusively to agents that send voice calls. It has no effect on email or other channels.

The first line spoken when the voice call is delivered. This overrides the AI's default greeting.

* **Maximum length:** 500 characters
* **Supports placeholders:** Yes (e.g., `{{company_name}}`, `{{customer_name}}`)

**Example:**

> Hello `{{customer_name}}`, this is a quick call from `{{company_name}}`. I noticed your invoice is a few days overdue — is now a good time to speak?

### System Prompt

> **Voice only** — This setting applies exclusively to agents that send voice calls. It has no effect on email or other channels.

Full AI instructions for generating the voice message content. This gives you fine-grained control over tone, structure, and content.

* **Maximum length:** 2,000 characters
* **Must include:** The `{{voice_message}}` placeholder (required when using OVERRIDE mode)

**Standard usage:** Leave blank to use the agent's default system prompt. The AI already knows the right tone and structure for each agent type.

**Advanced usage — Override mode:**

If you prefix your system prompt with `OVERRIDE:`, it replaces the entire default prompt. This is for advanced users who want complete control.

> **Important:** When using `OVERRIDE:` in a voice agent's system prompt, you **must** include the `{{voice_message}}` placeholder. If you don't, the save will be rejected with an error.

**Example override:**

> OVERRIDE: You are a friendly receptionist at a coworking space. Be warm, conversational, and brief. Never exceed 30 seconds of speaking time. Always end with a question that invites a response. `{{voice_message}}`

### Custom Prompt Instructions

Additional instructions that are **appended** to the agent's default prompt (rather than replacing it). This is the easiest way to customize message behavior across **all agents** — email, WhatsApp, and voice — without risking breaking the agent.

* **Maximum length:** 2,000 characters
* **Applies to:** All outbound agents (email, WhatsApp, and voice)
* **Safe to use:** Yes, for most operators
* **Tip:** Prefix with `OVERRIDE:` to replace the entire prompt instead of appending

**Example:**

> Always address the customer by their first name. Use a friendly but professional tone. Never sound pushy about payments.

**Best practices for custom prompts:**

1. Start with small, specific instructions rather than rewriting the entire prompt
2. Test the result by reviewing approved actions before enabling auto-execute
3. Keep tone consistent with your location's brand voice
4. Avoid conflicting instructions (e.g., "be brief" + "include full invoice details")

***

## Test Configuration

Once your configuration is saved, you can verify how it works in practice.

### Test Voice Call

For agents that support voice calls, you can initiate a test call to hear exactly what your customers will hear.

1. Save your configuration first (unsaved changes prevent testing)
2. Enter your phone number in the **Phone number** field (include country code, e.g., `+44123456789`)
3. Click **Test Voice Call**
4. You'll receive a phone call using your current agent configuration

**What to verify during the test:**

* Voice quality and clarity
* Opening message sounds natural
* Tone matches your location's brand
* The call handles gracefully (you can hang up, respond to questions)
* Placeholders are replaced with real sample data

After the test call, you'll see a success or error message indicating whether the call was initiated successfully.

***

## Saving Your Configuration

Changes are saved by clicking the **Save** button in the bottom bar of the configuration panel. A green confirmation message appears briefly when the save is successful.

> **Important:** If you have unsaved changes and try to initiate a test voice call, you'll be prompted to save first. The test uses your **saved** configuration, not your in-progress changes.

***

## Recommended Configuration Workflow

Follow this workflow when setting up a new agent:

### Phase 1: Enable and Observe (Week 1–2)

1. Toggle the agent **on**
2. Leave **auto-execute disabled**
3. Use **default** cooldown and daily limits
4. Use **default** channel and prompts
5. Review proposed actions in your AI Inbox daily
6. Note patterns: which actions do you approve? Which do you reject or edit?

### Phase 2: Tune (Week 3–4)

1. Adjust **cooldown** if you're seeing too many or too few actions for the same customer
2. Adjust **max actions per day** if your inbox is overwhelmed or underutilized
3. If the agent is sending through the wrong channel, switch it
4. Tweak **custom prompt instructions** to improve tone or add specific details

### Phase 3: Automate (Week 5+)

1. If your approval rate is high (80%+), consider enabling **auto-execute**
2. Set the confidence threshold to **85%** initially
3. Monitor for 1–2 more weeks
4. Adjust the threshold based on the quality of auto-executed actions

***

## Quick Reference: All Settings

| Setting                | Location               | Default        | Range                              | Notes                                                               |
| ---------------------- | ---------------------- | -------------- | ---------------------------------- | ------------------------------------------------------------------- |
| **Enabled**            | Basic Settings         | —              | On/Off                             | Master switch                                                       |
| **Auto-execute**       | Execution & Behavior   | Off            | On/Off                             | Not available for internal-only agents                              |
| **Min. confidence**    | Execution & Behavior   | 80%            | 50%–100%                           | Only visible when auto-execute is on                                |
| **Cooldown hours**     | Execution & Behavior   | Agent-specific | 1–720                              | Per-customer frequency                                              |
| **Max actions/day**    | Execution & Behavior   | Agent-specific | 1–1,000 or unlimited               | Per-agent global limit                                              |
| **Channel preference** | Communication Settings | Default        | Default / Email / WhatsApp / Voice | Not shown for internal-only agents                                  |
| **Opening message**    | Communication Settings | (empty)        | 0–500 chars                        | Voice only — greeting for voice calls                               |
| **System prompt**      | Communication Settings | (empty)        | 0–2,000 chars                      | Voice only — must include `{{voice_message}}` for overrides         |
| **Custom prompt**      | Communication Settings | (empty)        | 0–2,000 chars                      | All agents — appended to default prompt for email, WhatsApp & voice |

***

## What's Next?

* Browse the [Agent Types Reference](/platform/ai/agent-types) for detailed information on each agent's behavior and recommended settings
* Review and manage [suggested actions](/platform/ai/inbox) in the AI Inbox
* View [AI Conversations](/platform/ai/ai-conversations) to see two-way conversations with customers


# How Agents Work Together
Source: https://learn.nexudus.com/platform/ai/how-agents-work-together

Understand how conversational AI and proactive agents collaborate — from detecting opportunities to delivering messages and handling customer replies across email, WhatsApp, and voice channels.

## Overview

Nexudus AI is powered by two complementary systems that work together to deliver a complete communication experience:

<Frame>
  <img alt="How Conversational AI and Proactive Agents work together" />
</Frame>

* **Conversational AI** — responds to customers in real time across chat, email, WhatsApp, and voice.
* **Proactive Agents** — monitor your space for patterns and opportunities, then propose outbound actions for your review.

These two systems are not separate silos. They share the same intelligence, the same tools, and the same conversation history. When a proactive agent sends an email, WhatsApp message, or places a voice call, the customer's reply flows back into a conversational session — creating a seamless loop between proactive outreach and two-way dialogue.

This page explains how these systems connect, how handoffs work, and what the full journey looks like from detection to resolution.

***

## The Two Systems at a Glance

<CardGroup>
  <Card title="Conversational AI" icon="comments">
    **Direction:** Customer initiates\
    **Channels:** Chat, Email, WhatsApp, Voice\
    **Purpose:** Answer questions, make bookings, provide information\
    **Lives in:** Members Portal + email inbox + phone + WhatsApp
  </Card>

  <Card title="Proactive Agents" icon="lightbulb">
    **Direction:** System initiates\
    **Channels:** Email, WhatsApp, Voice\
    **Purpose:** Detect opportunities and propose outreach\
    **Lives in:** Dashboard AI Inbox
  </Card>
</CardGroup>

***

## How They Connect

The diagram below shows the complete flow from pattern detection to customer conversation:

<Frame>
  <img alt="Diagram showing the full lifecycle from proactive agent detection through evaluation, proposal, review, execution, and handoff to conversational AI" />
</Frame>

***

## The Proactive-to-Conversational Journey

Here's what happens, step by step, when a proactive agent identifies an opportunity and the customer responds:

### Step 1: Detection

Proactive agents run automatically in the background, scanning your location's data for patterns you've configured. For example:

* An invoice has been overdue for 5 days
* A contract expires in 30 days and hasn't been renewed
* A lead inquired about workspace last week but never followed up
* A new member hasn't made their first booking yet

Each agent has its own criteria and thresholds that determine when to act. See [Agent Types](/platform/ai/agent-types) for what each agent watches for.

### Step 2: Message Composition

When a pattern is detected, the AI composes a personalized draft message using:

* **Your location's tone and personality** — the same voice used in conversational AI
* **Customer context** — their name, history, activity patterns, and relevant data (like invoice amounts or contract dates)
* **Channel-appropriate formatting** — email messages include subject lines and structured content; WhatsApp and voice scripts are conversational and concise

The draft is tailored to the specific situation — not a generic template. A payment reminder for a member with perfect payment history will read differently from one for a member who frequently pays late.

### Step 3: Your Review

The proposed action appears in your [AI Inbox](/platform/ai/inbox) where you can:

* **Approve** — send the message exactly as drafted
* **Edit & Approve** — personalize the message before sending
* **Reject** — dismiss the action if it's not appropriate right now
* **Snooze** — defer it for later review

If you've enabled [auto-execute](/platform/ai/configuring-agents) for a specific agent, high-confidence actions skip the inbox and send automatically.

### Step 4: Delivery

Once approved, the message is delivered through the configured channel:

<AccordionGroup>
  <Accordion title="Email delivery" icon="envelope">
    The AI sends a personalized email to the customer. The email is formatted as a natural message from your location — not a marketing template. It includes a special reply address so that any response from the customer automatically connects back to the AI conversation.
  </Accordion>

  <Accordion title="WhatsApp delivery" icon="message">
    The AI sends a message via WhatsApp Business API. If the customer has messaged you on WhatsApp within the last 24 hours, the message is delivered immediately. If not, a pre-approved template message is sent first to initiate the conversation — the customer must reply with a keyword (e.g., "YES") to receive the actual message. This follows WhatsApp Business API messaging window rules.
  </Accordion>

  <Accordion title="Voice delivery" icon="phone">
    The AI places an outbound phone call to the customer. The voice agent speaks naturally using your configured voice and language, delivers the message conversationally, and can answer questions during the call. If the customer asks something the voice agent can handle (like making a booking or checking availability), it uses the same tools as the chat assistant — in real time, during the call. Any links or URLs are sent as an SMS rather than being read aloud.
  </Accordion>
</AccordionGroup>

### Step 5: The Conversation Begins

This is where the handoff happens. The moment the customer replies (to an email or WhatsApp message) or speaks back (on a voice call), they're in a **conversational AI session** — the same system that powers the Members Portal chat.

The key difference: this conversation was *initiated* by the proactive agent, not the customer. But from this point on, it behaves exactly like any other AI conversation:

* The AI has access to all the same tools (bookings, plans, resources, FAQ)
* It knows the full context of why the outreach happened
* It can answer follow-up questions, take actions, or escalate to your team
* The entire exchange is logged in [AI Conversations](/platform/ai/inbox) with a link back to the original proposed action

***

## How Replies Are Handled

When a customer responds to a proactive outreach, the reply routes back through the same channel and is handled by the conversational AI:

<Frame>
  <img alt="Diagram showing how customer replies route through the channel router to the conversational AI, which can resolve, take action, or escalate" />
</Frame>

### Email Replies

When a customer replies to an email sent by a proactive agent:

1. The reply arrives at a special address that encodes the conversation session.
2. The system identifies which session the reply belongs to and loads the full context — including why the outreach happened, the original message, and all prior exchanges.
3. The conversational AI processes the reply with that context and composes a response.
4. The response is sent back via email, continuing the thread naturally.

The customer sees a normal email conversation. Behind the scenes, the AI knows this started as a proactive outreach about (for example) an overdue invoice, and can address the customer's response accordingly — whether they're asking for a payment link, disputing the charge, or requesting more time.

### WhatsApp Replies

When a customer replies to a WhatsApp message sent by a proactive agent:

1. If the agent sent a template opt-in message, the customer's keyword reply (e.g., "YES") triggers delivery of the actual message. Further replies are handled as a normal conversation.
2. If the agent sent a direct message (customer had messaged within 24 hours), replies are processed immediately.
3. The system identifies the conversation session and loads the full context — including the original proactive action.
4. The conversational AI processes the reply and responds via WhatsApp, continuing the conversation naturally.
5. The conversation remains active for 24 hours after each customer message, allowing free-form AI responses during that window.

WhatsApp conversations feel instant and conversational, similar to how customers interact with the chat widget, but with the mobile-first convenience of their messaging app.

### Voice Replies

Voice works differently because the conversation happens in real time:

1. The proactive agent places an outbound call and delivers its message.
2. The customer can immediately ask questions or take actions during the same call.
3. The voice AI uses the same tools available in chat — it can check availability, create bookings, provide pricing, or look up information.
4. If the customer needs something the AI can't handle, it offers to connect them with your team (see [Escalation](#escalation-connecting-to-your-team) below).
5. Any links (like payment pages or booking confirmations) are sent via SMS during the call instead of being read aloud.

***

## Escalation: Connecting to Your Team

Both conversational and proactive AI share the same escalation capability. When the AI reaches the limits of what it can handle — whether during a proactive outreach or a regular customer conversation — it seamlessly connects the customer with your team.

### When Escalation Happens

The AI will offer to connect a customer with your team when:

* The customer explicitly asks to speak with a person
* The question falls outside what the AI can answer (not covered in FAQ or its tools)
* The customer is frustrated or the topic is sensitive (billing disputes, complaints)
* The customer needs something that requires human judgment

### What Gets Transferred

When escalation occurs, a support ticket is created in your Help Desk with:

* A summary of the conversation and what the AI tried
* The full exchange history so your team doesn't ask the customer to repeat themselves
* The channel the conversation happened on (email, WhatsApp, voice, or chat)
* The customer's identity and relevant context (invoices, bookings, contract details)

### How Your Reply Gets Back to the Customer

Once a conversation is escalated, the **Help Desk takes over** and all further communication happens via email. This is true regardless of which channel the original conversation was on:

| Original Channel | After Escalation                                  |
| ---------------- | ------------------------------------------------- |
| Email            | Help Desk replies via email (continues naturally) |
| WhatsApp         | Help Desk replies via email (async follow-up)     |
| Voice            | Help Desk replies via email (call has ended)      |
| Chat             | Help Desk replies via email (async follow-up)     |

Escalation is an intentional handoff from real-time AI to your team's asynchronous workflow. The customer receives an email from your Help Desk with the operator's reply — just like any other support ticket.

<Frame>
  <img alt="Diagram showing the escalation flow from AI conversation through ticket creation to Help Desk, with follow-up via email" />
</Frame>

***

## Real-World Examples

### Example 1: Overdue Invoice → Payment

<Steps>
  <Step title="Agent detects pattern">
    The **Due Invoice Reminders** agent notices that a member's invoice has been overdue for 5 days. It composes a friendly payment reminder using their name, the invoice amount, and a payment link.
  </Step>

  <Step title="You review (or auto-execute sends it)">
    The draft appears in your AI Inbox. You glance at it, confirm it looks good, and click **Approve**.
  </Step>

  <Step title="Email is delivered">
    The member receives a personalized email: *"Hi Sarah, just a quick note that your June invoice for £450 is still outstanding. You can pay it here: \[link]. Let me know if you have any questions!"*
  </Step>

  <Step title="Customer replies">
    Sarah replies: *"Oh sorry, I forgot! Can you remind me what this covers?"*
  </Step>

  <Step title="Conversational AI responds">
    The AI — knowing this is about the invoice — pulls up the invoice details and responds with a breakdown of the charges, along with the payment link again.
  </Step>

  <Step title="Issue resolved">
    Sarah clicks the link and pays. The conversation is marked as resolved, and you can see the full journey from the original proposed action through to payment.
  </Step>
</Steps>

### Example 2: Lead Follow-up → Booking

<Steps>
  <Step title="Agent detects pattern">
    The **Lead Follow-up** agent notices that someone inquired about desk availability via the chat widget a week ago but never signed up or booked a tour.
  </Step>

  <Step title="You review">
    The draft in your inbox reads: *"Hi Marcus, you asked about hot desks last week. We still have availability — would you like to book a tour or try a day pass?"*
  </Step>

  <Step title="Email is delivered">
    Marcus receives the follow-up email.
  </Step>

  <Step title="Customer replies">
    Marcus replies: *"Yes, I'd love to try a day pass for next Tuesday."*
  </Step>

  <Step title="Conversational AI takes action">
    The AI checks availability for next Tuesday, confirms there's space, and sends Marcus a day pass booking link with all the details (time, location, WiFi instructions).
  </Step>

  <Step title="Lead converts">
    Marcus visits on Tuesday. The original lead inquiry, the proactive follow-up, and the booking are all linked — giving you visibility into the full conversion journey.
  </Step>
</Steps>

### Example 3: Contract Renewal → Voice Call → Escalation

<Steps>
  <Step title="Agent detects pattern">
    The **Contract Renewal** agent notices that a long-time member's contract expires in 14 days and they haven't renewed.
  </Step>

  <Step title="You approve a voice outreach">
    The proposed action is configured for **Voice** channel. You approve the AI to call the member.
  </Step>

  <Step title="AI places the call">
    The AI calls the member and says: *"Hi David, this is a quick call from \[Your Space]. I wanted to check in — your membership renews in two weeks and I wanted to see if everything's working well for you."*
  </Step>

  <Step title="Customer asks a complex question">
    David says: *"Actually, I've been thinking about switching to a private office. What options do you have?"*
  </Step>

  <Step title="AI provides information">
    The AI uses its tools to look up available private offices, pricing, and availability. It tells David what's available and sends an SMS with a link to view the options online.
  </Step>

  <Step title="Customer wants to negotiate">
    David says: *"Those prices are higher than I expected. Can we work something out?"*
  </Step>

  <Step title="AI escalates gracefully">
    The AI recognizes this is a negotiation — something that requires human judgment — and offers to connect David with your team. It creates a Help Desk ticket with the full context: David's tenure, current plan, the offices he's interested in, and the pricing concern.
  </Step>

  <Step title="You follow up via email">
    You see the ticket in your Help Desk with the complete conversation transcript. You reply via the Help Desk with a personal email containing a custom offer — already knowing exactly what David wants without needing to ask again.
  </Step>
</Steps>

***

## What Makes This Different from Automation Rules

You might wonder how proactive agents differ from traditional automation (like automated email sequences or reminder rules). Here are the key differences:

| Aspect           | Traditional Automation                      | Proactive AI Agents                                                              |
| ---------------- | ------------------------------------------- | -------------------------------------------------------------------------------- |
| **Messages**     | Fixed templates with merge fields           | AI-composed, personalized to each situation                                      |
| **Timing**       | Rule-based schedules                        | Intelligent — considers context, history, and confidence                         |
| **Responses**    | One-way (no reply handling)                 | Two-way — replies start real conversations                                       |
| **Adaptability** | Same message every time                     | Adapts tone based on customer history and relationship                           |
| **Escalation**   | None — customer must contact you separately | Built in — AI can hand off mid-conversation                                      |
| **Intelligence** | None — fires based on date/status only      | AI evaluates patterns, calculates confidence, and proposes only when appropriate |
| **Control**      | Set and forget (or set and worry)           | Human-in-the-loop — you review before sending                                    |

***

## Shared Capabilities

Both conversational and proactive AI share the same underlying capabilities:

### Tools

The AI can take actions on behalf of your customers during conversations — whether those conversations started from the Members Portal chat, a proactive email, WhatsApp message, or a voice call:

* Check resource availability and create bookings
* Look up plan and pricing information
* Search your FAQ and knowledge base
* Provide location details and operating hours
* Generate portal links for payments, bookings, and profiles
* Create day pass purchases

### Knowledge Base

Both systems draw from the same knowledge sources:

* Your published FAQ articles
* Location details and operating information
* Plan and pricing configurations
* Resource availability data

### Business Persona

Whether a customer chats in the portal or receives a proactive email, the AI uses the same tone, personality, and communication style configured for your location. This ensures a consistent experience regardless of which system initiated the conversation.

***

## Privacy and Control

<Warning>
  Proactive agents never send messages without your explicit configuration and (optionally) your approval. The system is designed with a human-in-the-loop by default.
</Warning>

### Key safeguards

* **Opt-out respected** — Customers who have opted out of communications are excluded from all proactive outreach.
* **Rate limiting** — Each agent has a configurable cooldown period and daily maximum. The same customer won't receive multiple messages in rapid succession.
* **Deduplication** — If an agent has already proposed an action for a specific situation (e.g., this specific overdue invoice), it won't propose it again.
* **Expiry** — Proposed actions expire if not reviewed within a configurable window, preventing stale outreach.
* **Auto-execute is opt-in** — Every agent starts in manual review mode. You choose which agents (if any) to promote to automatic sending.
* **Business hours** — Actions configured with business hours enforcement will only be delivered during your operating hours.

***

## Getting Started

<CardGroup>
  <Card title="Configure your agents" icon="gear" href="/platform/ai/configuring-agents">
    Enable the agents that match your workflow and set their thresholds.
  </Card>

  <Card title="Review the AI Inbox" icon="inbox" href="/platform/ai/inbox">
    Learn how to process proposed actions efficiently.
  </Card>

  <Card title="Set up Email channel" icon="envelope" href="/member-portal/ai/setup-email">
    Required for email-based proactive outreach.
  </Card>

  <Card title="Set up Voice channel" icon="phone" href="/member-portal/ai/setup-voice">
    Required for voice-based proactive outreach.
  </Card>
</CardGroup>


# AI Inbox
Source: https://learn.nexudus.com/platform/ai/inbox

Review, edit, approve, and manage all AI-proposed actions from your proactive agents in one central workspace.

## What is the AI Inbox?

The AI Inbox is your central workspace for reviewing all proposed actions from proactive agents. Think of it as a smart drafts folder where the AI prepares messages for you to review and approve before anything reaches your customers.

**Key difference from AI Conversations:**

* **AI Inbox** — Outbound messages *proposed* by agents for you to review (you → customer).
* **AI Conversations** — Inbound conversations your customers have with the AI assistant (customer ↔ AI).

The inbox gives you full control over every message: you can approve as-is, edit for personalization, reject with feedback, or snooze for later. Over time, you can enable auto-execute for agents you trust so high-confidence actions send automatically without manual review.

<Frame>
  <img alt="AI Inbox list view with metrics bar and action items" />
</Frame>

## How to Access

1. In the Dashboard navigation, go to **Operations** → **AI Assistant** → **AI Inbox**.
2. Or use the [direct link](https://dashboard.nexudus.com/operations/inbox).

**Permissions:** You need the **proposedAction** role (typically included in Administrator or custom roles with AI access).

## Understanding the Inbox Interface

### Metrics Bar

At the top of the inbox you'll see five key metrics at a glance:

| Metric               | What it shows                                                                   |
| -------------------- | ------------------------------------------------------------------------------- |
| **Pending review**   | Number of actions awaiting your review. Updated in real-time.                   |
| **Approved today**   | Actions you approved in the last 24 hours — shows your outreach volume.         |
| **Rejected today**   | Actions dismissed today — helps identify agents that may need tuning.           |
| **Avg. review time** | Mean time from action creation to your first review (tracked over 7 days).      |
| **Approval rate**    | Percentage of reviewed actions that you approved (approved vs. total reviewed). |

These metrics update automatically as you process actions. Click any metric tile to filter the list to matching items.

### Action List

The main list shows one row per proposed action. Each row displays:

| Column            | What it shows                                                                            | Example                            |
| ----------------- | ---------------------------------------------------------------------------------------- | ---------------------------------- |
| **Subject**       | The proposed subject line (email) or opening line (WhatsApp/voice), truncated for space. | "Payment reminder: Invoice #1234…" |
| **Customer**      | Customer full name, company, and type.                                                   | "John Smith • Acme Corp • Member"  |
| **Criteria type** | Which agent created this action.                                                         | "Due Invoice Reminders"            |
| **Action type**   | The kind of action — Draft Message, Voice Outreach, Internal Note, or Task Reminder.     | Draft Message                      |
| **Channel**       | Email, WhatsApp, or Voice.                                                               | ✉️ Email                           |
| **Confidence**    | The AI's confidence score (0–100%).                                                      | 87%                                |
| **Priority**      | Urgency level: Low, Medium, High, or Critical.                                           | 🔴 High                            |
| **Status**        | Current state of the action.                                                             | Pending                            |
| **Created**       | When the action was proposed.                                                            | 2 hours ago                        |
| **Expires**       | When this action will expire if not reviewed.                                            | 3 days remaining                   |

#### Status Badges

| Status           | Meaning                                                                    |
| ---------------- | -------------------------------------------------------------------------- |
| **Pending**      | Awaiting your review. This is the default view.                            |
| **Approved**     | You reviewed and sent the action.                                          |
| **Rejected**     | You dismissed the action, optionally with a reason.                        |
| **Snoozed**      | Deferred for later — will return to pending after the snooze period.       |
| **Deferred**     | Held until a specific time (e.g., outside business hours).                 |
| **Expired**      | The time window to act on this has passed.                                 |
| **AutoExecuted** | Sent automatically without manual review (agent has auto-execute enabled). |

### Filtering and Segments

Quick filter tabs at the top let you jump between predefined segments:

| Segment          | What it shows                                                   |
| ---------------- | --------------------------------------------------------------- |
| **Pending**      | Default view — actions awaiting your review.                    |
| **Approved**     | History of actions you've sent.                                 |
| **Rejected**     | Dismissed actions — useful for analyzing patterns.              |
| **Snoozed**      | Deferred actions that will return to pending.                   |
| **Expired**      | Actions whose time window has passed.                           |
| **AutoExecuted** | Actions sent automatically by agents with auto-execute enabled. |

You can refine the view further with custom filters:

* **Criteria type** — Show only actions from a specific agent.
* **Customer** — Search by customer name or company.
* **Confidence** — Filter by score range.
* **Priority** — Show only High or Critical actions.
* **Channel** — Email, WhatsApp, or Voice.
* **Date range** — Filter by created or expiry date.

The search bar searches across subject lines, message body content, and customer names in real time.

### Sorting

Click any column header to sort ascending or descending. The default sort is **Created** (newest first).

### Empty States

When the inbox is clear, you'll see one of two helpful messages:

* **"No pending actions"** — All caught up! No actions need review right now. The page invites you to [configure AI agents](/platform/ai/configuring-agents) to generate more activity.
* **"No results found"** — No actions match your current filters. Try adjusting or clearing your filters.

## Taking Action on Proposed Items

Click any row in the inbox to open the action detail panel. The panel is split into two sections: **Context & History** on the left, and the **Message Draft** on the right.

### Left Panel — Context & History

This section helps you understand *why* the action was proposed:

* **Customer information** — Full name, profile photo, company, customer type (Member, Contact, or Lead), active plan, and a link to the full customer profile.
* **Why this was proposed** — The agent name, the trigger criteria (e.g., "Invoice #1234 is 5 days overdue. Customer has good payment history but missed this payment."), and supporting data like amounts and dates.
* **Customer history** — Recent activity (check-ins, bookings, last visit), communication history, payment history, support tickets, and any previous proactive actions sent to this customer.
* **Confidence score** — The overall percentage plus factors that contributed to the score (e.g., strong payment history, clear trigger, high engagement).

### Right Panel — Message Draft

#### For Email Actions (Draft Message)

Shows:

* **To:** Customer email address
* **From:** Your location's default sending address
* **Subject:** Proposed subject line (editable)
* **Body:** Full message content with formatting (editable)
* **Variables:** Placeholders replaced with actual customer data
* **Signature:** Your default email signature

#### For Voice Actions (Voice Outreach)

Shows:

* **To:** Customer phone number
* **Script:** What the AI will say in the call (editable)
* **Tone:** Friendly, professional, or urgent (based on context)
* **Duration:** Estimated call length

#### Preview Mode

Click **Preview** to see exactly what the customer will receive — all variables are filled in with real data and formatting is preserved.

## Four Ways to Respond

Every proposed action gives you four options:

### ✅ Approve & Send

Use when the message is accurate, the tone matches your brand, and no changes are needed.

1. Review the message and customer context.
2. Click **Approve & Send**.
3. Confirm in the modal.

The action is sent immediately. The customer receives the email, WhatsApp message, or voice call, and the action status changes to **Approved**. Any reply from the customer starts a two-way conversation in [AI Conversations](/platform/ai/ai-conversations).

### ✏️ Edit & Approve

Use when the message is good but needs minor tweaks or a personal touch.

1. Click **Edit** on the message draft.
2. Modify the subject line and body using the rich text editor:
   * Add or remove content
   * Apply bold, italic, bullets, or links
   * Insert variables from the sidebar
3. Preview your changes.
4. Click **Save & Send** and confirm.

**Tip:** Variables (like `{{customer_name}}`, `{{invoice_number}}`) are shown in the right sidebar. Click one to insert it at your cursor position. Variables are auto-replaced with real values when the action is sent.

### ❌ Reject

Use when the action isn't appropriate — the issue is already resolved, the timing is wrong, or you'd prefer to handle it personally.

1. Click **Reject**.
2. Select a rejection reason from the dropdown (this helps train the system):
   * Already resolved
   * Poor timing
   * Incorrect information
   * Not appropriate
   * Prefer manual handling
   * Other (custom note)
3. Optionally add internal notes.
4. Click **Reject**.

The action is dismissed and removed from the pending queue. Rejections are logged for analytics and help improve future proposals.

**When to adjust an agent:** If you're rejecting many actions from the same agent, consider [adjusting its configuration](/platform/ai/configuring-agents) — for example, increasing the cooldown period or raising the confidence threshold.

### ⏰ Snooze

Use when you're not ready to decide right now but want the action to come back automatically.

1. Click **Snooze**.
2. Select a duration:
   * 1 hour
   * 4 hours
   * 1 day
   * 3 days
   * Custom date and time
3. Optionally add a reminder note.
4. Click **Snooze**.

The action moves to the **Snoozed** segment and returns to pending after the selected period. You'll see it again in your inbox when the snooze expires.

## Bulk Operations

Select multiple actions using the checkboxes on the left of each row. A bulk action bar appears at the bottom with:

* **Bulk Approve** — Send all selected actions at once. Use cautiously and only for low-risk, similar actions (e.g., payment reminders).
* **Bulk Reject** — Dismiss all selected actions.
* **Bulk Snooze** — Defer all selected actions to the same time.

**Best practice:** Always review actions individually before bulk approving. Bulk operations are convenient but skip the detailed context review.

## Introduction Screen

When you first open the AI Inbox, you'll see an introduction screen that explains the workflow:

> Your AI assistant continuously monitors your space and identifies opportunities to engage with customers — from payment reminders to lead follow-ups. Each proposed action appears here for your review and approval before anything is sent. You can edit messages, approve them as-is, or dismiss them. Over time, you can enable auto-execute for specific action types you trust.

Dismiss this screen to access the inbox list. You can always return to it by refreshing the page.

## Action History

To review past actions:

1. Switch to the **Approved** or **Rejected** segment.
2. Click any action to see:
   * What was sent (or the rejection reason)
   * When it was sent or rejected
   * The outcome (if tracked — e.g., payment made, conversation started)
   * Any customer response linked to the action

This history helps you measure the effectiveness of your proactive agents over time and identify which agents deliver the best results.

## Related Pages

* [Proactive Agents](/platform/ai/proactive-agents) — How agents work and how to access the configuration page.
* [Configuring Agents](/platform/ai/configuring-agents) — Step-by-step guide to enabling and customizing individual agents.
* [Agent Types Reference](/platform/ai/agent-types) — Detailed reference for all available agents.
* [AI Conversations](/platform/ai/ai-conversations) — Two-way conversations with customers, including replies to approved actions.


# Operator Takeover
Source: https://learn.nexudus.com/platform/ai/operator-takeover

Take control of proposed AI actions by choosing different delivery channels — send via AI assisted email, WhatsApp, voice, Email Messages, or help desk while maintaining conversation continuity.

## What is Operator Takeover?

Operator Takeover lets you change how a proposed AI action is delivered to the customer. When you review an action in the [AI Inbox](/platform/ai/inbox), you're not limited to the AI's suggested channel — you can choose:

* **Email (AI assisted)** — The AI-composed email sent through the AI email system
* **Voice** — AI-powered phone call using text-to-speech
* **Email** — Email sent through your connected email account or business default SMTP
* **Help Desk** — Creates a trackable support ticket and sends the customer a help desk notification

All messages — regardless of channel — are logged in the conversation timeline in [AI Conversations](/platform/ai/ai-conversations), so you can see the full case history in one place.

<Frame>
  <img alt="Operator takeover interface showing channel selection in AI Inbox" />
</Frame>

## When to Use Each Channel

| Channel               | Best For                                                                                                      | Reply Tracking                       |
| --------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| **AI assisted Email** | AI-composed outbound where no operator involvement is needed                                                  | ✅ Automatic                          |
| **Voice**             | Urgent matters requiring immediate attention via phone call                                                   | ✅ Automatic                          |
| **Email Message**     | When you want to send from a specific sender identity (billing@, support@) or track replies in your own inbox | ⚠️ Only with connected email account |
| **Help Desk**         | Issues requiring formal tracking, team assignment, or escalation to support                                   | ✅ Automatic                          |

## How to Change the Delivery Channel

### Step 1: Open a Proposed Action

1. Go to **Operations** → **AI Assistant** → **AI Inbox**
2. Click on any pending proposed action to open the detail panel
3. Review the customer context and the AI-drafted message

### Step 2: Select a Channel

In the **Delivery channel** section:

1. Click the **Channel** dropdown
2. Select one of the available options:
   * **AI assisted Email**
   * **Voice**
   * **Email message**
   * **Help desk**

The form updates to show channel-specific options.

### Step 3: Configure Channel Options

#### For Voice Channel

**What you'll see:**

* ⚠️ **Business hours warning** (if enabled): "Voice messages are only sent during business hours. This action will be automatically deferred until the next available business hours window."
* 🚫 **Invalid phone number error**: "The customer does not have a mobile phone number" or "The customer's phone number is not in a valid international format."
* 🚫 **Voice not enabled error**: "The Voice AI agent is not enabled for this location."

**Requirements:**

* Customer must have a valid mobile phone number in international format (`+XX...`)
* Voice channel must be [enabled in Settings](/member-portal/ai/setup-voice)
* If business hours enforcement is enabled, the call will be deferred to the next business hours window

#### For Email Message Channel

**What you'll see:**

* **Send from email account** dropdown
* First option: "Location default (no reply tracking)"
* Other options: Your connected email accounts (e.g., [billing@yourspace.com](mailto:billing@yourspace.com), [support@yourspace.com](mailto:support@yourspace.com))

**Reply tracking warning:**
If you select "Location default," you'll see a warning:

> "Replies cannot be automatically tracked without a connected email account. Customer replies will land in your normal inbox and will not appear in the AI conversation timeline."

**How reply tracking works:**
When you send via a connected email account:

1. The message includes a unique identifier in the email headers
2. When the customer replies, their email client includes this in the `In-Reply-To` header (standard email threading)
3. Nexudus syncs the reply from your connected inbox and matches it via the identifier
4. The reply appears in the [AI Conversations](/platform/ai/ai-conversations) timeline with a "Replied via email" indicator

**To set up connected email accounts:**

1. Go to **CRM** → **Email Accounts**
2. Click **Add email account**
3. Choose your provider (Google Workspace, Office 365, or IMAP)
4. Authenticate and grant access
5. The account will appear in the "Send from" dropdown

#### For Help Desk Channel

**What you'll see:**

* **Department** dropdown (optional) — Assign to a specific support department
* **Priority** dropdown — Low, Normal, High, or Critical
* **Internal notes** text area (optional) — Notes visible only to admins, not the customer

**What happens when you escalate:**

1. A new help desk message is created
2. The customer receives your standard help desk notification email
3. The ticket is linked to the AI conversation
4. All future help desk comments are logged in the conversation timeline

### Step 4: Edit the Message (Optional)

You can edit the subject line and message body before sending:

* **Subject field** — Edit the subject line (editable for pending/snoozed actions)
* **Message body** — Full rich text editor with HTML formatting
* Variables like `{{customer_name}}` and `{{invoice_number}}` are automatically replaced

### Step 5: Approve and Send

1. Review your channel selection and message
2. Optionally add **review notes** (internal notes for your team, not sent to customer)
3. Click **Approve and send message**
4. Confirm in the modal that appears

**What happens next:**

* The message is sent immediately via the selected channel (or deferred if using Voice during non-business hours)
* The action status changes to **Approved**
* The message is logged in the [AI Conversations](/platform/ai/ai-conversations) timeline with the appropriate channel indicator
* Customer replies are automatically captured back into the conversation (depending on channel)

## Reply Routing by Channel

| Channel                                       | How Replies Are Captured                                                                                            |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Email (AI)**                                | Customer replies to the AI email address. Reply is automatically logged in conversation timeline.                   |
| **Voice**                                     | Customer can reply during the call or hang up. Call transcript is logged in timeline.                               |
| **Email Message (with connected account)**    | Reply arrives in your connected email inbox. Nexudus syncs it via RFC Message-ID threading and logs it in timeline. |
| **Email Message (without connected account)** | Reply arrives in your business default inbox. NOT automatically logged in timeline.                                 |
| **Help Desk**                                 | Customer replies via help desk system. All comments are logged in timeline.                                         |

## Viewing the Conversation Timeline

After sending via any channel, you can view the full conversation:

1. Go to **Operations** → **AI Assistant** → **AI Conversations**
2. Find the conversation (search by customer name or subject)
3. Open the conversation to see the timeline with all messages

Each message shows:

* **Sender avatar** — AI, operator, or customer
* **Channel indicator** — Email icon, Help Desk icon, etc.
* **Message content** — Full text with formatting
* **Link to source** — Click to view the Email Message or Help-desk detail

## Use Cases

### Use Case 1: Sending from a Department Email

**Scenario:** The AI proposes a payment reminder. You want it to come from [billing@yourspace.com](mailto:billing@yourspace.com) instead of the AI email address.

**Flow:**

1. Open the proposed action in the AI Inbox
2. Change **Channel** to **Email Message**
3. Select **[billing@yourspace.com](mailto:billing@yourspace.com)** from the "Send from" dropdown
4. Edit the message if needed
5. Click **Approve and send**
6. Customer receives the email from [billing@yourspace.com](mailto:billing@yourspace.com)
7. When they reply, the response appears in your billing@ inbox AND the AI conversation timeline

### Use Case 2: Escalating a Technical Issue

**Scenario:** The AI detects a member hasn't checked in for two weeks and proposes a re-engagement email. You realize this might be a technical access issue that needs support team attention.

**Flow:**

1. Open the proposed action in the AI Inbox
2. Change **Channel** to **Help desk**
3. Select **Facilities** from the Department dropdown
4. Set Priority to **High**
5. Edit the message: "We noticed you haven't been in lately. Is there an issue with your access card?"
6. Add internal notes: "Potential door access issue"
7. Click **Approve and send**
8. A help desk ticket is created and assigned to Facilities
9. Customer receives the help desk notification
10. Support team sees the ticket with full AI conversation context

### Use Case 3: Urgent Voice Follow-Up

**Scenario:** A high-value customer has an overdue invoice. The AI proposes an email, but you want to call them directly.

**Flow:**

1. Open the proposed action in the AI Inbox
2. Change **Channel** to **Voice**
3. Review the warning: "This will be deferred until business hours" (if outside hours)
4. Verify the customer has a valid mobile number
5. Edit the voice script if needed
6. Click **Approve and send**
7. The AI places a voice call to the customer during business hours
8. Call transcript is logged in the conversation timeline

## Troubleshooting

### Cannot Send via Voice

**Symptoms:**

* "Voice channel not enabled" error message
* "Invalid or missing phone number" error

**Solutions:**

* ✅ [Enable Voice in Settings](/member-portal/ai/setup-voice)
* ✅ Verify customer has a mobile phone number
* ✅ Ensure phone number is in international format (+XX...)
* ✅ Edit the customer record to add or fix the phone number

### Replies Not Appearing in Timeline (Email Message)

**Symptoms:**

* Customer replies but they don't show up in AI Conversations

**Causes:**

* You selected "Location default (no reply tracking)" instead of a connected email account
* The email account is disconnected or not syncing

**Solutions:**

* ✅ Use a connected email account instead of "Location default"
* ✅ Check **CRM** → **Email Accounts** to verify the account is connected and syncing
* ✅ Ensure the customer used "Reply" (not "Forward" or new email)

### Email Account Not Listed

**Symptoms:**

* Your email account doesn't appear in the "Send from" dropdown

**Solutions:**

* ✅ Connect the email account in **CRM** → **Email Accounts**
* ✅ Verify your user role has the `emailAccount` permission
* ✅ Confirm the email account belongs to the same location as the customer

## Best Practices

* **Use connected email accounts for Email Message** — Always select a connected account to enable reply tracking
* **Match channel to urgency** — Use Voice for urgent matters, Help Desk for complex issues, Email message for personal touch
* **Edit messages thoughtfully** — The AI's draft is a good starting point, but personalize for sensitive situations
* **Add internal notes** — Use review notes or help desk internal notes to document why you chose a specific channel
* **Monitor conversation timelines** — Check [AI Conversations](/platform/ai/ai-conversations) to see how customers respond to different channels

## Related Documentation

<CardGroup>
  <Card title="AI Conversations" icon="comments" href="/platform/ai/ai-conversations">
    View all AI conversations with full timelines
  </Card>

  <Card title="AI Inbox" icon="inbox" href="/platform/ai/inbox">
    Review and approve proposed actions from proactive agents
  </Card>

  <Card title="Email Accounts" icon="envelope" href="/platform/crm/email-accounts">
    Configure connected email accounts for reply tracking
  </Card>

  <Card title="Help Desk" icon="life-ring" href="/platform/operations/help-desk">
    Using the help desk system for support tickets
  </Card>
</CardGroup>


# AI Agents
Source: https://learn.nexudus.com/platform/ai/overview

An overview of AI capabilities in the Nexudus Dashboard — from conversational AI in the Members Portal to proactive agents that help you run your space smarter.

## Overview

<Warning>
  AI Agents is currently in **beta**. OpenAI is the current subprocessor for AI models. Access is free of charge during the Beta phase, but pricing may change in the future.
</Warning>

Nexudus includes two distinct AI-powered features that work together to improve both your members' experience and your operational efficiency:

* **Conversational AI** — A customer-facing AI assistant available in the [Members Portal](/member-portal/ai/overview) that answers questions about plans, bookings, events, and your space.
* **Proactive AI Agents** — An operator-facing intelligence layer in the Dashboard that monitors patterns in your space and automatically proposes actions for your review.

This section covers the **Proactive AI Agents** feature — the system that watches your bookings, invoices, contracts, support tickets, and member engagement, then suggests when and how to reach out.

<Frame>
  <img alt="AI Inbox showing proposed actions" />
</Frame>

## What Proactive AI Agents Do

Proactive AI Agents are automated monitoring rules that watch for specific situations in your coworking space — like an overdue invoice, a contract approaching expiry, or a member who hasn't checked in for two weeks — and then propose the right action at the right time.

Each agent works through the same four-step cycle:

1. **Monitor** — The agent continuously watches for patterns defined in its criteria (e.g., invoices past due date, contracts within 30 days of expiry).
2. **Evaluate** — When a pattern is detected, the agent calculates a confidence score based on how strongly the situation matches the criteria.
3. **Propose** — A proposed action appears in your **AI Inbox** with a suggested message or note. You review it and decide whether to approve, edit, or reject.
4. **Execute** — Once approved, the action is sent through the configured channel (email, WhatsApp, voice call, or internal note). If auto-execute is enabled, high-confidence actions are sent automatically. When the action is an email, WhatsApp, or voice message, the customer can reply or respond — starting a two-way conversation that appears in [AI Conversations](/platform/ai/ai-conversations).

<CardGroup>
  <Card title="Proactive Agents" icon="lightbulb" href="/platform/ai/proactive-agents">
    How proactive agents work and access the configuration interface.
  </Card>

  <Card title="Agent Types" icon="list" href="/platform/ai/agent-types">
    Detailed reference for all available agents and their settings.
  </Card>

  <Card title="Configure Agents" icon="sliders" href="/platform/ai/configuring-agents">
    Step-by-step guide to enabling and customizing agents.
  </Card>

  <Card title="AI Inbox" icon="inbox" href="https://dashboard.nexudus.com/operations/inbox">
    Review and approve proposed actions before sending.
  </Card>
</CardGroup>

## Agent Categories

Agents are organized into categories that reflect the area of your business they monitor:

| Category       | What It Watches                   | Example Agent                               |
| -------------- | --------------------------------- | ------------------------------------------- |
| **Billing**    | Invoices, contracts, payments     | Due Invoice Reminders, Contract Renewal     |
| **Sales**      | Leads, tours, inquiries           | Lead Follow-up, Tour Reminders              |
| **Engagement** | Member activity and onboarding    | Onboarding Nudges, Booking No-Show          |
| **Retention**  | Declining usage and churn signals | At-Risk Member Detection, Cancellation Risk |
| **Support**    | Help desk tickets and patterns    | Support Pattern Detection                   |
| **Revenue**    | Upsell and upgrade opportunities  | Upsell Opportunities                        |
| **Knowledge**  | FAQ gaps and content suggestions  | FAQ Gap Detection                           |

Some agents are available now; others are marked as coming soon. The full list is on the [Proactive Agents](/platform/ai/proactive-agents) page.

## How It All Connects

The proactive agents system sits alongside the conversational AI assistant, and the two are connected bidirectionally:

* **Conversational AI** handles real-time customer questions in the Members Portal.
* **Proactive Agents** use the same conversation data (along with booking, invoice, and contract data) to detect patterns like unanswered questions or dormant leads.
* When a proactive agent identifies an opportunity, it proposes an action through the [AI Inbox](/platform/ai/inbox) for your review.
* Once an email, WhatsApp, or voice action is sent, the customer can reply — starting a two-way conversation that appears in [AI Conversations](/platform/ai/ai-conversations).
* Replies from customers are handled by the same conversational AI, and the conversation stays linked to the original proposed action so you can see the full context.

<Warning>
  **Email, WhatsApp, and Voice channels require prior configuration.** Proactive agents can send actions via Email, WhatsApp, or Voice only if those channels are already set up in your space:

  * **Email** — requires the [email channel](/member-portal/ai/setup-email) to be enabled and email forwarding configured.
  * **WhatsApp** — requires the [WhatsApp channel](/member-portal/ai/setup-whatsapp) to be enabled with Twilio credentials and WhatsApp Business API configured.
  * **Voice** — requires the [voice channel](/member-portal/ai/setup-voice) to be enabled with ElevenLabs and Twilio credentials configured.

  If a channel is not configured, actions will only be delivered as **Internal notes** within the Dashboard. Chat is the only channel that works immediately — no additional setup required.
</Warning>

For more on the conversational AI, see the [Members Portal AI documentation](/member-portal/ai/overview).

## Key Concepts

| Term                    | Meaning                                                                                                                                                                                                            |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Agent**               | A monitoring rule that watches for specific patterns in your space data. Each agent focuses on one type of situation (e.g., overdue invoices).                                                                     |
| **Criteria**            | The conditions that trigger an agent. For example, "invoice is 7+ days overdue" is the criteria for the Due Invoice Reminders agent.                                                                               |
| **Confidence Score**    | A percentage (0–100%) that represents how strongly the detected situation matches the agent's criteria. Higher scores mean the AI is more certain the action is appropriate.                                       |
| **Proposed Action**     | An item in your AI Inbox created by an agent. It includes a suggested message, the customer it targets, and the channel to use.                                                                                    |
| **Auto-Execute**        | When enabled, actions meeting the minimum confidence threshold are sent automatically without manual review.                                                                                                       |
| **Cooldown**            | A time period (in hours) that prevents the same agent from acting on the same customer repeatedly. For example, a 48-hour cooldown means the agent won't propose another action for that customer within 48 hours. |
| **Channel**             | The communication method used to deliver the action — Email, WhatsApp, Voice, or Internal note.                                                                                                                    |
| **Max Actions Per Day** | The upper limit on how many actions an agent can propose across all customers in a single day.                                                                                                                     |
| **AI Conversations**    | Two-way conversations that start when a customer replies to an email, WhatsApp, or voice action from a proactive agent. [View AI Conversations](/platform/ai/ai-conversations).                                    |
| **AI Inbox**            | The central place to review, approve, edit, or reject proposed actions before they're sent. [View AI Inbox](/platform/ai/inbox).                                                                                   |

<CardGroup>
  <Card title="Proactive Agents" icon="bracketsAngle" href="/platform/ai/proactive-agents">
    Learn about all available agents and how to access the configuration page.
  </Card>

  <Card title="AI Inbox" icon="inbox" href="/platform/ai/inbox">
    Understand how to review, approve, and manage proposed actions.
  </Card>

  <Card title="Configure Agents" icon="gear" href="/platform/ai/configuring-agents">
    Step-by-step guide to enabling agents and customizing their behavior.
  </Card>
</CardGroup>


# Proactive Agents
Source: https://learn.nexudus.com/platform/ai/proactive-agents

Learn about all available proactive AI agents, how to access the configuration page, and understand what each agent monitors.

## Overview

Proactive AI Agents are automated monitoring rules that watch for specific patterns in your coworking space — like an overdue invoice, a contract approaching expiry, or a member who hasn't checked in for two weeks — and then propose the right action at the right time.

The **AI Agents Configuration** page is where you enable, disable, and customize each agent. You can access it by navigating to **Operations > AI Agents** in the Dashboard, or by clicking **Configure Agents** from the AI Inbox page.

<Frame>
  <img alt="AI Agents configuration grid showing all available agents" />
</Frame>

**Route:** [Configure Agents](https://dashboard.nexudus.com/operations/configureAgents)

***

## How to Access

1. Log in to your [Dashboard](https://dashboard.nexudus.com).
2. Navigate to **Operations** in the left sidebar
3. Click **AI Agents** under the **AI Inbox** section
   * Alternatively, go to **AI Inbox**, then click **Configure Agents** in the right sidebar

**Required permissions:** You need Administrator access or a role with **AI Agent configuration** permissions. The feature requires the AI Assistant module to be enabled for your location.

***

## The Configuration Interface

The AI Agents page displays all available agents as cards in a grid layout. Each card shows:

* **Agent icon** — Represents the agent's category (e.g., currency for billing, refresh for contracts)
* **Agent name** — The display name of the agent
* **Description** — A brief explanation of what the agent monitors
* **Status badge** — Shows **Active** (green) when enabled, **Inactive** (grey) when disabled
* **Auto badge** — Appears in yellow when auto-execute is enabled for that agent
* **Category badge** — Shows the agent's category (Billing, Sales, Engagement, etc.)
* **Toggle switch** — Enable or disable the agent with a single click
* **Channel badge** — Shows the configured communication channel (Email, WhatsApp, Voice, or Default)
* **Cooldown badge** — Displays the cooldown period in hours
* **Max actions badge** — Shows the maximum number of actions allowed per day

At the top of the page:

* **Search bar** — Filter agents by name, category, or description
* **Active agent counter** — Shows how many agents are currently enabled
* **Agent definitions** — Agents are loaded from the frontend registry (`agentDefinitions.ts`) and map 1:1 to backend criteria evaluators

<CardGroup>
  <Card title="Agent Card" icon="creditCard" href="#the-configuration-interface">
    Understand what each agent card displays and how to read the badges.
  </Card>

  <Card title="Configuring Agents" icon="gear" href="/platform/ai/configuring-agents">
    Step-by-step guide to enabling agents and customizing their behavior.
  </Card>

  <Card title="Agent Types Reference" icon="list" href="/platform/ai/agent-types">
    Comprehensive reference for all available agent types and their settings.
  </Card>
</CardGroup>

***

## Agent Lifecycle

Each agent follows a consistent lifecycle:

1. **Monitoring** — The agent continuously watches for patterns defined in its criteria (e.g., invoices past due date, contracts within 30 days of expiry)
2. **Evaluation** — When a pattern is detected, the agent calculates a confidence score based on how strongly the situation matches the criteria
3. **Proposal** — A proposed action appears in your **AI Inbox** with a suggested message or note
4. **Review** — You approve, edit, or reject the proposed action (unless auto-execute is enabled)
5. **Execution** — Once approved, the action is sent through the configured channel (email, WhatsApp, voice call, or internal note)

***

## Agent Categories

Agents are organized into categories that reflect the area of your business they monitor:

| Category       | What It Watches                   | Example Agents                                         |
| -------------- | --------------------------------- | ------------------------------------------------------ |
| **Billing**    | Invoices, contracts, payments     | Due Invoice Reminders, Contract Renewal                |
| **Sales**      | Leads, tours, inquiries           | Lead Follow-up, Tour Reminders, Tour No-Show Follow-up |
| **Engagement** | Member activity and onboarding    | Onboarding Nudges, Booking No-Show Follow-up           |
| **Retention**  | Declining usage and churn signals | At-Risk Member Detection                               |
| **Support**    | Help desk tickets and patterns    | Support Pattern Detection, Support Category Spike      |
| **Revenue**    | Upsell and upgrade opportunities  | Upsell Opportunities                                   |
| **Knowledge**  | FAQ gaps and content suggestions  | FAQ Gap Detection                                      |

Some agents are available now; others are marked as **Coming Soon**. The full list with detailed information is on the [Agent Types Reference](/platform/ai/agent-types) page.

***

## Key Concepts

| Term                    | Meaning                                                                                                                                                                                                            |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Agent**               | A monitoring rule that watches for specific patterns in your space data. Each agent focuses on one type of situation (e.g., overdue invoices).                                                                     |
| **Criteria**            | The conditions that trigger an agent. For example, "invoice is 7+ days overdue" is the criteria for the Due Invoice Reminders agent.                                                                               |
| **Confidence Score**    | A percentage (0–100%) that represents how strongly the detected situation matches the agent's criteria. Higher scores mean the AI is more certain the action is appropriate.                                       |
| **Auto-Execute**        | When enabled, actions meeting the minimum confidence threshold are sent automatically without manual review.                                                                                                       |
| **Cooldown**            | A time period (in hours) that prevents the same agent from acting on the same customer repeatedly. For example, a 48-hour cooldown means the agent won't propose another action for that customer within 48 hours. |
| **Channel**             | The communication method used to deliver the action — Email, WhatsApp, Voice, or Internal note.                                                                                                                    |
| **Max Actions Per Day** | The upper limit on how many actions an agent can propose across all customers in a single day.                                                                                                                     |
| **Coming Soon**         | Agents marked as "Coming Soon" are planned features that are not yet available. They appear in the grid but cannot be enabled.                                                                                     |

## Best Practices

### Getting Started

1. **Start slow** — Enable one or two agents at a time to understand how they work
2. **Use manual review first** — Keep auto-execute disabled for the first 1–2 weeks while you monitor the quality of proposed actions
3. **Review your AI Inbox daily** — Get familiar with the types of actions each agent proposes
4. **Test voice calls** — If enabling voice agents, use the test call feature to verify quality before going live

### Optimization

* **Adjust cooldowns** — If you're seeing too many or too few actions, adjust the cooldown period
* **Monitor approval rates** — Track how often you approve vs. reject actions to calibrate confidence thresholds
* **Customize prompts** — Once comfortable, customize first messages and system prompts to match your location's tone
* **Review metrics weekly** — Check which agents are most active and which generate the most value

### Safety Tips

* Never enable auto-execute immediately — test with manual review first
* Start with conservative rate limits (higher cooldown, lower max actions per day)
* Test voice calls thoroughly before enabling auto-execute for voice agents
* Monitor customer feedback and adjust accordingly
* Remember that Coming Soon agents cannot be enabled — they're planned features

***

## What's Next?

* Learn how to [configure individual agents](/platform/ai/configuring-agents) with step-by-step instructions
* Browse the [Agent Types Reference](/platform/ai/agent-types) for detailed information on each agent
* Understand how to [review and manage proposed actions](/platform/ai/inbox) in the AI Inbox


# Reviewing Actions
Source: https://learn.nexudus.com/platform/ai/reviewing-actions

Step-by-step guide to reviewing, editing, approving, rejecting, and snoozing proposed actions from proactive agents.

## What This Page Covers

Once a proactive agent detects a pattern worth acting on, a proposed action appears in your [AI Inbox](/platform/ai/inbox). This page walks you through exactly what to do when one shows up — how to understand the context, edit the message, and choose the right action.

<Frame>
  <img alt="AI Inbox action detail panel with context, message draft, and action buttons" />
</Frame>

## Opening a Proposed Action

**From the inbox list:**

1. Navigate to **Operations** → **AI Assistant** → **AI Inbox**.
2. Click anywhere on the action row you want to review.
3. The detail panel opens, showing **Context & History** on the left and the **Message Draft** on the right.

**What you see at a glance:**

| Element              | Where                 | What it tells you                                                                         |
| -------------------- | --------------------- | ----------------------------------------------------------------------------------------- |
| **Priority badge**   | Top-left of the panel | How urgent the action is — Low, Medium, High, or Critical                                 |
| **Status badge**     | Next to priority      | Current state — Pending, Approved, Rejected, Snoozed, Deferred, Expired, or Auto-executed |
| **Channel badge**    | Next to status        | How the action will be delivered — Email, WhatsApp, or Voice                              |
| **Confidence score** | Context panel         | The AI's confidence level (0–100%) with a progress bar                                    |
| **Expires**          | Context panel         | When the action will expire if not reviewed, shown as a date and "from now"               |

## Understanding the Context

The left panel gives you everything you need to decide whether the proposed action makes sense.

### Customer Information

* **Profile photo** and full name
* **Company name** (if applicable)
* **Customer type** — Member (has active contract), Contact (no contract), or Lead
* Quick link to open the full customer profile

### Why This Was Proposed

This section explains the trigger that created the action:

* **Agent name** — Which proactive agent generated this (e.g., "Due Invoice Reminders").
* **Criteria** — A short label for the trigger type.
* **Reason** — A plain-language explanation of what the AI detected. For example: *"Invoice #INV-2024-0847 is 5 days overdue. Customer has a strong payment history but missed this payment, which is unusual."*

### Confidence Score

The confidence score reflects how strongly the detected situation matches the agent's criteria. It's shown as a percentage with a color-coded progress bar:

* **Green (80–100%)** — High confidence. The AI is fairly certain this action is appropriate.
* **Yellow (50–79%)** — Moderate confidence. There are some signals, but they may not be definitive.
* **Red (0–49%)** — Low confidence. The AI is uncertain — review carefully before approving.

### Customer History Tab

Click the **Customer history** tab at the top of the detail panel to see:

* **Recent activity** — Check-ins, bookings, last visit date.
* **Communication history** — Recent AI conversations, emails, and previous proactive actions sent to this customer.
* **Payment history** — Past invoices and payment patterns.
* **Support tickets** — Recent help desk messages or unresolved issues.

This context helps you avoid sending messages that conflict with recent activity — for example, a payment reminder when the customer just submitted a dispute ticket.

### Linked Conversations

If the action was triggered by a customer conversation, you'll see links to:

* **View source conversation** — The AI chat session that led to this proposal.
* **View outcome conversation** — Any follow-up conversation started after a previous action was sent.

## The Message Draft

The right panel shows the message the AI has composed. You can review it as-is or edit it before sending.

### Email Actions

For Draft Message actions, you'll see:

* **Subject** — The proposed subject line (editable when status is Pending or Snoozed).
* **Message body** — Full HTML-formatted content with your default signature appended.
* **To / From** — Customer email and your location's default sending address.

### Voice Actions

For Voice Outreach actions, you'll see:

* **To** — Customer phone number.
* **Script** — The full text the AI will speak during the call (editable).
* **Tone** — Friendly, professional, or urgent, based on the context.

### Editing the Message

When the action status is **Pending** or **Snoozed**, the subject and body fields are editable:

1. Type directly into the subject or message body fields.
2. Use the rich text toolbar to apply bold, italic, bullet points, or links.
3. The message body supports HTML formatting for professional-looking emails.

**Tip:** Keep the core message intact. Variables like `{{customer_name}}` and `{{invoice_number}}` are auto-replaced with real data when the action is sent — editing them manually is possible but usually unnecessary.

### Delivery Channel

You can change how the message is delivered by selecting a different channel from the **Delivery channel** dropdown:

* **Email** — Text-based messages sent to the customer's email address.
* **Voice** — AI-powered phone call using the customer's mobile number.

**Important warnings for Voice messages:**

* If the customer doesn't have a valid phone number, a warning appears and blocks sending.
* If business hours enforcement is enabled and it's outside your location's business hours, approving a voice message will automatically **defer** it until the next business hours window.

## Taking Action: Four Options

Every pending or snoozed action gives you three buttons at the bottom of the detail panel. Here's when and how to use each one.

### Approve & Send

Use when the message is accurate, the tone is right, and you're happy with it as-is.

1. Review the customer context and the message draft.
2. (Optional) Add **review notes** in the text area at the bottom — these are internal notes for your team, not sent to the customer.
3. Click **Approve & Send** (green button with a check icon).
4. Confirm in the modal that appears.

**What happens next:**

* The message is sent immediately through the selected channel.
* The action status changes to **Approved**.
* The customer receives the email, WhatsApp message, or voice call within seconds.
* Any reply from the customer starts a two-way conversation in [AI Conversations](/platform/ai/ai-conversations).
* The action is logged in the customer's history and tracked in your metrics.

<Warning>
  Once approved, the message is sent immediately and cannot be unsent. If you need changes, edit the message before approving.
</Warning>

### Snooze

Use when you want to revisit the action later — perhaps after following up with the customer directly, waiting for more information, or simply because you're busy right now.

1. Click **Snooze** (orange button with a clock icon).
2. Choose a duration from the menu:

| Duration     | When to use                                                        |
| ------------ | ------------------------------------------------------------------ |
| **1 hour**   | You'll review it shortly — after a meeting, for example.           |
| **4 hours**  | You want to finish other tasks first and come back this afternoon. |
| **24 hours** | You'd like to review it tomorrow.                                  |
| **3 days**   | You want a few days before following up.                           |
| **1 week**   | You want to revisit it next week.                                  |

3. The action moves to the **Snoozed** segment and returns to pending after the selected period.

**Tip:** Snoozing is a great way to batch-process actions when your inbox gets overwhelming. Snooze everything, then review the batch later when you have more time.

### Reject

Use when the action isn't appropriate — the issue is already resolved, the timing is wrong, or you'd prefer to handle it personally.

1. Click **Reject** (red button with a cross icon).
2. Confirm in the modal that appears.

**What happens next:**

* The message is **not** sent to the customer.
* The action status changes to **Rejected**.
* The action is removed from the pending queue.
* The rejection is logged for analytics — this helps the system improve future proposals.

<Note>
  Rejection reason tracking is planned for a future release. For now, rejections are logged internally to help improve agent criteria over time.
</Note>

**When to adjust an agent:** If you're rejecting many actions from the same agent, consider [adjusting its configuration](/platform/ai/configuring-agents) — for example, increasing the cooldown period, raising the confidence threshold, or reducing the max actions per day.

## Review History

Once an action has been reviewed, you can see who reviewed it and when:

| Field           | Description                                                  |
| --------------- | ------------------------------------------------------------ |
| **Reviewed by** | Name of the team member who approved or rejected the action. |
| **Reviewed on** | Date and time of the review.                                 |
| **Notes**       | Any internal review notes added at the time of review.       |

This review history appears in the **Context** section of the detail panel and is visible in the Approved and Rejected segments.

## Status Reference

Understanding the different statuses helps you know where each action stands:

| Status            | Meaning                                                                    | Can Edit?           | Can Approve? |
| ----------------- | -------------------------------------------------------------------------- | ------------------- | ------------ |
| **Pending**       | Awaiting your review. This is the default state.                           | Yes                 | Yes          |
| **Approved**      | You reviewed and sent the action.                                          | No                  | N/A          |
| **Rejected**      | You dismissed the action.                                                  | No                  | N/A          |
| **Snoozed**       | Deferred for later — will return to pending after the snooze period.       | Yes                 | Yes          |
| **Deferred**      | Held until a specific time or condition (e.g., business hours).            | No (until executed) | No           |
| **Expired**       | The time window to act on this has passed.                                 | No                  | N/A          |
| **Auto-executed** | Sent automatically without manual review (agent has auto-execute enabled). | No                  | N/A          |

## Best Practices for Reviewing

### Daily Review Routine

For the best results, check your inbox **2–3 times per day**:

1. **Morning** — Review overnight actions first thing. Prioritize Critical and High priority items.
2. **Midday** — Catch up on anything that came in since your morning review.
3. **End of day** — Clear any remaining pending items before logging off.

### Prioritizing by Priority Level

| Priority     | How to handle                                                                                       |
| ------------ | --------------------------------------------------------------------------------------------------- |
| **Critical** | Review immediately — these are time-sensitive (e.g., invoices 15+ days overdue, cancellation risk). |
| **High**     | Review within a few hours — important but not urgent.                                               |
| **Medium**   | Review during your regular daily check.                                                             |
| **Low**      | Batch-process when you have spare time.                                                             |

### Building Confidence Over Time

As you use proactive agents more, your approval patterns will help the system learn:

* **Consistent approvals** for a specific agent → higher confidence scores over time.
* **Frequent rejections** → the agent may lower its confidence or flag actions for closer review.
* **Review notes** (when available) → provide feedback that trains future proposals.

<CardGroup>
  <Card title="AI Inbox" icon="inbox" href="/platform/ai/inbox">
    Understand the inbox interface, filtering, and segments.
  </Card>

  <Card title="Configuring Agents" icon="sliders" href="/platform/ai/configuring-agents">
    Adjust agent settings based on your review patterns.
  </Card>
</CardGroup>


# Discount Codes
Source: https://learn.nexudus.com/platform/billing/discount-codes

How to create and manage discount codes in Nexudus — percentage or fixed-amount discounts, applicable items, validity dates, use limits, and referral discounts.

## Overview

**Discount codes** let you offer special prices to your customers when purchasing any of your services. You can create unique codes that apply percentage-based or fixed-amount discounts to plans, products, bookings, or events.

Discount codes are useful for:

* Welcome offers for new customers
* Seasonal promotions and sales
* Referral programs (rewarding both the referrer and new customer)
* Partner or community discounts
* Trial offers for specific services

Each discount code belongs to a **location** and can be configured with:

* **Discount type** — percentage (%) or fixed amount
* **Applicable items** — plans, products, bookings, or events (or any combination)
* **Validity dates** — when the code can be redeemed
* **Use limits** — total redemptions and per-customer limits
* **Audience restrictions** — members only, contacts only, or both

***

## How to access

Go to [Discount codes](https://dashboard.nexudus.com/finance/discountCodes).

<Note>
  Requires the **discountCodes** role.
</Note>

***

## Creating a discount code

<Steps>
  <Step title="Navigate to Discount codes">
    Go to **Finance → Discount codes** and click **Add discount code**.
  </Step>

  <Step title="Enter discount details">
    The discount code form has five tabs: **Discount details**, **Discounted items**, **Available dates**, **Use limits**, and **Customers**.
  </Step>

  <Step title="Configure discount details">
    Fill in the code, description, discount amount, and whether it's a referral discount (see the section below for details).
  </Step>

  <Step title="Set discounted items">
    Choose which plans, products, bookings, or events the discount applies to.
  </Step>

  <Step title="Set availability and limits">
    Configure validity dates, published dates, and use limits.
  </Step>

  <Step title="Save">
    Click **Save** to create the discount code. You can assign it to specific customers later from the **Customers** tab.
  </Step>
</Steps>

***

## Discount details

### Discount code

| Field            | Description                                                                                                                                        |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Code**         | The unique alphanumeric code customers enter to apply the discount (e.g., `WELCOME10`). Must be unique within each location.                       |
| **Available at** | The location this discount is available at. If you choose a **network** location, the discount will be available at all locations in that network. |
| **Description**  | Text shown to customers when they enter a valid discount code.                                                                                     |

<Tip>
  The code is auto-generated when you create a new discount code, but you can customize it to something memorable like `SUMMER2026` or `REFERRAL20`.
</Tip>

### Active status

* **This discount is active** — When unchecked, the code cannot be redeemed. Use this to pause a promotion without deleting it.

### Referral discount

* **This is a referral discount** — When enabled, this discount is automatically applied to the customer **sending** the referral link when a new customer signs up using it.

<Info>
  If you want **both** the referee (new customer) and the referrer (existing customer) to receive a discount, create a regular discount using the same discount code and apply it to the new customer's signup.
</Info>

### Discount amount

Set the discount as either a **percentage** or a **fixed amount** — you cannot use both at the same time.

| Field                       | Description                                                    |
| --------------------------- | -------------------------------------------------------------- |
| **Discount percentage (%)** | A percentage off the total (e.g., `10` = 10% off).             |
| **Discount amount**         | A fixed monetary amount off the total (e.g., `25` = \$25 off). |

### Purchase links

When you create a discount code, Nexudus automatically generates shareable links:

| Link type                            | Description                                                                     |
| ------------------------------------ | ------------------------------------------------------------------------------- |
| **Purchase link (new customers)**    | Directs new visitors to the signup page with the discount code pre-filled.      |
| **Invite link (existing customers)** | Directs logged-in members to the signup page with the discount code pre-filled. |

You can copy these links and share them via email, social media, or your website.

***

## Discounted items

Select which items this discount code applies to. You can enable one or more categories.

### Plans

* Toggle **This discount code can be used to pay for any plans** to apply to all plans.
* Or toggle it off and select specific plans from the list to apply the discount only to those plans.

### Products

* Toggle **This discount code can be used to pay for any products** to apply to all products.
* Or toggle it off and select specific products to apply the discount only to those products.

### Bookings

* Toggle **This discount code can be used to pay for any bookings** to apply to all booking resource types.
* Or toggle it off and select specific resource types (e.g., meeting rooms, event spaces) to restrict the discount.

### Events

* Toggle **This discount code can be used to pay for any events** to apply to all event categories.
* Or toggle it off and select specific event categories to apply the discount only to those events.

<Tip>
  For maximum flexibility, leave all categories enabled and the discount will apply to any eligible item the customer adds to their cart.
</Tip>

***

## Availability

Discount codes have two sets of dates that control different aspects of availability.

### Discount validity

These dates control when the discount can be **redeemed** by customers.

| Field           | Description                                                                        |
| --------------- | ---------------------------------------------------------------------------------- |
| **Valid from**  | The earliest date the discount can be used. Leave empty for immediately available. |
| **Valid until** | The last date the discount can be used. Leave empty for no expiration.             |

### Expiration after assignment

You can also set the discount to expire for a specific customer after they've been assigned it (useful for referral discounts or one-time codes).

| Field                           | Description                                                                                                                                       |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **This discount never expires** | When enabled, the discount doesn't expire after assignment.                                                                                       |
| **This discount expires after** | Select a time period (Days, Weeks, Months, Years) and enter a number. The discount expires for a customer this long after being assigned to them. |

### Published dates

These dates control when the discount is **visible** to customers on your website or the members portal.

| Field             | Description                                                                                     |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| **Publish from**  | The date the discount becomes visible on your website/app. Leave empty for immediately visible. |
| **Publish until** | The date the discount is hidden from your website/app. Leave empty for always visible.          |

<Warning>
  **Validity dates** control when a code can be redeemed. **Published dates** control when customers can see and access the code on your website. A code can be published but not yet valid (shown in advance), or valid but not yet published (working internally before going live).
</Warning>

***

## Use limits

Control how many times a discount code can be used to prevent overuse or create urgency.

### Who can use this discount?

| Option            | Description                                                                                                     |
| ----------------- | --------------------------------------------------------------------------------------------------------------- |
| **Everyone**      | Both members (customers with active contracts) and contacts (customers without contracts) can use the discount. |
| **Contacts only** | Only customers without an active contract can use this discount. Useful for acquisition campaigns.              |
| **Members only**  | Only customers with an active contract can use this discount. Useful for retention or upsell campaigns.         |

### Overall use limit

| Option                                                 | Description                                                                                                           |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| **Enable overall use limit**                           | Set a maximum number of total redemptions across all customers. Once reached, the discount is automatically disabled. |
| **Disable discount once it has been used *N* time(s)** | The total number of times this code can be redeemed by anyone.                                                        |
| **This discount can be used any number of times**      | No overall limit.                                                                                                     |

### Per-customer use limit

| Option                                                                 | Description                                                    |
| ---------------------------------------------------------------------- | -------------------------------------------------------------- |
| **Enable per-customer use limit**                                      | Set how many times a single customer can redeem this discount. |
| **Prevent customers from using this discount more than *N* time(s)**   | Maximum redemptions per individual customer.                   |
| **This discount can be used any number of times by the same customer** | No per-customer limit.                                         |

<Tip>
  For referral discounts, set **Per-customer use limit** to `1` so each customer can only use the referral code once.
</Tip>

***

## Assigning discounts to customers

The **Customers** tab shows all customers who have been assigned this discount code. You can assign discount codes to specific customers in two ways:

### Automatic assignment

* **Referral discounts** are automatically assigned when a customer shares their referral link and someone signs up.
* Discounts can be automatically applied during checkout if the customer enters a valid code.

### Manual assignment

You can assign discount codes to specific customers from their customer record:

1. Navigate to **Operations → Customers** and open a customer's record.
2. Go to the **Benefits** tab.
3. Find the **Discount codes** section.
4. Add the discount code(s) you want to assign.

Once assigned, the customer can use the discount code when making purchases according to the discount's configuration (validity dates, use limits, etc.).

***

## Discount code statuses

Discount codes can have the following statuses, shown as badges in the discount codes list:

| Status                      | Description                                                                   |
| --------------------------- | ----------------------------------------------------------------------------- |
| **Active** (green)          | The code is active and currently available for use.                           |
| **Inactive** (red)          | The code is deactivated and cannot be redeemed.                               |
| **Referral** (blue)         | This code is used as part of the referral program.                            |
| **Not yet available** (red) | The code is active but the **Valid from** date is in the future.              |
| **Expired** (red)           | The code's **Valid to** date has passed.                                      |
| **Not yet published** (red) | The code is active but the **Publish from** date is in the future.            |
| **Retired** (red)           | The code's **Publish to** date has passed — no longer visible on the website. |

***

## Best practices

### Creating effective discount codes

1. **Keep codes memorable** — Use meaningful codes like `WELCOME10`, `SUMMER2026`, or `PARTNER15` that customers can easily remember and share.

2. **Set clear use limits** — Even if you want unlimited redemptions, explicitly setting a high limit or "no limit" makes your intent clear to your team.

3. **Use published dates for campaigns** — Set **Publish from** and **Publish to** dates to align with marketing campaigns, so the code automatically appears and disappears from your website.

4. **Track performance** — Monitor how many times each code is used from the **Customers** tab to see which promotions are most effective.

### Referral discount strategies

1. **Create separate codes for referrer and referee** — If you want both parties to receive a discount, create two codes with the same code string:
   * One marked as a **Referral discount** (applies to the referrer)
   * One as a regular discount (applies to the new customer)

2. **Set per-customer limits** — For referrals, set **Per-customer use limit** to `1` so each customer can only refer one new customer with that code.

3. **Use audience restrictions** — Set referral codes to **Contacts only** so they only apply to new customers signing up for the first time.

### Common use cases

| Use case                 | Recommended configuration                                                                       |
| ------------------------ | ----------------------------------------------------------------------------------------------- |
| **New customer welcome** | Percentage discount, Contacts only, No per-customer limit, Set published dates for campaign     |
| **Seasonal sale**        | Fixed amount or percentage, Everyone, Overall use limit for urgency, Set published dates        |
| **Partner discount**     | Percentage discount, Everyone or Members only, No limits, Share code directly with partner      |
| **Referral program**     | Referral discount enabled, Contacts only for referee, Per-customer limit of 1, No overall limit |
| **Employee discount**    | Percentage discount, Members only, No limits, Assign manually to employee accounts              |

***

## Related features

* [Plans](/platform/billing/plans) — Create and manage membership plans that discount codes can apply to
* [Products](/platform/billing/products) — Manage products that discount codes can apply to
* [Resource rates](/platform/billing/resource-rates) — Set booking rates that discount codes can apply to
* [Time passes](/platform/billing/time-passes) — Manage passes that discount codes can apply to
* [Discount Codes REST API](/rest-api/billing/discount-codes) — Automate discount code management via API


# Inventory
Source: https://learn.nexudus.com/platform/billing/overview

An introduction to the Inventory module — where you manage your products, plans, passes, resources, floor plans, and lockers.

## Overview

The Inventory module is where you define everything your space offers and how customers pay for it. It covers your membership plans, the products and services you sell, the physical spaces and resources you rent out, and the rules that control who can book what.

From here you can manage:

* What you sell (plans, products, passes, event tickets)
* Where people work (floor plans, desks, offices)
* What people book (resources, meeting rooms, equipment)
* How booking access is controlled (time credits, resource rules)
* What people store (lockers)

## Sections

### Sales

<CardGroup>
  <Card title="Products" icon="box" href="/platform/billing/products">
    One-off items or services sold individually or as add-ons to a plan.
  </Card>

  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Membership plans that drive your recurring billing and define what customers receive.
  </Card>

  <Card title="Passes" icon="clock" href="/platform/billing/time-passes">
    Control when and how long customers can access your space with time-limited passes.
  </Card>
</CardGroup>

### Desks and offices

<CardGroup>
  <Card title="Floor plans" icon="map" href="/platform/billing/floor-plans">
    Physical layouts for your offices, desks, and meeting rooms.
  </Card>

  <Card title="Equipment" icon="desktop" href="/platform/billing/equipment">
    Items supplied to customers and tracked — such as desks, pedestals, or IT hardware.
  </Card>
</CardGroup>

### Rooms and resources

<CardGroup>
  <Card title="Resources" icon="door-open" href="/platform/billing/resources">
    Meeting rooms and other bookable areas or items available via your calendar.
  </Card>

  <Card title="Resource types" icon="layer-group" href="/platform/billing/resource-types">
    Categories to organise your resources (e.g., meeting rooms, hot desks, parking).
  </Card>

  <Card title="Time credits" icon="coins" href="/platform/billing/time-credits">
    Credit allowances included in plans that customers spend when booking resources.
  </Card>

  <Card title="Resource rules" icon="shield-halved" href="/platform/billing/resource-rules">
    Access rules that control which customers can book specific resources.
  </Card>

  <Card title="Lockers" icon="lock" href="/platform/billing/lockers">
    Locker groups that customers can reserve for personal storage.
  </Card>
</CardGroup>

## How to access

Navigate to **Inventory** in the left sidebar. The section expands to show all available sub-pages depending on your role and enabled modules.

## Key concepts

| Term                | Meaning                                                                                                                                                                                |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Product**         | A purchasable item or service — can be sold as a one-off, as a recurring add-on in a contract, linked to a resource for booking extras, or used to represent deposits and sign-up fees |
| **Plan**            | A membership subscription that defines what a customer receives on a recurring basis (access, credits, limits, included products). Plans can also represent virtual offices.           |
| **Pass**            | A time-limited access pass that controls when and how long a customer can be in the space                                                                                              |
| **Resource**        | A bookable asset such as a meeting room, hot desk, parking bay, or piece of equipment                                                                                                  |
| **Resource type**   | A category for grouping resources (e.g., "Meeting rooms", "Hot desks")                                                                                                                 |
| **Time credit**     | A prepaid booking allowance — plans can include credits that customers spend when they book resources                                                                                  |
| **Printing credit** | A prepaid allowance for printing services, included in plans or sold separately                                                                                                        |
| **Resource rule**   | A restriction that limits which customers or plans can access a specific resource                                                                                                      |
| **Floor plan**      | A visual layout of your space showing desks, offices, and rooms                                                                                                                        |
| **Equipment**       | A tracked physical asset assigned to a customer (e.g., monitor, desk, pedestal)                                                                                                        |
| **Event ticket**    | A product attached to an event — customers purchase tickets to attend paid events                                                                                                      |
| **Charge**          | A generic debit item applied to a customer's account for ad-hoc billing outside of products, bookings, or events                                                                       |

## How it all fits together

The Inventory module defines the building blocks that the rest of the platform uses. There are several ways to sell to customers:

| What you sell     | How it works                                                                                                                                                                                                                                                                                                                                           |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Plans**         | Sold via contracts. A plan defines the recurring membership fee and what it includes (access, credits, limits). Plans may or may not include products. Contracts are always for a plan but can be connected to one or more desks or units representing the physical spaces being contracted by the customer. Plans can also represent virtual offices. |
| **Products**      | Versatile items that can be sold in multiple ways: as add-ons in a contract, linked to resources and sold via bookings, used to represent deposits or sign-up fees in contracts and proposals, or purchased directly from the members portal.                                                                                                          |
| **Event tickets** | Events can be free or paid. Paid events use event products (ticket types) to sell attendance. Event products are a separate entity — they are not related to products.                                                                                                                                                                                 |
| **Courses**       | Courses can be sold if they are associated with a plan — customers need an active contract on that plan to access the course.                                                                                                                                                                                                                          |
| **Passes**        | Time-limited access passes sold independently of a plan — useful for day visitors or part-time users.                                                                                                                                                                                                                                                  |
| **Resources**     | Bookable items (meeting rooms, desks, equipment) charged per use via time credits or direct pricing. Products can be linked to resources to offer extras at booking time (e.g., catering, AV equipment).                                                                                                                                               |
| **Charges**       | A generic way to bill any item to a customer's account — used when a sale doesn't fit neatly into products, bookings, or events.                                                                                                                                                                                                                       |

These elements connect across the platform:

* **Plans** control access — they determine which resources a customer can book, what limits apply, and what discounts they receive.
* **Resources** appear in the booking calendar and can have products linked to them for upselling extras at booking time.
* **Floor plans** provide a visual representation of your physical space, linking desks, offices, and rooms to resources. Desks and offices on floor plans are the units that can be linked to contracts.
* **Time credits** are included in plans and spent when customers make bookings, bridging billing and resource usage.

## Common workflows

<Accordion title="Setting up a new meeting room">
  1. Go to **Inventory → Resources** and click the "+" button.
  2. Name the room and assign it to a **resource type** (e.g., "Meeting rooms").
  3. Set the capacity, hourly rate, and availability schedule.
  4. Optionally add **resource rules** to restrict access to certain plans.
  5. The room now appears in the booking calendar for eligible customers.
</Accordion>

<Accordion title="Creating a membership plan">
  1. Go to **Inventory → Plans** and click the "+" button.
  2. Set the name, price, and billing cycle (monthly, weekly, etc.).
  3. Include products that members on this plan receive automatically.
  4. Add time credits to give members a booking allowance for resources.
  5. Configure access rules — which resources this plan grants access to.
  6. The plan is now available for assignment to customers via contracts.
</Accordion>

<Accordion title="Adding a day pass">
  1. Go to **Inventory → Passes** and click the "+" button.
  2. Set the name, duration, and price.
  3. Define valid check-in hours and maximum usage time.
  4. Customers can purchase the pass from the members portal or you can assign it manually.
</Accordion>

<Accordion title="Setting up floor plans">
  1. Go to **Inventory → Floor plans** and create a new floor plan.
  2. Upload a background image of your space layout.
  3. Place desk and room markers on the plan using the visual editor.
  4. Link each marker to a resource for bookings or to a customer for dedicated desks.
  5. The floor plan is visible in the members portal and on the dashboard.
</Accordion>

## Related pages

<CardGroup>
  <Card title="Finance" icon="file-invoice-dollar" href="/platform/finance/overview">
    Manage invoices, contracts, and payment processing for the products and plans you create here.
  </Card>

  <Card title="Operations" icon="gears" href="/platform/operations/overview">
    See your products and resources in action — bookings, check-ins, and member activity.
  </Card>

  <Card title="Discount codes" icon="percent" href="/platform/billing/discount-codes">
    Create promotional codes that apply discounts to products and plans.
  </Card>

  <Card title="Settings" icon="sliders" href="/platform/settings/overview">
    Configure billing behaviour, tax rates, and payment integrations.
  </Card>
</CardGroup>


# Plans
Source: https://learn.nexudus.com/platform/billing/plans

How to create and manage membership plans in Nexudus — pricing, billing cycles, prorating, cancellation terms, benefits, limits, and virtual office configuration.

## Overview

**Plans** (also called memberships) define what a membership includes, how often it's invoiced, what benefits customers receive, and what limits apply. Plans are the foundation of your recurring revenue — every customer with an active contract is on a plan.

A plan can represent:

* A full-time desk or office membership
* A part-time hot-desking plan
* A virtual office with mail handling
* Storage-only access
* Any other recurring subscription model

Plans are sold via **contracts**. When a customer signs up for a plan, a contract is created linking them to that plan.

## How to access

Navigate to **Inventory → Plans**.

<Note>
  Requires the **tariff** role.
</Note>

***

## Plan kinds

Every plan has a **kind** that classifies the membership type. This helps you organize your plans and is used in analytics.

| Kind                         | Typical use                                                                                 |
| ---------------------------- | ------------------------------------------------------------------------------------------- |
| **Full-time Private Office** | Dedicated office with 24/7 access                                                           |
| **Part-time Private Office** | Dedicated office with limited access hours/days                                             |
| **Full-time Dedicated Desk** | Assigned desk with 24/7 access                                                              |
| **Part-time Dedicated Desk** | Assigned desk with limited access                                                           |
| **Full-time Hot Desk**       | Unassigned desk with 24/7 access                                                            |
| **Part-time Hot Desk**       | Unassigned desk with limited access                                                         |
| **Other Full-time plans**    | Other models with 24/7 access                                                               |
| **Other Part-time plans**    | Other models with limited access                                                            |
| **Storage**                  | Storage unit only, no workspace access                                                      |
| **Virtual Office**           | Mail handling and business address without physical workspace (see dedicated section below) |
| **Virtual**                  | Virtual-only services                                                                       |
| **Other plans**              | Anything else                                                                               |

***

## Creating a plan

<Steps>
  <Step title="Navigate to Plans">
    Go to **Inventory → Plans** and click the "+" button.
  </Step>

  <Step title="Enter plan details">
    * **Plan name** — a clear name shown to customers
    * **Plan kind** — select the category that best fits
    * **Plan description** — explain what's included (shown in the members portal)
  </Step>

  <Step title="Set pricing and billing cycle">
    * **Price** — the recurring charge amount
    * **Every (months/weeks)** — how often the plan is invoiced (e.g., 1 month, 3 months, 1 week)
  </Step>

  <Step title="Configure portal display">
    * **Display this plan on the website/App** — whether customers can see and purchase it
    * **Category** — a grouping tag for the shop
    * **Display position** — sort order
  </Step>

  <Step title="Save">
    Click **Save** to create the plan. Additional tabs become available for benefits, limits, restrictions, deposits, and legal terms.
  </Step>
</Steps>

***

## Pricing and billing

### Billing cycle

| Field              | Description                                                                                     |
| ------------------ | ----------------------------------------------------------------------------------------------- |
| **Price**          | The recurring charge per billing cycle                                                          |
| **Every (months)** | Bill monthly, quarterly, etc. (e.g., 1 = monthly, 3 = quarterly, 12 = yearly)                   |
| **Every (weeks)**  | Alternative to monthly billing — bill weekly or fortnightly (e.g., 1 = weekly, 2 = fortnightly) |

<Info>
  You can choose **either** month-based or week-based billing, not both. Setting one clears the other.
</Info>

### Additional invoices

You can create supplementary invoices between the main billing cycles — for example, invoice monthly but send a secondary reminder invoice every 2 weeks.

| Field                          | Description                          |
| ------------------------------ | ------------------------------------ |
| **Create additional invoices** | Enables mid-cycle invoicing          |
| **Every (months/weeks)**       | Frequency of the additional invoices |

<Warning>
  This is separate from advance invoicing (see below) — additional invoices are reminders, not advance charges.
</Warning>

### Billing day and prorating

#### Billing day

| Option            | Description                                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Fixed day**     | All customers on this plan are billed on the same day of the month (e.g., 1st of each month). Select a number from 1–28. |
| **Day of signup** | Each customer is billed on the day they signed up (e.g., signed up on the 15th → billed on the 15th).                    |

#### First invoice prorating

Prorating discounts the first invoice when a customer signs up partway through a billing cycle.

| Field                               | Description                                                                                                                                                 |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **First invoice prorated discount** | Number of days before the billing day that triggers prorating. If a customer signs up within this window, their first invoice is discounted proportionally. |
| **Prorate day of month**            | The target day used to calculate the prorate discount. If not set, falls back to the **fixed billing day** (if set).                                        |

**How it works:**

1. Customer signs up on day X

2. System calculates how many days until the next prorate day (e.g., day 1 of next month)

3. If that number of days ≤ **First invoice prorated discount**, prorating applies:
   * Days in the full billing cycle = M (e.g., 30 days for a monthly plan)
   * Days until next billing = N
   * Days to discount = M - N
   * Price per day = (Plan price) / M
   * Discount = (Price per day) × (Days to discount)
   * A negative line item is added to the first invoice with this discount amount

4. After the first invoice, prorating is turned off for that contract

**Example:** Monthly plan, $100/month, prorate day = 1st, prorate window = 30 days. Customer signs up on Jan 15th. Days until Feb 1st = 17. Since 17 ≤ 30, prorating applies. Days in Jan = 31. Days to discount = 31 - 17 = 14. Discount = (100/31) × 14 = $45.16. First invoice = $100 - $45.16 = \$54.84.

<Tip>
  Set **First invoice prorated discount** to match your billing cycle length (e.g., 30 days for monthly) to always prorate proportionally, regardless of signup day.
</Tip>

#### Last invoice prorating (cancellation discount)

| Field                              | Description                                                                                                            |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Last invoice prorated discount** | When enabled, the final invoice is discounted for the unused portion of the billing cycle after the cancellation date. |

**How it works:**

* Customer cancels mid-cycle
* The invoice period is shortened to the cancellation date
* Days from cancellation to the original period end are discounted using the same formula as first invoice prorating

**Example:** Monthly plan, $100/month, customer cancels on Jan 20th. Original period ends Jan 31st. Days to discount = 11. Discount = (100/31) × 11 = $35.48. Final invoice = $100 - $35.48 = \$64.52.

<Warning>
  Prorating only applies if you set **First invoice prorated discount** with a prorate day. Without that configuration, cancellation prorating cannot work.
</Warning>

#### Advance invoicing

| Field                | Description                                                                                            |
| -------------------- | ------------------------------------------------------------------------------------------------------ |
| **Advance payments** | Number of billing cycles to invoice upfront (e.g., 2 = invoice 3 cycles at once: current + 2 advance). |

**How it works:**

* The system generates a single invoice containing multiple billing periods as separate line items
* Each line shows the date range it covers
* If the customer cancels during an advance period, the affected line is pro-rated (if last invoice prorating is enabled)

**Example:** Monthly plan, \$100/month, advance payments = 2. Customer signs up on Jan 1st. First invoice contains:

* Line 1: Jan 1 – Jan 31 (\$100)
* Line 2: Feb 1 – Feb 28 (\$100)
* Line 3: Mar 1 – Mar 31 (\$100)
* **Total: \$300**

### Booking charges due date

Controls when charges from bookings (resources, meeting rooms) are added to invoices.

| Option                                            | Description                                                               |
| ------------------------------------------------- | ------------------------------------------------------------------------- |
| **When the next contract renews**                 | Booking charges accumulate and are invoiced on the next plan renewal date |
| **When the booking ends**                         | Charges are invoiced immediately after the booking finishes               |
| **When the booking was created**                  | Charges are invoiced as soon as the booking is made                       |
| **A specific day of the month after the booking** | Charges are invoiced on a fixed monthly billing day (specify day 1–28)    |

### Minimum price

Ensures a customer spends at least a certain amount each billing cycle, regardless of usage.

| Field                 | Description                                                                                                                  |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| **Minimum price**     | The floor amount per billing cycle. If the customer's charges fall below this, a top-up charge is added to meet the minimum. |
| **Consider passes**   | Include pass purchases in the minimum calculation                                                                            |
| **Consider bookings** | Include booking charges in the minimum calculation                                                                           |
| **Consider events**   | Include event ticket purchases in the minimum calculation                                                                    |

**How it works:**

* After the first billing cycle, the system calculates total spend (plan price + passes/bookings/events if selected)
* If total \< minimum price, a line item is added: "\[Plan Name] (min.)" for the difference
* This does **not** apply to the first invoice

***

## Benefits

The Benefits tab lets you bundle credits, passes, and allowances with the plan. Customers automatically receive these when their contract is active.

| Benefit type        | What it provides                                             |
| ------------------- | ------------------------------------------------------------ |
| **Money credit**    | A monetary credit applied to the customer's booking balance  |
| **Time credit**     | An allowance of booking time for specific resource types     |
| **Passes**          | One or more passes granting time-limited access to the space |
| **Printing credit** | An allowance for printing services                           |

Each benefit is a separate linked entity with its own expiration rules, usage limits, and renewal behavior.

### Discounts

You can also configure percentage discounts on certain charges for customers on this plan:

| Discount              | Applies to                                      |
| --------------------- | ----------------------------------------------- |
| **Bookings discount** | Booking charges for resources                   |
| **Passes discount**   | Pass purchases (including pay-as-you-go passes) |
| **Charges discount**  | Generic charges added to the customer's account |

***

## Limits

Limits control customer behavior on a plan. These settings appear under the **Limits** tab.

### Cancellation and pausing

| Field                          | Description                                                                         |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| **Can cancel from portal/app** | When unchecked, customers cannot cancel their own contracts — they must contact you |
| **Can freeze from portal/app** | When checked, customers can pause their contracts temporarily                       |
| **Pauses a year**              | Maximum number of times a customer can pause per year                               |
| **Cycles per freeze**          | Maximum billing cycles a customer can freeze each time they pause                   |

### Account management

| Field                                 | Description                                                                                            |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **Suspend newly signed up customers** | When checked, new contracts start in a paused state and must be manually activated by an administrator |
| **Maximum number of members**         | Cap on how many customers can be on this plan simultaneously                                           |

### Contract terms

| Field                           | Description                                                                                                                                                                      |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Minimum contract term**       | Number of billing cycles the customer must remain on the plan before canceling (e.g., 3 = 3 months for a monthly plan). If set, this term is copied to the contract on creation. |
| **Cancellation notice period**  | Number of days before the contract end that the customer must give notice to cancel. This is copied to the contract on creation.                                                 |
| **Automatic cancellation**      | Number of billing cycles after which the contract automatically cancels itself (e.g., 12 = cancel after 12 months)                                                               |
| **Unpaid account cancellation** | Number of days an account can remain unpaid before the contract is automatically canceled                                                                                        |

<Info>
  The **minimum contract term** and **cancellation notice period** are set at contract creation from the plan defaults. Changing them on the plan does not affect existing contracts.
</Info>

***

## Restrictions

Restrictions are **hard limits** — once a customer reaches them, they are blocked from further use, even if they purchase additional passes or credits.

<Warning>
  Use these cautiously. Customers who hit a restriction cannot check in, book, or bring guests until the next reset period.
</Warning>

### Access day restrictions

| Field                                | Description                                                     |
| ------------------------------------ | --------------------------------------------------------------- |
| **Days of access per billing cycle** | Maximum days the customer can check in within one billing cycle |
| **Days of access per month**         | Maximum days per calendar month                                 |
| **Days of access per week**          | Maximum days per calendar week                                  |

### Access time restrictions

| Field                                 | Description                                                           |
| ------------------------------------- | --------------------------------------------------------------------- |
| **Hours of access per billing cycle** | Maximum hours the customer can be checked in within one billing cycle |
| **Hours of access per month**         | Maximum hours per calendar month                                      |
| **Hours of access per week**          | Maximum hours per calendar week                                       |

### Booking time restrictions

| Field                         | Description                             |
| ----------------------------- | --------------------------------------- |
| **Booking minutes per month** | Maximum booking time per calendar month |
| **Booking minutes per week**  | Maximum booking time per calendar week  |

### Visitor restrictions

| Field                  | Description                                                        |
| ---------------------- | ------------------------------------------------------------------ |
| **Visitors per month** | Maximum number of guests the customer can bring per calendar month |
| **Visitors per week**  | Maximum guests per calendar week                                   |
| **Visitors per day**   | Maximum guests per calendar day                                    |

***

## Deposits and sign-up fees

Under the **Deposits** tab, you can add one-off charges that are invoiced when a customer signs up.

| Type                          | Description                                                                                     |
| ----------------------------- | ----------------------------------------------------------------------------------------------- |
| **Deposits and sign-up fees** | One-time charges added to the first invoice (e.g., key deposit, setup fee, admin fee)           |
| **Plan components**           | Recurring charges bundled with the plan (invoiced every billing cycle alongside the plan price) |

### Plan components

Plan components are products that are added to the contract as recurring charges. They are invoiced every cycle along with the plan price.

| Field                                            | Description                                                                                                                                  |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **Unlink component price when contract created** | When enabled, the product's price is copied to the contract at signup. Future changes to the product price do not affect existing contracts. |

<Tip>
  Use plan components for add-ons like parking, lockers, or extra services that should be bundled with the plan and invoiced together.
</Tip>

***

## Virtual office plans

Virtual office plans provide customers with a business address and mail handling services without physical workspace access. They have special configuration options for compliance, identity verification, and delivery handling.

<Note>
  To enable virtual office features, check **"This plan is a virtual office plan"** on the General tab. The **Virtual Office** tab then appears.
</Note>

### Virtual office onboarding

Virtual office customers must complete a multi-step onboarding process that includes company details, personal details, AML screening, identity verification, and mail preferences. See [Virtual Office Onboarding](/member-portal/virtual-office/onboarding) for the customer-facing flow.

#### Proof of address

| Field                               | Description                                                                                                                                  |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **Require proof of address**        | When enabled, customers must upload proof of address documents before the contract is activated                                              |
| **Address check provider**          | Select **Manual** (administrator reviews documents)                                                                                          |
| **Accepted documents description**  | Instructions shown to the customer about what documents are accepted (e.g., "Utility bill or bank statement dated within the last 3 months") |
| **Repeat the check**                | How often the address verification must be repeated (Never, Every 3/6/12/24 months)                                                          |
| **Keep paused if address mismatch** | When enabled, contracts remain paused if the address on the uploaded document does not match the customer's registered address               |

#### Proof of ID

| Field                              | Description                                                                                                   |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Require proof of ID**            | When enabled, customers must provide identity verification before activation                                  |
| **ID check provider**              | Select **Manual** (admin review), **Stripe Identity** (automated), or **Open Sanctions** (AML database check) |
| **Accepted documents description** | Instructions for manual ID checks (not shown if using Stripe Identity)                                        |
| **Repeat the check**               | How often identity verification must be repeated (Never, Every 3/6/12/24 months)                              |

<Info>
  Stripe Identity provides automated ID verification using a selfie and document scan. It returns instant results and checks against fraud databases.
</Info>

#### AML screening

Anti-money laundering (AML) checks screen directors and company information against sanctions lists and watchlists.

| Field                     | Description                                                                                            |
| ------------------------- | ------------------------------------------------------------------------------------------------------ |
| **Require AML screening** | When enabled, AML checks are triggered after the customer completes their company and director details |
| **Enable OpenSanctions**  | Use the OpenSanctions database for screening (requires API configuration)                              |
| **Enable Pappers**        | Use the Pappers business registry for screening (France-focused, requires API configuration)           |
| **OpenSanctions dataset** | Specify which dataset to use (default = all datasets)                                                  |
| **Match score threshold** | The minimum match confidence score (0.0–1.0) to flag a potential match (default: 0.7)                  |

**AML check statuses:**

| Status               | Meaning                                                                  |
| -------------------- | ------------------------------------------------------------------------ |
| **Not started**      | Checks haven't been triggered yet                                        |
| **In progress**      | Screening is running                                                     |
| **Clear**            | No matches found — customer can proceed                                  |
| **Under review**     | Potential match detected — requires manual review by an administrator    |
| **Match found**      | Confirmed match against a sanctions list — customer must contact support |
| **Error**            | Processing error — customer should review details or contact support     |
| **Manually cleared** | An administrator has manually approved the customer despite a match      |

<Warning>
  AML checks must pass (status: Clear or Manually Cleared) before identity verification is triggered. If AML checks fail, the customer can return to the personal details step to correct director information.
</Warning>

#### Contract activation

| Field                                       | Description                                                                                                              |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Keep contracts paused until checks pass** | When enabled, contracts remain in a paused state until all required checks (address, ID, AML) are successfully completed |

#### Custom onboarding form

| Field                           | Description                                                                              |
| ------------------------------- | ---------------------------------------------------------------------------------------- |
| **Send custom onboarding form** | When enabled, a custom form is emailed to the customer as part of the onboarding process |
| **Select form**                 | Choose a form page from your Content → Form Pages list                                   |

### Virtual office delivery handling

Virtual office customers can choose how their mail and deliveries are handled. You can configure which handling options are available for each delivery type and link products to charge for those services.

#### Delivery categories

Configure handling options separately for:

* **Mail** — letters and small envelopes
* **Parcels** — packages and large items
* **Checks** — checks and payment documents
* **Publicity** — marketing materials and unsolicited mail

#### Handling options

| Option                                | Available for           | Description                                                                      |
| ------------------------------------- | ----------------------- | -------------------------------------------------------------------------------- |
| **Store for collection**              | All types               | Hold the item for the customer to collect in person                              |
| **Forward**                           | All types               | Send the item to a forwarding address                                            |
| **Open, scan & forward**              | Mail, Checks, Publicity | Open, scan to PDF, and email the scan to the customer, then forward the original |
| **Open, scan & recycle**              | Mail, Publicity         | Open, scan to PDF, email the scan, then dispose of the original                  |
| **Open, scan & shred**                | Mail, Publicity         | Open, scan to PDF, email the scan, then securely shred the original              |
| **Open, scan & store for collection** | Mail, Checks, Publicity | Open, scan to PDF, email the scan, and hold the original for collection          |
| **Recycle**                           | Mail, Publicity         | Dispose of the item without opening                                              |
| **Return to sender**                  | All types               | Send the item back to the sender                                                 |
| **Shred**                             | Mail, Publicity         | Securely destroy the item without opening                                        |
| **Deposit a check**                   | Checks only             | Deposit the check into the customer's bank account                               |

#### Charges linked to handling actions

You can link products to specific handling actions. When a customer selects that handling option for an item, the linked product is automatically added to their account.

| Action               | Product link                                      |
| -------------------- | ------------------------------------------------- |
| **Forward**          | Charge for forwarding postage and handling        |
| **Shred**            | Charge for secure shredding                       |
| **Recycle**          | Charge for disposal                               |
| **Scan**             | Charge for scanning and digitization              |
| **Return to sender** | Charge for return postage                         |
| **Deposit a check**  | Charge for check deposit processing               |
| **Store**            | Charge for storage beyond the free storage period |
| **Collect**          | Charge when the customer collects the item        |

| Field                     | Description                                                                                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Max free storage days** | Number of days an item can be stored for collection without charge. After this, the "Store" product is charged per day or period. |

#### Contact limits

You can restrict how many company aliases, recipients, and forwarding addresses a virtual office customer can register.

| Field                          | Description                                                         |
| ------------------------------ | ------------------------------------------------------------------- |
| **Company aliases limit**      | Maximum number of company names the customer can receive mail under |
| **Recipients limit**           | Maximum number of individuals who can receive mail at this address  |
| **Forwarding addresses limit** | Maximum number of addresses the customer can forward mail to        |

***

## Legal

The **Legal** tab lets you attach terms and conditions to the plan. Customers must accept these terms when signing up.

| Field                    | Description                                                                                                   |
| ------------------------ | ------------------------------------------------------------------------------------------------------------- |
| **Terms and conditions** | The legal terms the customer agrees to when signing the contract. Supports Markdown formatting.               |
| **Version history**      | A read-only log of all changes made to the terms and conditions, including timestamps and who made the change |

<Tip>
  Use the version history to track changes to your legal terms over time and prove which version a customer agreed to when they signed up.
</Tip>

***

## Best practices

* **Use descriptive names** — customers see these in the portal, so make plan names clear (e.g., "Full-time Hot Desk – 24/7 Access" instead of "Plan A").
* **Set prorating consistently** — if you bill monthly, set **First invoice prorated discount** to 30 days and enable **Last invoice prorated discount** for fair billing.
* **Use fixed billing days** for easier accounting — all customers are billed on the same day, simplifying cash flow tracking.
* **Enable minimum price** for usage-based plans to ensure baseline revenue.
* **Link deposits to plans** instead of adding them manually — sign-up fees and key deposits should be configured on the plan so they're automatic.
* **Use plan components** for bundled add-ons (parking, lockers) instead of separate products.
* **Set minimum contract terms** to reduce churn — require customers to commit for a minimum period (e.g., 3 months).
* **Enable cancellation notice periods** to give yourself time to fill vacancies.
* **Test virtual office onboarding** thoroughly before launching — the compliance requirements can be complex.
* **Configure delivery handling charges** carefully — some handling options (forwarding, scanning) incur real costs that should be passed to customers.

***

## Related pages

<CardGroup>
  <Card title="Products" icon="box" href="/platform/billing/products">
    Create products to use as sign-up fees, deposits, or plan components.
  </Card>

  <Card title="Contracts" icon="file-signature" href="/platform/finance/contracts">
    Manage customer contracts linked to plans.
  </Card>

  <Card title="Resources" icon="door-open" href="/platform/billing/resources">
    Configure resources and link them to plans via access rules.
  </Card>

  <Card title="Virtual Office Onboarding" icon="building" href="/member-portal/virtual-office/onboarding">
    The customer-facing onboarding flow for virtual office members.
  </Card>
</CardGroup>


# Products
Source: https://learn.nexudus.com/platform/billing/products

How to create and manage products in Nexudus — one-off items, recurring add-ons, booking extras, and benefit bundles.

## Overview

**Products** are items or services you sell to your customers. They are versatile and can be sold in several ways:

* As a **one-off purchase** from the members portal or shop
* As a **recurring add-on** included in a contract alongside a plan
* As a **booking extra** linked to a resource (e.g., catering for a meeting room)
* As a **deposit or sign-up fee** in a contract or proposal
* Bundled with **benefits** like time credits, passes, or money credits

Products can represent anything you charge for — from coffee and printing to day passes and equipment rental.

## How to access

Navigate to **Inventory → Products**.

<Note>
  Requires the **product** role.
</Note>

***

## Product kinds

Every product has a **kind** that classifies what it represents. The kind is a label for your own organisation — it does not change how the product works.

| Kind                 | Typical use                                                |
| -------------------- | ---------------------------------------------------------- |
| **Day pass**         | A pass granting access for a set period                    |
| **Credit bundle**    | A package of booking credits                               |
| **Stationery**       | Office supplies                                            |
| **Booking feature**  | A feature added to a booking (e.g., video conferencing)    |
| **Booking products** | An item sold alongside a resource booking (e.g., catering) |
| **Lockers**          | Locker rental                                              |
| **Equipment**        | Physical assets (desks, monitors, IT hardware)             |
| **Event services**   | Items sold as part of events                               |
| **Admin services**   | Administrative services                                    |
| **Food & Beverage**  | Café, vending, or catering items                           |
| **Other services**   | Anything else                                              |

***

## Creating a product

<Steps>
  <Step title="Navigate to Products">
    Go to **Inventory → Products** and click the "+" button.
  </Step>

  <Step title="Enter product details">
    Fill in the required fields:

    * **Product name** — a clear name shown to customers
    * **Product kind** — select the category that best fits
    * **Product description** — describe what the customer is getting
    * **Unit price** — the price charged per unit
  </Step>

  <Step title="Configure portal display">
    Set how the product appears in the members portal:

    * **Display on website/App** — whether customers can see and purchase it
    * **Category** — a tag for grouping products in the shop (e.g., "Food", "Printing")
    * **Display position** — the sort order in the shop
    * Upload a **product image** if desired
  </Step>

  <Step title="Save">
    Click **Save** to create the product. Additional tabs become available for configuring benefits, availability, and integrations.
  </Step>
</Steps>

***

## Product details

### General fields

| Field                     | Description                                                                                         |
| ------------------------- | --------------------------------------------------------------------------------------------------- |
| **Product name**          | The name displayed to customers and on invoices                                                     |
| **Product kind**          | A classification label (does not affect functionality)                                              |
| **Product description**   | A longer description shown in the members portal                                                    |
| **Unit price**            | The amount charged per unit, in your selected currency                                              |
| **Prorate with contract** | When enabled, the price is pro-rated based on how far through the billing cycle the purchase occurs |

### Portal and apps

| Field                      | Description                                               |
| -------------------------- | --------------------------------------------------------- |
| **Product image**          | An image shown in the members portal shop                 |
| **Display on website/App** | Whether the product is visible to customers in the portal |
| **Category**               | A tag used to group products in the shop view             |
| **Display position**       | Controls the sort order when multiple products are listed |

### Purchase links

Once saved, each product gets two shareable links:

| Link                                 | Purpose                                                          |
| ------------------------------------ | ---------------------------------------------------------------- |
| **Purchase link (new customers)**    | Takes new visitors through sign-up then directly to this product |
| **Invite link (existing customers)** | Takes logged-in customers directly to this product in the shop   |

### Invoice the purchasing customer

When enabled, the product charge is always invoiced directly to the customer who purchased it — even if they belong to a team where another member normally pays. Use this for personal items that should not be billed to the team.

### Financial details

These fields appear when your location requires financial accounts or tax rates:

| Field                 | Description                                                                    |
| --------------------- | ------------------------------------------------------------------------------ |
| **Financial account** | The accounting category for this product (syncs with your accounting software) |
| **Tax rate**          | The tax rate applied to this product                                           |

### AI agent settings

Control how AI agents in the members portal can recommend or sell this product:

| Field                      | Description                                                                |
| -------------------------- | -------------------------------------------------------------------------- |
| **Available to AI agents** | Whether the AI assistant can suggest this product to customers             |
| **Notes for AI agents**    | Instructions or context for the AI about when to recommend this product    |
| **Show price for AI**      | Whether the AI should mention the price when recommending                  |
| **Price for AI**           | An alternative price shown by the AI (if blank, the regular price is used) |

***

## Benefits

The Benefits tab lets you bundle credits, passes, and allowances with a product. When a customer purchases the product, these benefits are activated automatically.

| Benefit type        | What it provides                                             |
| ------------------- | ------------------------------------------------------------ |
| **Money credit**    | A monetary credit applied to the customer's booking balance  |
| **Time credit**     | An allowance of booking time for specific resource types     |
| **Passes**          | One or more passes granting time-limited access to the space |
| **Printing credit** | An allowance for printing services                           |

Benefits are multiplied by the purchase quantity. For example, if a product includes 2 passes and the customer buys 3 units, they receive 6 passes.

<Tip>
  Use benefit bundles to create "credit packs" — for example, a product that gives 10 hours of meeting room credit when purchased.
</Tip>

***

## Availability

### Purchase type

Controls how the product can be sold:

| Option                                                   | Meaning                                                             |
| -------------------------------------------------------- | ------------------------------------------------------------------- |
| **Both as a one-off purchase or as an add-on to a plan** | Can be bought directly from the shop and also included in contracts |
| **Only as an add-on to a plan**                          | Can only be added to a contract — not available in the shop         |
| **Only as a one-off purchase**                           | Can only be bought directly — cannot be added to a contract         |

### Purchasable by

Restrict who can buy this product:

| Option            | Who can purchase                          |
| ----------------- | ----------------------------------------- |
| **All customers** | Anyone (members and contacts)             |
| **Members only**  | Only customers with an active contract    |
| **Contacts only** | Only customers without an active contract |

When set to **Members only**, you can further restrict to customers on specific plans.

### Stock management

| Field                      | Description                                                  |
| -------------------------- | ------------------------------------------------------------ |
| **Monitor stock levels**   | Enables stock tracking for this product                      |
| **Prevent negative stock** | Stops purchases when stock reaches zero                      |
| **Stock alert threshold**  | You receive a notification when stock drops below this level |
| **SKU**                    | A unique internal reference code for inventory tracking      |

***

## Integrations

| Integration     | Description                                               |
| --------------- | --------------------------------------------------------- |
| **Square ePOS** | Syncs this product to your Square point-of-sale inventory |
| **NexKiosk**    | Makes this product available on your self-service kiosk   |

***

## How products connect to other features

### Products in contracts

Products can be added to a customer's contract as recurring charges. The product is invoiced each billing cycle alongside the plan fee. This is configured from the contract page, not from the product itself.

### Products linked to resources

Products can be linked to resources as booking add-ons. When a customer books that resource, they can optionally add the linked product (e.g., adding catering to a meeting room booking). This is configured from the resource page.

### Products in proposals

Products can be included in sales proposals as line items, representing sign-up fees, deposits, or other costs.

***

## Webhooks

| Event                        | Triggered when                        |
| ---------------------------- | ------------------------------------- |
| **Product purchased**        | A customer buys a product             |
| **Product purchase updated** | A product purchase record is modified |
| **Product purchase deleted** | A product purchase is removed         |

***

## Best practices

* **Use descriptive names and images** — customers see these in the portal shop, so make them clear and appealing.
* **Set up categories** consistently — use the same tags (e.g., "Food & Beverage", "Office supplies") across products for a clean shop layout.
* **Use stock tracking** for physical items to avoid overselling and get alerts when you need to reorder.
* **Use "Members only" restrictions** to create exclusive products available only to customers on certain plans.
* **Bundle benefits** to create compelling credit packs or day pass packages that customers can self-purchase.
* **Enable pro-rating** for recurring contract add-ons so customers joining mid-cycle are charged fairly.
* **Use the "Invoice the purchasing customer" option** for personal items in team billing scenarios (e.g., food, personal printing) so the cost stays with the buyer.

***

## Related pages

<CardGroup>
  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Create membership plans that can include products as recurring add-ons.
  </Card>

  <Card title="Resources" icon="door-open" href="/platform/billing/resources">
    Link products to resources as booking extras.
  </Card>

  <Card title="Time credits" icon="coins" href="/platform/billing/time-credits">
    Configure time credit allowances that can be bundled with products.
  </Card>

  <Card title="Contracts" icon="file-signature" href="/platform/finance/contracts">
    Add products to customer contracts as recurring charges.
  </Card>
</CardGroup>


# Resource Rates
Source: https://learn.nexudus.com/platform/billing/resource-rates

How to configure pricing rules for your meeting rooms, desks, and other bookable resources.

## Overview

**Resource rates** (also called booking rates) define how your bookable resources — such as meeting rooms, hot desks, and conference facilities — are priced when customers make reservations.

<Important>
  Resource rates are assigned to **resource types**, not individual resources. This means all resources of the same type (e.g., all "Meeting Rooms" or all "Hot Desks") share the same rate. You must create resource types before setting up rates for them.
</Important>

Resource rates give you flexible control over pricing by letting you:

* Set different prices for **members** vs **contacts** (non-members)
* Create **time-based pricing** — hourly, daily, weekly, or monthly rates
* Apply **minimum and maximum booking durations** to each rate
* Set **fixed-cost tiers** — a flat price for bookings up to a certain length, then a different rate
* Restrict rates to **specific time windows** (e.g., business hours only)
* Apply **date range restrictions** (e.g., seasonal pricing)
* Configure **dynamic pricing** based on demand levels and last-minute bookings
* Set a **price cap** to maximum charges
* Create **printing credit** allowances separate from booking time

A single resource type can have multiple resource rates — for example, one rate per charge period (hourly, half-day, full-day) or one rate per customer segment.

<Note>
  Requires the **resource rate** role.
</Note>

***

## Creating a resource rate

<Note>
  You must create **resource types** before setting up resource rates. Rates are assigned to resource types, so all resources of that type will use the same rate. Manage resource types at [Resource Types](https://dashboard.nexudus.com/billing/resourceTypes).
</Note>

<Steps>
  <Step title="Navigate to Resource rates">
    Go to [Resource rates](https://dashboard.nexudus.com/billing/extraServices) and click the **+ Add rate** button.
  </Step>

  <Step title="Enter rate details">
    Fill in the required fields:

    * **Name** — a clear name for this rate (e.g., "Hourly meeting room — members")
    * **Price** — the amount charged per charge period
    * **Charge period** — how the price is measured (hourly, daily, weekly, monthly, or uses)
    * **Resource types** — select which resource types this rate applies to (must be created first)
  </Step>

  <Step title="Configure pricing rules">
    Set any additional pricing restrictions as needed:

    * **Minimum/maximum length** — restrict booking durations
    * **Fixed-cost pricing** — set a flat rate for bookings up to a certain length
    * **Time restrictions** — limit when bookings can use this rate
    * **Date range** — set start and end dates for the rate
  </Step>

  <Step title="Set customer restrictions">
    Choose who can use this rate:

    * **Members only** — available to customers with an active contract
    * **Contacts only** — available to customers without an active contract
    * **Charge visitors** — apply the charge to visitor bookings
  </Step>

  <Step title="Save">
    Click **Save** to create the rate.
  </Step>
</Steps>

***

## Rate fields explained

### General fields

| Field                  | Description                                                           |
| ---------------------- | --------------------------------------------------------------------- |
| **Name**               | A clear name for this rate, used internally and shown to customers    |
| **Description**        | Optional description for your own reference                           |
| **Invoice display as** | Custom text shown on invoices instead of the rate name                |
| **Visible**            | Whether the rate appears on the members portal and app (default: yes) |
| **Display order**      | Controls the sort order when multiple rates are available             |

### Pricing fields

| Field                 | Description                                                                                                                                            |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Price**             | The amount charged per charge period                                                                                                                   |
| **Charge period**     | How the price is measured. Options: **every hour**, **every day**, **every week**, **every calendar month**, **every 4 weeks month**, or **every use** |
| **Currency**          | The currency the price is in                                                                                                                           |
| **Credit price**      | An alternative price when the customer pays using credits instead of cash                                                                              |
| **Maximum price**     | A cap on the total charge — the booking will never exceed this amount                                                                                  |
| **Per-night pricing** | When enabled, the price is charged per night for overnight bookings                                                                                    |

### Booking length restrictions

| Field                 | Description                                                          |
| --------------------- | -------------------------------------------------------------------- |
| **Minimum length**    | Bookings must be at least this many minutes long to use this rate    |
| **Maximum length**    | Bookings cannot exceed this many minutes for this rate               |
| **Fixed cost length** | Bookings up to this many minutes are charged at the fixed cost price |
| **Fixed cost price**  | A flat price applied to bookings up to the fixed cost length         |

<Tip>
  **Fixed cost pricing** is useful for creating tiered pricing. For example: $10 for the first 60 minutes, then $8 per additional hour.
</Tip>

### Time and date restrictions

| Field                           | Description                                                            |
| ------------------------------- | ---------------------------------------------------------------------- |
| **From time**                   | Bookings must start at or after this time (minutes from midnight)      |
| **To time**                     | Bookings must start before this time (minutes from midnight)           |
| **Apply from**                  | This rate only applies to bookings on or after this date               |
| **Apply to**                    | This rate only applies to bookings before this date                    |
| **Only within available times** | The rate only applies during the resource's configured available hours |

### Customer restrictions

| Field                        | Description                                                         |
| ---------------------------- | ------------------------------------------------------------------- |
| **Only for members**         | This rate is available only to customers with an active contract    |
| **Only for contacts**        | This rate is available only to customers without an active contract |
| **Apply charge to visitors** | The charge applies when visitors book the resource                  |

### Tax and financial fields

| Field                 | Description                                      |
| --------------------- | ------------------------------------------------ |
| **Tax rate**          | The tax rate applied to bookings using this rate |
| **Reduced tax rate**  | An alternative reduced tax rate                  |
| **Exempt tax rate**   | Mark the rate as tax-exempt                      |
| **Financial account** | The accounting category for this rate's revenue  |

### Tariff associations

| Field       | Description                                                                  |
| ----------- | ---------------------------------------------------------------------------- |
| **Tariffs** | Link this rate to specific membership plans (tariffs) for plan-based pricing |

***

## Setting up hourly, half-day, and full-day pricing

For time-based pricing, set the **Charge period** to **every hour** and enter the price for 60 minutes. The system interprets a charge period of "every hour" as hourly billing.

We recommend setting up pricing with separate rates for different booking durations. This gives customers clear pricing options and ensures fair charges for longer bookings.

### Recommended setup: Hourly + Half-Day + Full-Day rates

**Step 1: Create the hourly rate (up to 4 hours)**

This rate applies to short bookings of 4 hours or less.

| Field              | Value                                   |
| ------------------ | --------------------------------------- |
| **Name**           | "Meeting room — hourly (up to 4 hours)" |
| **Charge period**  | every hour                              |
| **Price**          | `50` (price per hour)                   |
| **Maximum length** | `240` (maximum 4 hours)                 |
| **Maximum price**  | `200` (4 hours × \$50)                  |

**Step 2: Create the hourly rate for longer bookings (4+ hours)**

This rate applies to bookings longer than 4 hours and uses the full-day rate.

| Field              | Value                                |
| ------------------ | ------------------------------------ |
| **Name**           | "Meeting room — full day (4+ hours)" |
| **Charge period**  | every hour                           |
| **Price**          | `200` (full-day rate)                |
| **Minimum length** | `240` (minimum 4 hours)              |
| **Maximum price**  | `200` (capped at full-day rate)      |

This setup ensures that:

* Bookings of 1–4 hours are charged at the hourly rate (\$50/hour)
* Bookings of 4+ hours are charged at the flat full-day rate (\$200)
* A 5-hour booking costs the same as a 4-hour booking (\$200), giving customers better value for longer bookings

<Tip>
  **Adjusting the half-day rate:** If your half-day rate is different from 4 × hourly rate, set a **Maximum price** on the hourly rate to cap it. For example, if your half-day rate is $180 (not $200), set the maximum price on the hourly rate to `180` for bookings of 4 hours.
</Tip>

### Alternative: Separate half-day rate

If you want to offer a distinct half-day rate that's different from 4 × hourly, create a third rate:

| Field              | Value                           |
| ------------------ | ------------------------------- |
| **Name**           | "Meeting room — half day"       |
| **Charge period**  | every hour                      |
| **Price**          | `180` (half-day rate)           |
| **Minimum length** | `120` (minimum 2 hours)         |
| **Maximum length** | `240` (maximum 4 hours)         |
| **Maximum price**  | `180` (capped at half-day rate) |

In this case, the system will automatically apply the most appropriate rate based on booking length:

* 1–2 hours: Hourly rate
* 2–4 hours: Half-day rate (capped at \$180)
* 4+ hours: Full-day rate (\$200)

<Important>
  When multiple rates apply to a single booking, the system always selects the **cheapest rate** for the customer. This ensures customers always get the best available price.
</Important>

***

## Setting up dynamic pricing

Resource rates support **dynamic pricing** based on demand levels and last-minute bookings. This allows you to charge more during peak times and less during low-demand periods.

### Demand-based pricing

| Field                             | Description                                                                   |
| --------------------------------- | ----------------------------------------------------------------------------- |
| **Price factor — low demand**     | Multiplier applied during low-demand periods (e.g., `0.8` for 20% discount)   |
| **Price factor — average demand** | Multiplier applied during average-demand periods                              |
| **Price factor — high demand**    | Multiplier applied during high-demand periods (e.g., `1.5` for 50% surcharge) |

A price factor of `1.0` means no change to the base price. Values below `1.0` reduce the price; values above `1.0` increase it.

### Last-minute pricing

| Field                           | Description                                                                               |
| ------------------------------- | ----------------------------------------------------------------------------------------- |
| **Price factor — last minute**  | Multiplier applied to last-minute bookings                                                |
| **Last-minute period**          | Bookings made within this many minutes before the reservation trigger last-minute pricing |
| **Last-minute adjustment type** | How the discount is applied — disabled, fixed amount, or gradual reduction                |

<Tip>
  Dynamic pricing works best when combined with your resource's availability settings. Configure available times from the resource page to define peak and off-peak periods.
</Tip>

***

## How resources, resource types, and rates work together

Understanding the relationship between resources, resource types, and resource rates is key to setting up pricing correctly:

| Component         | Description                                         | Example                                          |
| ----------------- | --------------------------------------------------- | ------------------------------------------------ |
| **Resource**      | A specific bookable item (e.g., "Meeting Room 101") | Individual desks, rooms, or facilities           |
| **Resource Type** | A category that groups similar resources            | "Meeting Rooms", "Hot Desks", "Conference Rooms" |
| **Resource Rate** | A pricing rule assigned to a resource type          | "$50/hour for members", "$75/hour for contacts"  |

**How it works:**

1. You create **resource types** to group similar resources together
2. You assign **resource rates** to those resource types
3. When a customer books any resource of that type, the assigned rate(s) apply

This means you only need to set up pricing once per resource type — not for each individual resource. For example, if you have 10 meeting rooms, you create one "Meeting Rooms" resource type and set up your rates once. All 10 rooms automatically use those rates.

<Tip>
  **Need different pricing for specific resources?** Create separate resource types. For example, create "Premium Meeting Rooms" and "Standard Meeting Rooms" as separate types, each with their own rates.
</Tip>

***

## Multiple rates per resource type

A single **resource type** can have **multiple resource rates** associated with it. This is common when you want to offer:

* Different rates for different **charge periods** (hourly, half-day, full-day)
* Different rates for **members vs contacts**
* Different rates for **different time windows** (business hours vs evenings/weekends)

When a customer books any resource of that type, the system automatically selects the most appropriate rate based on the booking details and rate restrictions.

<Tip>
  **Remember:** Rates apply to all resources of the same type. If you need different pricing for individual resources (e.g., "Meeting Room A" vs "Meeting Room B"), create separate resource types for each.
</Tip>

<Tip>
  Use the **Default rate** option to specify which rate should be selected when multiple rates match a booking. This ensures predictable pricing when restrictions overlap.
</Tip>

***

## Resource rate list view

The resource rates list displays the following information for each rate:

| Column             | Description                                                                          |
| ------------------ | ------------------------------------------------------------------------------------ |
| **Name**           | The rate name with details about booking length restrictions and time windows        |
| **Resource types** | Which resource types this rate applies to                                            |
| **Badges**         | Indicators for "Contacts only", "Members only", "Charge visitors", or "Default rate" |
| **Price**          | The monetary price with currency and charge period                                   |
| **Credit price**   | If configured, shows the credit-based alternative price                              |
| **Fixed cost**     | If configured, shows the fixed-cost tier pricing                                     |
| **Maximum price**  | If configured, shows the price cap                                                   |

***

## Best practices

* **Use clear, descriptive names** — rates are shown to customers in the portal, so make them easy to understand (e.g., "Meeting room — hourly — members").
* **Set up multiple charge periods** — offer hourly, half-day, and full-day rates to give customers pricing flexibility.
* **Use minimum/maximum lengths** — prevent very short bookings that aren't worth the administrative overhead.
* **Set default rates** — when you have multiple rates for the same resource type, mark one as default to avoid confusion.
* **Use fixed-cost pricing for tiers** — create attractive bulk pricing (e.g., first 2 hours at one rate, then a lower hourly rate).
* **Apply time restrictions** — avoid customers booking during off-hours at peak rates, or charge premium rates for evenings/weekends.
* **Use date ranges for seasonal pricing** — set up different rates for high season vs low season without deleting old rates.
* **Separate member and contact rates** — offer preferential pricing to members while maintaining higher rates for non-members.
* **Enable dynamic pricing strategically** — use demand-based pricing for popular resources during peak periods.
* **Test rates before going live** — create test bookings to verify rates apply correctly before making them visible to customers.

***

## Related pages

<CardGroup>
  <Card title="Products" icon="shopping-bag" href="/platform/billing/products">
    Create one-off items and services customers can purchase.
  </Card>

  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Set up membership plans that can include resource rate discounts.
  </Card>

  <Card title="Resources" icon="door-open" href="/platform/billing/resources">
    Configure the bookable resources that resource rates apply to.
  </Card>

  <Card title="Resource types" icon="layers" href="/platform/billing/resource-types">
    Group similar resources together for unified pricing.
  </Card>

  <Card title="Time credits" icon="coins" href="/platform/billing/time-credits">
    Configure time credit allowances for resource bookings.
  </Card>

  <Card title="Discount codes" icon="tag" href="/platform/billing/discount-codes">
    Create promotional discounts that can be applied to bookings.
  </Card>
</CardGroup>


# Resources
Source: https://learn.nexudus.com/platform/billing/resources

How to manage bookable spaces and items — meeting rooms, parking, desks, and more — including rates, rules, and limits.

## Overview

**Resources** are physical spaces or items that customers can book through your members portal. Examples include meeting rooms, hot desks, parking spaces, coliving rooms, recording studios, or equipment.

Each resource has its own name, description, photo, and location. You define how customers can book it, how much they pay, and what rules apply.

## How to access

Navigate to **Inventory → Resources** or use the direct link: [Manage resources](https://dashboard.nexudus.com/billing/resources).

<Tip>
  Requires the **resource** role.
</Tip>

***

## Resource kinds

Every resource has a **kind** (`eResourceType`) that determines its core booking behaviour. Choose the kind that best matches what you are adding.

| Kind                | ID   | Description                                            |
| ------------------- | ---- | ------------------------------------------------------ |
| **Meeting room**    | `1`  | A room for meetings, events, or collaborations         |
| **Hot-Desk**        | `2`  | An open-area desk that customers can book by time slot |
| **Day office**      | `3`  | A private office for daily use                         |
| **Event space**     | `4`  | A venue for events and gatherings                      |
| **Lab**             | `5`  | A laboratory or workshop space                         |
| **Kitchen**         | `6`  | A kitchen or food preparation area                     |
| **Treatment room**  | `7`  | A room for wellness or treatment services              |
| **Storage unit**    | `9`  | A storage space or locker                              |
| **Machine**         | `10` | Equipment or machinery that can be booked              |
| **Day pass**        | `11` | A pass granting access to the space for a day          |
| **Phone booth**     | `12` | A private booth for phone calls                        |
| **Studio**          | `13` | A recording or creative studio                         |
| **Car park**        | `14` | A parking space                                        |
| **Other resources** | `99` | Any resource that doesn't fit the categories above     |

### When to use each kind

* Use **Meeting room** for any enclosed room with a booking calendar.
* Use **Hot-Desk** for open-area desks where customers pick a spot within a time window.
* Use **Day office** for private offices that can be booked daily.
* Use **Event space** for venues hosting events or gatherings.
* Use **Lab** for laboratory or workshop spaces.
* Use **Kitchen** for kitchen or food preparation areas.
* Use **Treatment room** for wellness or treatment services.
* Use **Storage unit** for lockers or storage spaces.
* Use **Machine** for equipment or machinery that can be booked.
* Use **Day pass** for passes granting access to the space for a day.
* Use **Phone booth** for private phone call booths.
* Use **Studio** for recording or creative studios.
* Use **Car park** for parking spaces.
* Use **Other resources** for anything that doesn't fit the categories above.

***

## Resource types

A **resource type** is a grouping label that determines which rates apply to a resource. All resources of the same type share the same set of prices.

For example, you might create separate resource types for "Meeting Rooms" and "Parking" so each category can have its own pricing structure.

### Creating a resource type

<Steps>
  <Step title="Navigate to Resource Types">
    Go to **Inventory → Resource Types** and click the "+" button.
  </Step>

  <Step title="Enter the name">
    Type a descriptive name such as "Meeting Rooms" or "Parking".
  </Step>

  <Step title="Save">
    Click **Save** to create the resource type.
  </Step>
</Steps>

<Tip>
  Create one resource type per group of resources that share the same pricing structure. You can always rename types later.
</Tip>

***

## Creating a resource

<Steps>
  <Step title="Navigate to Resources">
    Go to **Inventory → Resources** and click the "+" button.
  </Step>

  <Step title="Choose a resource kind">
    Select the kind that best matches the space or item you are adding.
  </Step>

  <Step title="Fill in the resource details">
    Complete the fields on the **Resource details** tab — see the [Resource details](#resource-details) section below.
  </Step>

  <Step title="Configure features and amenities">
    On the **Features** tab, check all the features and amenities the resource offers.
  </Step>

  <Step title="Set limits (optional)">
    On the **Limits** tab, configure booking constraints specific to this resource.
  </Step>

  <Step title="Save">
    Click **Save** to create the resource. Additional tabs become available for configuring rates, rules, and integrations.
  </Step>
</Steps>

***

## Resource details

The **Resource details** tab contains the core information about the resource.

### General fields

| Field             | Description                                                                                                                                |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **Resource name** | The name displayed to customers in the members portal and booking calendar                                                                 |
| **Resource kind** | The type of resource (see [Resource kinds](#resource-kinds) above)                                                                         |
| **Resource type** | The grouping that determines which rates apply. All resources of the same type share the same set of prices                                |
| **Category**      | A free-text tag used to group resources (e.g., "Floor 1", "Main Building")                                                                 |
| **Available at**  | The location where this resource is situated. If you choose a network location, the resource is available at all locations in that network |

### Features and amenities

The **Features** tab lists checkboxes for everything the resource provides. These appear in the members portal so customers know what to expect.

#### Features

| Feature            | Description                                    |
| ------------------ | ---------------------------------------------- |
| **Standing desk**  | The resource includes a standing desk          |
| **Quiet zone**     | The resource is in a quiet area                |
| **Privacy screen** | The resource is surrounded by a privacy screen |
| **Soundproof**     | The resource is in a soundproof room           |
| **Catering**       | The resource offers catering                   |
| **Tea and coffee** | The resource offers tea and coffee             |
| **Drinks**         | The resource offers drinks                     |

#### Amenities

| Amenity                   | Description                                 |
| ------------------------- | ------------------------------------------- |
| **Projector**             | The resource has a projector                |
| **Internet**              | The resource has internet access            |
| **Conference phone**      | The resource has a conference phone         |
| **Standard phone**        | The resource has a standard phone           |
| **Whiteboard**            | The resource has a whiteboard               |
| **Large display**         | The resource has a large display screen     |
| **Video conferencing**    | The resource supports video conferencing    |
| **Dual display screen**   | The resource has dual screens               |
| **Display screen**        | The resource has a display screen           |
| **Wireless presentation** | The resource supports wireless presentation |
| **PA system**             | The resource has a public address system    |
| **Desktop monitor**       | The resource has a desktop monitor          |
| **Flip chart**            | The resource has a flip chart               |
| **Secure storage**        | The resource has secure storage             |
| **CCTV**                  | The resource has CCTV coverage              |
| **Voice recorder**        | The resource has a voice recorder           |
| **Air conditioning**      | The resource has air conditioning           |
| **Heating**               | The resource has heating                    |
| **Natural light**         | The resource has natural light              |
| **Wireless charger**      | The resource has a wireless charger         |

### Web portal and members app

| Field                                        | Description                                                                                                                    |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **Display on website/App**                   | Whether the resource appears in the members portal and mobile app                                                              |
| **Display in administration panel calendar** | Whether the resource appears on the admin booking calendar (unchecked by default)                                              |
| **Resource details**                         | A rich-text description shown to customers in the members portal                                                               |
| **Email confirmation details**               | Text included in the booking confirmation email. Use the `{confirmationContent}` token in your email templates to include this |
| **Photo**                                    | An image of the resource shown in the members portal                                                                           |

Once saved, each resource gets a **Direct link** — a shareable URL that takes customers directly to the booking page for that resource.

### Location

Set the physical **latitude** and **longitude** of the resource using the map picker. This is useful for resources that customers need to find on-site.

***

## Rates

Resources can have any number of rates based on:

* The **type of customer** booking (member or contact)
* The **time of day** the booking starts
* The **day of the week**
* The **duration** of the booking

Rates are managed through **extra services** linked to the resource's type. Each rate defines a price and the conditions under which it applies.

### How rates work

1. Rates are grouped by **resource type** — all resources of the same type share the same rates.
2. Each rate has a **charge period** (minutes, hours, half day, day, week, month) and a **price**.
3. Rates can specify minimum and maximum booking durations they apply to.
4. Rates can be restricted to specific **time slots** (days of the week + start/end times).
5. Rates can apply only to **members** or **contacts**.

### Adding a rate

<Steps>
  <Step title="Open the Rates tab">
    Edit an existing resource and navigate to the **Rates** tab.
  </Step>

  <Step title="Add a new rate">
    Click the "+" button to add a rate.
  </Step>

  <Step title="Configure the rate">
    * **Name** — a label for your own organisation (e.g., "Hourly rate - members")
    * **Unit price** — the amount charged per booking unit
    * **Charge period** — the time unit for the price (minutes, hours, day, week, month)
    * **Min/Max length** — optional booking duration constraints
    * **Time slots** — optional days and times when this rate applies
  </Step>

  <Step title="Save">
    Click **Save** to create the rate.
  </Step>
</Steps>

<Tip>
  Create separate rates for members and contacts if you offer different pricing. You can also create rates for different booking durations — for example, an hourly rate and a daily rate.
</Tip>

***

## Limits

The **Limits** tab defines booking constraints specific to this resource. These apply in addition to any global limits set at the location level.

### General limits

| Limit                            | Description                                                                                               |
| -------------------------------- | --------------------------------------------------------------------------------------------------------- |
| **Allow multiple bookings**      | Whether multiple customers can book this resource at the same time (e.g., for a room with multiple desks) |
| **Allocation**                   | The maximum number of customers allowed per booking                                                       |
| **Limit visitors to allocation** | Whether the number of visitors is limited by the allocation                                               |

### Booking time limits

| Limit                       | Description                                                                          |
| --------------------------- | ------------------------------------------------------------------------------------ |
| **Book in advance limit**   | Maximum number of days in advance a customer can book                                |
| **Late booking limit**      | Minimum number of hours before the booking start time that a reservation can be made |
| **Late cancellation limit** | Minimum number of hours before the booking start time that a cancellation is allowed |
| **Min booking length**      | Minimum duration of a booking (in minutes)                                           |
| **Max booking length**      | Maximum duration of a booking (in minutes)                                           |
| **Interval limit**          | Minimum minutes between consecutive bookings for this resource                       |

### Cancellation fees

| Field                           | Description                                                                     |
| ------------------------------- | ------------------------------------------------------------------------------- |
| **Charge cancellation fee**     | Whether to charge a fee for late cancellations or no-shows                      |
| **Cancellation fee amount**     | A fixed fee amount (if using absolute fees)                                     |
| **Cancellation fee percentage** | A percentage of the booking price (if using percentage fees)                    |
| **Cancellation fee type**       | Choose between **Absolute** (fixed amount) or **Percentage** (of booking price) |
| **Cancellation fee product**    | Link to a product that represents the cancellation fee                          |

### No return policy

A no-return policy means the booking time is not refunded if cancelled.

| Field                                  | Description                               |
| -------------------------------------- | ----------------------------------------- |
| **No return policy**                   | Apply a no-return policy to this resource |
| **No return policy for all resources** | Apply no-return to all resources          |
| **No return policy for all users**     | Apply no-return to all users              |

### Shifts (Hot Desks)

For hot desk resources, you can define **shifts** — predefined time blocks such as "Morning" (08:00–13:00) or "Full Day" (08:00–18:00). Customers book a shift rather than a specific time range.

Shift templates are managed at the location level. When shifts are enabled, customers select from the available shifts when booking.

***

## Rules

**Resource rules** let you apply specific booking limits and restrictions to specific customers, teams, or time periods. They are a powerful way to manage access without creating separate resources.

### What resource rules control

* Whether a customer or team can book the resource at all
* How far in advance they can book
* How close to the booking time they can reserve
* How often they can repeat bookings
* Cancellation policies and fees
* No-return policies

### Adding a resource rule

<Steps>
  <Step title="Open the Rules tab">
    Edit an existing resource and navigate to the **Rules** tab.
  </Step>

  <Step title="Add a new rule">
    Click the "+" button to create a rule.
  </Step>

  <Step title="Configure the rule scope">
    * Select which **resources** the rule applies to
    * Select which **location**
    * Choose whether it applies to **members only**, **contacts only**, specific **teams**, or specific **customers**
  </Step>

  <Step title="Set the booking constraints">
    Configure advance booking limits, late booking/cancellation limits, repeat booking limits, and any cancellation fees.
  </Step>

  <Step title="Set the effective period (optional)">
    Define when the rule becomes active using **apply from** and **apply to** dates.
  </Step>

  <Step title="Save">
    Click **Save** to activate the rule.
  </Step>
</Steps>

<Tip>
  Rules are evaluated in order. Place more specific rules above general ones. You can use the **Apply from** and **Apply to** fields to create time-limited rules — for example, different booking rules during peak vs. off-peak hours.
</Tip>

***

## Products

The **Products** tab shows products linked to this resource. Products are items or services sold alongside a resource booking — for example, catering for a meeting room or printing credits for a copy room.

See [Products](/platform/billing/products) for details on managing products.

***

## Integrations

Resources can be connected to external services for enhanced functionality.

### Zoom

Connect a resource to a Zoom account so that every booking automatically includes a Zoom meeting link.

* Each resource must be connected to a **separate Zoom user account** to avoid conflicts when multiple resources are booked simultaneously.
* The Zoom link is included in the booking confirmation email sent to the customer.

<Note>
  You need a licensed Zoom account to use this integration. Connect each resource to a different Zoom user.
</Note>

#### Configuring Zoom

<Steps>
  <Step title="Open the Integrations tab">
    Edit a resource and navigate to the **Integrations** tab.
  </Step>

  <Step title="Connect to Zoom">
    Click **Connect this resource to Zoom** and follow the OAuth flow.
  </Step>

  <Step title="Enable meeting links">
    Check the option to include Zoom meeting links in all bookings for this resource.
  </Step>

  <Step title="Save">
    Click **Save**.
  </Step>
</Steps>

### NexBoard by Nexudus

NexBoard is a digital signage system that displays real-time availability outside each meeting room. Customers can use NexBoard touchscreen panels or iBeacon tiles to book rooms on the spot.

Each resource has two numbers (**iBeacon major** and **iBeacon minor**) that link physical iBeacon tiles to the resource. When a customer taps an iBeacon tile with the Nexudus app, they are taken directly to the booking page for that room.

### Calendar iCal Feeds

Each resource has an iCal feed URL that you can use to sync bookings with external calendar applications like Outlook or Google Calendar. Add the feed URL as a subscribed calendar in your preferred app.

***

## Floor plan desks

For resources that represent physical layouts (like open office areas), you can define individual **desks** or **units** within the resource. This is managed on the **Floor Plan Desks** tab.

Each desk has its own availability and can be booked independently. Floor plans are visualised using the [Floor Plan Editor](/platform/settings/floor-plan-editor).

***

## Inventory assets

The **Inventory Assets** tab lets you track individual physical items within a resource — for example, individual projectors in a meeting room or individual desks in an open office area.

***

## Sensors

The **Sensors** tab links IoT sensors to the resource. Sensor data (temperature, humidity, occupancy, etc.) is displayed in the members portal and can trigger automated actions.

See [Sensors](/platform/access-control/sensors) for details.

***

## Quick reference

| Concept                  | Where to configure   | Purpose                                                |
| ------------------------ | -------------------- | ------------------------------------------------------ |
| **Resource kind**        | During creation      | Determines core booking behaviour                      |
| **Resource type**        | Resource details tab | Groups resources with shared pricing                   |
| **Rates**                | Rates tab            | Prices based on duration, time, customer type          |
| **Limits**               | Limits tab           | Per-resource booking constraints                       |
| **Rules**                | Rules tab            | Access restrictions for specific customers/teams/times |
| **Features & amenities** | Features tab         | What the resource provides                             |
| **Integrations**         | Integrations tab     | Zoom, NexBoard, iCal connections                       |
| **Floor plan desks**     | Floor Plan Desks tab | Individual desks within a resource                     |


# Passes
Source: https://learn.nexudus.com/platform/billing/time-passes

How to create and manage time-based access passes in Nexudus — controlling when and where customers can check in, with pay-as-you-go options.

## Overview

**Passes** (also called time passes) control when customers can check in at your locations. They are time-limited access tokens that grant physical entry, WiFi access, and access control system permissions.

A pass can be:

* Valid for a **single calendar day** (unlimited use that day)
* Valid for a **specific number of minutes** spread across multiple days

Passes can be:

* Included in a plan (customers get them automatically with their contract)
* Sold as standalone products (one-off purchases)
* Assigned automatically via **pay-as-you-go** (charged per session when the customer checks out)

<Note>
  If you have an access control system (Kisi, Salto, Gallagher) or WiFi tracking (IronWiFi) connected to Nexudus, passes control access via these systems as well.
</Note>

## How to access

Navigate to **Inventory → Passes**.

<Note>
  Requires the **timePass** role.
</Note>

***

## Pass types

### Calendar day passes

A calendar day pass is valid for one full calendar day, from the location's cutoff time (e.g., 3:00 AM) until the next cutoff time. Customers can check in and out as many times as they want during that day.

**Use cases:**

* Daily coworking passes
* Single-day event access
* Trial day passes

### Minute-based passes

A minute-based pass is valid for a specific number of minutes that can be used across multiple days. When the customer checks in, minutes start counting down. When they check out, the used time is deducted from the pass.

**Use cases:**

* Hourly coworking packages (e.g., "10 hours")
* Flexible access blocks
* Part-time memberships

<Info>
  For pay-as-you-go pricing, the shortest billable interval is **15 minutes**. If a customer stays 10 minutes, they are charged for 15.
</Info>

***

## Creating a pass

<Steps>
  <Step title="Navigate to Passes">
    Go to **Inventory → Passes** and click the "+" button.
  </Step>

  <Step title="Enter pass details">
    * **Pass name** — a clear name shown to customers
  </Step>

  <Step title="Choose the type">
    Select either:

    * **This pass can be used during a single calendar day** (unlimited use that day)
    * **This pass can be used for up to \[X] minutes** (specify the number of minutes)
  </Step>

  <Step title="Set the price">
    Under the **Pay as you go** tab, set the standard price for the pass.
  </Step>

  <Step title="Configure availability">
    Under the **Availability** tab:

    * Select which locations the pass is valid at
    * Set which customers can use it (all, members only, contacts only, or specific plans)
    * Set the days and hours the pass can be used
  </Step>

  <Step title="Save">
    Click **Save** to create the pass.
  </Step>
</Steps>

***

## Pass details

### General settings

| Field            | Description                                                                                                                                          |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Pass name**    | The name displayed to customers and in the portal                                                                                                    |
| **Available at** | The primary location this pass belongs to. In network mode, you can select a network location to make the pass available across all child locations. |

### Type of pass

| Option           | Description                                                                                                                                   |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| **Calendar day** | Valid for one full day (from cutoff time to next cutoff time). The customer can check in and out unlimited times during that day.             |
| **Minute-based** | Valid for a specific number of minutes (e.g., 60, 120, 480). The customer can use these minutes across multiple check-ins until they run out. |

### Use priority

When a customer has multiple valid passes available at check-in time, the system uses them in order of priority:

| Priority   | When used                       |
| ---------- | ------------------------------- |
| **High**   | Used first                      |
| **Normal** | Used after high-priority passes |
| **Low**    | Used last                       |

<Tip>
  Set pay-as-you-go passes to **Low** priority so included passes (from plans) are used first.
</Tip>

### Network check-in

| Field                                                               | Description                                                                                                                                |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **Allow customers holding this pass to connect to your IT network** | Enables WiFi access control via IronWiFi or similar integrations. When enabled, customers with this pass can connect to your WiFi network. |

### Billing

Passes support the same billing fields as products:

* Currency
* Tax rate
* Financial account

***

## Pay as you go

Pay-as-you-go (PAYG) passes are automatically assigned to customers who check in without a valid pass. The customer is charged when they check out based on how long they stayed.

### Enabling pay-as-you-go

| Field                                        | Description                                                                                                                          |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Automatically sell this pass to contacts** | When enabled, contacts (customers without an active contract) checking in without a valid pass are automatically assigned this pass. |
| **Automatically sell this pass to members**  | When enabled, members (customers with an active contract) checking in without a valid pass are automatically assigned this pass.     |

<Info>
  To use pay-as-you-go, you must also enable the **Pay as you go** option in your location's check-in settings.
</Info>

### Standard price

The standard price is the default cost of the pass. For pay-as-you-go minute-based passes, this price represents the full duration.

**Pricing calculation for minute-based PAYG passes:**

* If a pass includes 60 minutes and costs $20, the price per minute is $20 ÷ 60 = \$0.33
* A customer staying 30 minutes is charged: 30 × $0.33 = $10
* A customer staying 10 minutes is charged for 15 minutes (minimum): 15 × $0.33 = $5

**Pricing for calendar day PAYG passes:**

* The full price is charged regardless of how long the customer stays

### Special prices

You can set different prices for customers on specific plans. For example:

* **Plan A customers**: \$15 for a 60-minute pass
* **Plan B customers**: \$10 for a 60-minute pass
* **All others**: \$20 (standard price)

When a customer on Plan A checks in, they are charged \$15 if they use this pass.

***

## Availability

### Location validity

By default, a pass is valid at the location it belongs to and all its child locations. You can restrict this further:

| Configuration                   | Valid at                                       |
| ------------------------------- | ---------------------------------------------- |
| **No locations selected**       | The pass's home location + all child locations |
| **Specific locations selected** | Only the selected locations                    |

**Example:**

* Your network has 3 locations: London (parent), London East (child), London West (child)
* A pass created under "London" with no specific locations selected → valid at all 3 locations
* A pass created under "London" with only "London East" selected → valid only at London East

<Tip>
  To create a pass valid across multiple networks, create it under a network location (a parent location with child locations). Then select all the child locations you want it to cover.
</Tip>

### Customer restrictions

| Option                        | Who can use the pass                                       |
| ----------------------------- | ---------------------------------------------------------- |
| **All customers**             | Anyone (members and contacts)                              |
| **Members only**              | Only customers with an active contract                     |
| **Contacts only**             | Only customers without an active contract                  |
| **Members on specific plans** | Only customers with active contracts on the selected plans |

### Available times

By default, passes can be used 24/7. You can restrict passes to specific days and hours:

**Example:**

* **Monday–Friday**: 9:00 AM – 6:00 PM
* **Saturday–Sunday**: 10:00 AM – 4:00 PM

When a customer tries to check in outside these hours, the pass is not valid and they cannot enter (unless they have another valid pass).

<Warning>
  Time slot validation is enforced **continuously during the check-in session**. A background process monitors active check-ins and automatically checks out customers when their pass's time window ends. The system then attempts to check them back in with another available pass (if one exists). This applies to both calendar day and minute-based passes.
</Warning>

***

## How passes work with check-ins

### When a customer checks in

1. Nexudus looks for all passes the customer has that:
   * Are valid at the check-in location
   * Can be used by the customer (member/contact/plan restrictions)
   * Are valid at the current date and time (time slot restrictions)
   * Have remaining uses or minutes

2. If multiple passes match:
   * **High priority** passes are used first
   * Then **normal priority**
   * Then **low priority**

3. If no valid pass is found:
   * If pay-as-you-go is enabled for this customer type (member/contact), a PAYG pass is created automatically
   * Otherwise, the check-in is blocked (appears as a **failed check-in**)

### Calendar day pass check-in

* The pass is marked as "used" for that calendar day
* The customer can check in and out unlimited times until the day ends (cutoff time)
* The pass becomes available again the next day (if it has remaining uses)

### Minute-based pass check-in

* A counter starts tracking the customer's time
* When the customer checks out, the used minutes are deducted from the pass
* If the customer stays longer than the pass's minutes, the pass is fully consumed
* If time remains, the pass can be used again on future check-ins

### Automatic checkout

If a location has automatic checkout enabled (e.g., 11:59 PM or after 12 hours), customers are automatically checked out:

* Calendar day passes: no charge (already used for the day)
* Minute-based passes: time up to checkout is deducted
* PAYG passes: customer is invoiced for the full session

***

## How passes work with access control systems

When integrated with physical access control (Kisi, Salto, Gallagher) or WiFi (IronWiFi), passes control hardware access:

| Integration   | How it works                                                                                                                                                                   |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Kisi**      | Each pass is linked to a Kisi group. When a customer has an active pass, they are added to that Kisi group and can unlock doors via the Kisi app or access card.               |
| **Salto**     | Similar to Kisi — passes map to Salto user groups and control door access.                                                                                                     |
| **Gallagher** | Passes map to Gallagher cardholder groups.                                                                                                                                     |
| **IronWiFi**  | When **Allow network check-in** is enabled, customers with valid passes can authenticate to your WiFi network. Access is revoked when the pass expires or runs out of minutes. |

<Note>
  Access control permissions are updated in near real-time. When a pass expires or runs out, the customer loses hardware access within minutes.
</Note>

***

## Pass expiry

Passes can expire in several ways:

| Expiry type          | Description                                                                   |
| -------------------- | ----------------------------------------------------------------------------- |
| **Number of uses**   | Calendar day passes can be limited to X uses (e.g., 5 day pass = 5 check-ins) |
| **Expiry date**      | Passes can have a fixed expiry date (e.g., valid until Dec 31st)              |
| **Minutes consumed** | Minute-based passes expire when all minutes are used up                       |
| **Plan renewal**     | Passes included in a plan expire when the contract is canceled or not renewed |

Expired passes are automatically removed from the customer's account (configurable — can be kept for historical records).

***

## Common use cases

### 1. Day pass for drop-ins

**Configuration:**

* Type: Calendar day
* Price: \$25
* Available times: Monday–Friday, 9 AM – 6 PM
* Pay-as-you-go: Enabled for contacts

**Result:** Visitors can buy or be auto-charged \$25 for a full day of access.

### 2. 10-hour flex pack

**Configuration:**

* Type: 600 minutes (10 hours)
* Price: \$80
* Validity: 30 days from purchase

**Result:** Customers buy a pack and can use it across multiple visits over 30 days.

### 3. Members-only evening pass

**Configuration:**

* Type: Calendar day
* Price: \$10
* Available times: Monday–Friday, 6 PM – 11 PM
* Purchasable by: Members only

**Result:** Existing members can extend their access into evening hours for an additional fee.

### 4. Network-wide pass

**Configuration:**

* Available at: Network location (parent)
* Locations: All child locations selected
* Type: Calendar day

**Result:** Customers can check in at any location in your network using the same pass.

***

## Best practices

* **Set PAYG passes to low priority** so customers exhaust included passes before being charged extra.
* **Use minute-based passes** for flexible part-time arrangements (e.g., "20 hours per month").
* **Restrict PAYG to contacts** if you want members to only use their included passes.
* **Set expiry dates** on purchased passes to encourage usage within a reasonable timeframe.
* **Use special pricing** to reward loyal customers on higher plans with discounted PAYG rates.
* **Configure available times** carefully — if a pass has time restrictions, customers physically cannot access the space outside those hours (if using access control).
* **Test location validity** thoroughly in multi-location setups — ensure passes work at the intended locations before selling them.
* **Use "Allow network check-in"** to control WiFi access separately from physical access.

***

## Related pages

<CardGroup>
  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Include passes in membership plans as benefits.
  </Card>

  <Card title="Products" icon="box" href="/platform/billing/products">
    Bundle passes with products to create pass packages.
  </Card>

  <Card title="Check-ins" icon="right-to-bracket" href="/platform/operations/check-ins">
    Monitor who is checked in and review check-in history.
  </Card>

  <Card title="Access Control" icon="lock" href="/platform/access-control/overview">
    Configure hardware integrations that use passes to control physical access.
  </Card>
</CardGroup>


# Payment Gateways
Source: https://learn.nexudus.com/platform/finance/payment-gateways

Overview of the payment gateway providers available in Nexudus and how to configure them.

## Overview

Nexudus supports multiple payment gateway providers, allowing you to accept payments from your customers through the method that best fits your business needs. You can configure one or more payment gateways to offer flexibility to your customers.

Payment gateways are configured in the Nexudus admin dashboard under **Settings > Billing and payments > Payment methods**.

## Available Payment Gateway Providers

<CardGroup>
  <Card title="Spreedly" icon="credit-card" href="/platform/finance/payment-gateways/spreedly">
    A payment gateway aggregator that supports multiple underlying providers with built-in tokenization and 3D Secure support.
  </Card>

  <Card title="Stripe Checkout" icon="credit-card" href="/platform/finance/payment-gateways/stripe-checkout">
    Redirect customers to a Stripe-hosted payment page for secure card payments with support for recurring billing.
  </Card>

  <Card title="GoCardless" icon="bank" href="/platform/finance/payment-gateways/gocardless">
    Direct debit payments from customer bank accounts with support for recurring subscriptions.
  </Card>

  <Card title="PayPal" icon="paypal" href="/platform/finance/payment-gateways/paypal">
    Allow customers to pay using their PayPal account or card via PayPal's secure checkout flow.
  </Card>

  <Card title="Forte" icon="credit-card" href="/platform/finance/payment-gateways/forte">
    ACH bank transfer (eCheck) and credit card payments processed through Forte's payment platform.
  </Card>
</CardGroup>

## How payment gateways work

When a customer checks out in the member portal, the available payment methods are determined by:

1. **Which gateways are enabled** in your location settings
2. **Customer type** — some gateways can be restricted to members or contacts
3. **Transaction amount** — gateways only appear when there is an amount due
4. **Checkout type** — some payment methods are only available for specific checkout flows

Each payment gateway has its own configuration requirements including API keys, credentials, and optional settings for sandbox/testing modes.

## Configuring a payment gateway

To configure a payment gateway:

1. Navigate to **Settings > Billing and payments > Payment methods** in the admin dashboard
2. Find the payment gateway you want to configure from the list of available methods
3. Click on the gateway to open the configuration flyout
4. Fill in the required credentials and settings
5. Toggle the **Enabled** switch to activate the gateway
6. Save your changes

<Note>Most payment gateways offer a sandbox or test mode. Always test your configuration in sandbox mode before enabling live payments.</Note>

## Payment gateway comparison

| Feature            | Spreedly    | Stripe Checkout | GoCardless | PayPal | Forte          |
| ------------------ | ----------- | --------------- | ---------- | ------ | -------------- |
| Card payments      | Yes         | Yes             | No         | Yes    | Yes (optional) |
| ACH / Direct debit | Via gateway | No              | Yes        | No     | Yes            |
| Recurring payments | Yes         | Yes             | Yes        | No     | Yes            |
| 3D Secure          | Yes         | Yes             | No         | No     | No             |
| Refunds            | Yes         | Yes             | Yes        | Yes    | Yes            |
| Sandbox mode       | Yes         | Yes             | Yes        | Yes    | Yes            |

## Troubleshooting

* **Payments not appearing in checkout** — Make sure the gateway is enabled and all required credentials are configured correctly
* **Sandbox payments failing** — Verify you are using sandbox credentials and the sandbox mode toggle is enabled
* **Recurring payments not working** — Ensure the "Enable automatic recurrent payments" option is toggled on for gateways that support it


# Multi-Location Management
Source: https://learn.nexudus.com/platform/multi-location

Learn how to manage multiple coworking spaces from a single Nexudus account, including networks, shared settings, and cross-location features.

## Overview

If you operate more than one coworking space, Nexudus lets you manage all your locations from a single account. You can switch between locations, share plans and products across spaces, and give your members access to multiple sites — all without duplicating configuration.

## Key concepts

### Locations

Each physical space you manage is set up as a separate location in Nexudus. Every location has its own:

* Address and contact details
* Operating hours
* Resources and pricing
* Members Portal (with its own branding and domain)
* Currency and tax settings
* Access control configuration

### Networks

Locations can be grouped into a **network**. A network is a collection of related locations — for example, all spaces belonging to the same brand or managed by the same team. Networks enable:

* Shared plans and products across locations
* Cross-location member access
* Consolidated reporting
* Centralized user management

<Info>
  A customer registered at one location in a network can be granted access to other locations without creating duplicate profiles.
</Info>

## Switching between locations

Use the **location selector** in the Dashboard header to switch between your spaces. When you select a location:

* The sidebar shows data specific to that location (members, bookings, invoices, etc.)
* Reports and analytics reflect the selected location
* New records you create are associated with that location

<Tip>
  Some pages offer a "Network view" that shows aggregated data across all your locations. Look for the network toggle on dashboards and reports.
</Tip>

## Sharing plans and products

You can configure plans and products to be available at a single location or across multiple locations in your network:

* **Single-location plans** — pricing and benefits apply only to one space.
* **Multi-location plans** — members on these plans can book resources or access multiple locations depending on the plan configuration.

This is useful when you want to offer flexible memberships that let members work from any of your spaces.

## Cross-location member access

When a customer is registered at multiple locations (or has a network-wide plan):

* They can book resources at any location included in their plan.
* Their profile and contract history are visible from any location they belong to.
* Billing can be centralized or handled per location, depending on your setup.

### How members appear across locations

* A member at **Location A** who also has access to **Location B** will appear in both locations' member lists.
* Their contract and billing are tied to the location where the contract was created.
* Check-in data and booking history are recorded per location.

## Managing users across locations

Dashboard users (your staff) can be restricted to specific locations:

* A user assigned to **Location A only** will not see data from Location B.
* A user with **network-wide access** can switch between all locations and view combined data.

For details on setting this up, see [Roles and Permissions](/platform/roles-and-permissions).

## Common multi-location scenarios

<Accordion title="Same brand, multiple cities">
  Set up each city as a separate location within one network. Share plans so members can use any city. Use location-specific pricing if costs differ between regions.
</Accordion>

<Accordion title="Different brands under one company">
  Each brand can be a separate location with its own portal branding and domain. Network-level access lets your management team oversee all brands from one account.
</Accordion>

<Accordion title="Single building with multiple floors">
  If floors have different resources and pricing, set each floor as a location. If they share everything, a single location with well-organized resource types may be simpler.
</Accordion>

## Best practices

* **Keep location settings consistent** where possible (operating hours, booking rules) to avoid confusion for members who use multiple spaces.
* **Use network-level plans** for members who need flexibility, and location-specific plans for members who stay at one space.
* **Assign staff to specific locations** unless they need cross-location oversight, to keep their Dashboard focused and relevant.
* **Review your network structure** as you grow — adding a new location to an existing network is straightforward, but planning ahead makes configuration smoother.

## Related pages

<CardGroup>
  <Card title="Roles & Permissions" icon="shield" href="/platform/roles-and-permissions">
    Control what staff can access across locations.
  </Card>

  <Card title="Location Settings" icon="gear" href="/platform/settings/business-settings">
    Configure individual location settings.
  </Card>
</CardGroup>


# Navigating the Dashboard
Source: https://learn.nexudus.com/platform/navigation

Learn how to find your way around the Nexudus Dashboard — sidebar navigation, header tools, search, and quick-create actions.

## Overview

The Nexudus Dashboard is designed to give you quick access to every part of your coworking business. This page explains the main navigation elements so you can find what you need efficiently.

## Sidebar navigation

The left sidebar is your primary way to move between modules. It groups features into logical sections:

* **Operations** — Members, teams, bookings, check-ins, visitors, help desk
* **Billing & Products** — Plans, products, resources, passes, floor plans
* **Finance** — Invoices, contracts, bill runs, payment gateways
* **CRM** — Boards, opportunities, proposals, tasks, documents
* **Content** — Events, articles, courses, newsletters, announcements
* **Access Control** — Check-in methods, integrations, WiFi
* **Settings** — Location settings, users, email templates, integrations
* **Analytics** — Dashboards, reports, business checkup

<Tip>
  The sidebar only shows modules and features that are enabled for your location and that your user role has permission to access.
</Tip>

### Collapsing the sidebar

You can collapse the sidebar to give yourself more screen space when working on forms or viewing reports. Click the collapse icon at the top of the sidebar to toggle between expanded and compact modes.

## Header bar

The header bar at the top of the screen provides:

* **Location selector** — Switch between locations if you manage more than one space. The selected location determines the data shown throughout the Dashboard.
* **Search** — Quickly find customers, bookings, invoices, resources, or any other record by typing a keyword.
* **Quick-create button** — Create new records without navigating away from your current page.
* **Notifications** — View recent alerts, system messages, and activity updates.
* **User menu** — Access your profile, account settings, and sign out.

## Search

The global search in the header lets you find records across all modules. Start typing and results appear instantly, grouped by type (customers, bookings, invoices, etc.).

You can also use search to navigate — type the name of a feature (like "Plans" or "Invoices") and jump directly to that section.

<Info>
  Search results respect your permissions. You only see records you have access to based on your role and location.
</Info>

## Quick-create

The quick-create button (usually a **+** icon in the header) lets you create common records without leaving your current page:

* New customer
* New booking
* New invoice
* New event
* New task

This is useful when you're in the middle of something but need to quickly add a record.

## Contextual actions

Throughout the Dashboard, you'll find contextual action buttons on list and detail pages:

* **List pages** show bulk actions (export, delete, assign) and filters to narrow results.
* **Detail pages** show actions relevant to the current record (edit, duplicate, delete, send email).
* **Tabs** on detail pages let you switch between related information (e.g., a customer's bookings, invoices, and contracts).

## Keyboard shortcuts

The Dashboard supports keyboard shortcuts for common actions:

| Shortcut          | Action                  |
| ----------------- | ----------------------- |
| `/` or `Ctrl + K` | Open global search      |
| `Esc`             | Close modals and panels |

## Tips for efficient navigation

<Steps>
  <Step title="Use search for speed">
    Instead of clicking through menus, use the global search to jump directly to a customer, booking, or page.
  </Step>

  <Step title="Bookmark frequent pages">
    Use your browser's bookmarks for pages you visit daily (like the bookings calendar or invoices list).
  </Step>

  <Step title="Switch locations from the header">
    If you manage multiple locations, the location selector in the header is the fastest way to switch context.
  </Step>
</Steps>

## Next steps

<CardGroup>
  <Card title="Roles & Permissions" icon="shield" href="/platform/roles-and-permissions">
    Learn what each user role can access in the Dashboard.
  </Card>

  <Card title="Multi-Location Management" icon="building" href="/platform/multi-location">
    Manage multiple spaces from a single account.
  </Card>
</CardGroup>


# Bookings
Source: https://learn.nexudus.com/platform/operations/bookings

How to create, manage, and invoice resource bookings in Nexudus — including pricing, credits, products, attendees, and payment workflows.

## Overview

The **Bookings** section lets you manage reservations for your bookable resources — meeting rooms, hot desks, private offices, event spaces, and any other resources you offer. You can create bookings on behalf of customers, track availability in real time, apply pricing rates, use credits, add products (e.g., catering), and manage the full billing lifecycle from charge to invoice.

Bookings integrate with your calendar, access control, and notification systems to provide a complete reservation experience for both operators and customers.

## How to access

Navigate to **Operations → Bookings** in the left sidebar.

<Note>
  Requires the **booking** role.
</Note>

## Key concepts

| Term                  | Meaning                                                                                                                                                   |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Resource**          | A bookable item — meeting room, hot desk, private office, parking space, etc.                                                                             |
| **Resource type**     | A category of resources (e.g., "Meeting rooms", "Hot desks") used to group pricing rates.                                                                 |
| **Rate**              | A pricing rule that determines how much a booking costs. Rates are linked to resource types and can vary by time of day, customer plan, or charge period. |
| **Charge period**     | How a rate calculates cost — by the minute, day, week, month, or per use.                                                                                 |
| **Time credit**       | Pre-paid usage time included in a customer's plan (e.g., "4 hours of meeting room time per month"). Deducted from the booking duration.                   |
| **Money credit**      | A monetary balance that can be used to pay for bookings (e.g., "£50 booking credit per month"). Deducted from the booking cost.                           |
| **Booking product**   | An additional product added to a booking (e.g., projector, catering, whiteboard markers).                                                                 |
| **Tentative booking** | A booking that holds a calendar slot but is not yet confirmed and will not be charged.                                                                    |
| **Booking charge**    | The line item posted to the customer's account representing the cost of the booking.                                                                      |

***

## The booking form

### Tabs

| Tab                 | Contents                                                                      |
| ------------------- | ----------------------------------------------------------------------------- |
| **Booking details** | Resource, time, customer, pricing, repeat options, and availability calendar  |
| **Products**        | Additional products linked to this booking (from the resource's product list) |
| **Attendees**       | Visitors/guests attending this booking                                        |
| **Notes**           | Internal conversation thread about this booking (visible to staff only)       |
| **Charges**         | Posted charges and associated invoices for this booking                       |

***

## Creating a booking

<Steps>
  <Step title="Select a customer (optional)">
    Choose the customer making the booking. If left empty, this is an "anonymous" booking (no billing).
  </Step>

  <Step title="Select a resource">
    Choose the resource to book. Only resources in your current location are shown.
  </Step>

  <Step title="Choose a desk/unit (if applicable)">
    If the resource has a floor plan with individual desks or units, you can select a specific one or leave it on "Automatically assign next available".
  </Step>

  <Step title="Set start and end times">
    Use the date/time pickers or the duration shortcuts (1h, 2h, 4h, 8h). The availability calendar on the right shows existing bookings for that day so you can spot conflicts.
  </Step>

  <Step title="Add customer and internal notes (optional)">
    **Customer notes** are visible to the customer. **Internal notes** are only visible to staff.
  </Step>

  <Step title="Configure pricing">
    The system automatically calculates the best rate. You can override the price, select a specific rate, apply a discount code, or disable credit usage.
  </Step>

  <Step title="Choose billing options">
    * **Calculate cost and post charges now** — posts the charge immediately on save.
    * **Invoice this booking when saved** — creates an invoice immediately.
    * **Invoice this customer directly** — bypasses team merged billing.
  </Step>

  <Step title="Set repeat options (optional)">
    For recurring bookings, configure repetition (daily, weekly, specific days) and an end date.
  </Step>

  <Step title="Save">
    Click **Save**. The booking appears on the calendar and the customer is notified (if configured).
  </Step>
</Steps>

***

## Booking details fields

### Resource and time

| Field                 | Description                                                                               |
| --------------------- | ----------------------------------------------------------------------------------------- |
| **Customer**          | The customer making the booking (optional — leave empty for anonymous bookings)           |
| **Resource**          | The resource being booked (required)                                                      |
| **Desk / unit**       | Specific desk or unit on the resource's floor plan (shown only if the resource has desks) |
| **Start / end times** | Booking start and end in your location's timezone                                         |
| **Tentative**         | Marks the booking as unconfirmed — it holds the slot but won't be charged                 |

### Price and billing

| Field                                       | Description                                                                                                                      |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Price**                                   | The calculated price for the booking. You can override this with a custom amount.                                                |
| **Rate**                                    | The pricing rate used to calculate cost. Defaults to "Best rate available" (cheapest valid rate). You can force a specific rate. |
| **Discount code**                           | A promotional code that reduces the booking price                                                                                |
| **Purchase Order number**                   | A reference number for the customer's purchase order                                                                             |
| **Do not use any available booking credit** | Prevents the system from deducting time or money credit for this booking                                                         |
| **Calculate cost and post charges now**     | Posts the booking charge to the customer's account on save (new bookings only)                                                   |
| **Invoice this booking when saved**         | Creates an invoice for this booking immediately (new bookings only)                                                              |
| **Invoice this customer directly**          | Bills this customer instead of their team's paying member (relevant for merged billing)                                          |

### Repeat booking

| Field                | Description                                            |
| -------------------- | ------------------------------------------------------ |
| **Repeat booking**   | Enable for recurring bookings                          |
| **Repeat every**     | Frequency (e.g., every 1 week)                         |
| **Repeat until**     | End date for the series                                |
| **Days of the week** | Which days the booking repeats on (Mon–Sun checkboxes) |

***

## The price breakdown panel

When a resource and customer are selected, a pricing panel appears showing:

| Line             | Meaning                                                                              |
| ---------------- | ------------------------------------------------------------------------------------ |
| **Base**         | The rate-calculated price before credits or adjustments                              |
| **Products**     | Total cost of any products added to the booking                                      |
| **Dynamic Adj.** | Price adjustment from demand-based or last-minute dynamic pricing (if enabled)       |
| **Credits**      | Amount offset by the customer's available time or money credit (shown as a negative) |
| **Total**        | Final amount to be charged                                                           |

***

## How pricing works

### Rates and resource types

Each resource belongs to a **resource type** (e.g., "Meeting rooms"). Rates are configured per resource type and define how much time in that resource costs. The system finds the cheapest valid rate for the selected resource, customer, and time slot.

A rate specifies:

* **Price** — cost per charge period
* **Charge period** — how cost is calculated: per minute, per day, per week, per month, or per use
* **Resource types** — which resource categories this rate applies to
* **Plans** — optionally restrict the rate to customers on specific plans
* **Time restrictions** — optionally apply only during specific hours
* **Fixed cost** — optionally charge a flat fee for an initial period (e.g., £10 for the first hour, then £5/hour after)

### Charge period logic

| Charge period  | How cost is calculated                                                         |
| -------------- | ------------------------------------------------------------------------------ |
| **Per minute** | Price × (booking duration in minutes ÷ 60). Calculated in 15-minute intervals. |
| **Per day**    | Price × number of days                                                         |
| **Per week**   | Price × number of weeks                                                        |
| **Per month**  | Price × number of months                                                       |
| **Per use**    | A fixed fee regardless of duration                                             |
| **Per night**  | Special variant that counts nights instead of days                             |

The system evaluates all valid rates across charge periods and selects the **cheapest** option for the customer.

<Info>
  If a booking spans more than 24 hours, per-minute pricing is automatically excluded from consideration — only daily, weekly, or monthly rates apply.
</Info>

### Rate selection priority

1. If a specific rate is selected on the booking form, that rate is always used.
2. Otherwise, all valid rates for the resource type, customer plan, and time slot are evaluated.
3. Default rates (marked as "default price") are preferred when multiple rates match.
4. The cheapest valid result wins.

If no valid rate can be found for the combination of resource, customer, and time, the system shows a warning: "We could not find a valid rate for the selected resource, customer and booking times."

***

## Credits

Credits reduce the cost of bookings either by offsetting time (time credit) or money (money credit). Credits are typically included as benefits of a customer's plan.

### Time credit

Time credits represent pre-paid usage hours for a resource type. For example, a plan might include "4 hours of meeting room time per month."

* Measured in the same charge period as the rate (minutes, days, etc.)
* Deducted from the booking duration before calculating the price
* If the booking is shorter than or equal to the available credit, the booking is free
* If the booking exceeds available credit, only the excess is charged

### Money credit

Money credits represent a monetary balance that can be applied to booking costs. For example, "£100 booking credit per month."

* Deducted from the final price after time credit has been applied
* Can be restricted to specific resource types, plans, or passes
* Can optionally be used to pay for booking products too (controlled by the setting "Use available money credit to pay for products")
* If the credit covers the full cost, no invoice is generated
* A separate charge line is created showing the credit offset

### Credit priority

When a booking is charged:

1. **Time credit** is applied first (reduces the number of billable units)
2. **Money credit** is applied second (reduces the monetary cost of remaining units)
3. The remaining balance (if any) is the charge posted to the customer's account

<Warning>
  Credits are consumed **when the booking charge is processed**, not when the booking is placed. Because the system charges bookings up to the earliest credit expiration date (see "When charges are posted" above), a customer with credit expiring on June 15 will have all their bookings through June 15 charged — and credit consumed — as soon as a booking change triggers the charge process (within minutes). This is by design: it ensures credits are used before they expire.

  If "Always calculate price and/or use credit as bookings are requested" is enabled, the system includes credits that may not be fully active yet (e.g., from a future renewal period) when evaluating which credits to consume.
</Warning>

***

## Booking products

You can attach additional products to a booking — items that the customer is ordering alongside the resource reservation (e.g., catering, AV equipment, flip charts).

### How it works

1. Products must first be linked to the resource via **resource products** (configured on the resource detail page).
2. When creating or editing a booking for that resource, the **Products** tab shows available products.
3. Select products and set quantities.
4. Product costs are added to the booking total (shown in the "Products" line of the price panel).
5. When the booking is charged, products are posted as separate line items on the customer's account.

### Product pricing

* Each resource product can have a **custom price** that overrides the product's default price.
* Products can be set to **invoice in minutes** — meaning their cost scales with the booking duration.
* If money credit is available and the "Use credit to pay for booking products" setting is enabled, credit is applied to products as well.

***

## Attendees (booking visitors)

The **Attendees** tab lets you add guests who will attend the booking. Each attendee becomes a visitor record linked to both the booking and the host.

* Attendees receive a visitor code for self-check-in
* If "Send booking confirmation to every guest" is enabled, each attendee receives a confirmation email
* Attendees appear in the Visitors list with a "Booking guest" badge
* The booking host (customer) is shown as the visitor's host

<Tip>
  Adding attendees to bookings creates visitor records automatically. You don't need to create them separately in the Visitors section.
</Tip>

***

## Booking lifecycle and billing

A booking moves through these billing states:

```
Tentative → Confirmed → Charged → Invoiced → Paid
```

### State definitions

| State         | Meaning                                                                  |
| ------------- | ------------------------------------------------------------------------ |
| **Tentative** | Holds a calendar slot. Not charged, not confirmed.                       |
| **Confirmed** | The booking is confirmed but not yet charged.                            |
| **Charged**   | Charges have been posted to the customer's account but not yet invoiced. |
| **Invoiced**  | An invoice has been generated that includes this booking's charges.      |
| **Paid**      | The invoice has been paid.                                               |

### When charges are posted

Booking charges are not simply posted "at invoice renewal." Multiple independent processes determine when a booking is charged, depending on settings and the customer's credit situation.

#### Charge pathways

<AccordionGroup>
  <Accordion title="1. Credit-horizon charging (most common)">
    Triggered **5 minutes after any booking is created, updated, or deleted** for that customer (debounced to once every 15 minutes per customer).

    The system calculates a "horizon" — the **earliest expiration date** among the customer's active time credits and money credits. It then charges **all uncharged bookings** from the past 30 days up to that horizon date, in chronological order.

    **Why?** This ensures credits are consumed before they expire. If a customer has credit expiring on June 15 and makes a booking for June 10, the system charges the June 10 booking immediately so the credit is used while still valid.

    If the customer has no credits, the horizon is "now" — meaning only past bookings get charged.
  </Accordion>

  <Accordion title="2. Recurring background task (every 23 minutes)">
    A background job runs every 23 minutes and finds bookings that are "due for charging." A booking is due when:

    * It ended more than 5 minutes ago, **OR**
    * It ends before the customer's earliest credit expiration date (same horizon logic as above)

    Additionally, it only charges bookings that end before the customer's next invoice date (to avoid charging bookings for a billing period that hasn't been processed yet).

    The system gives up trying to auto-charge a booking after 5 days.
  </Accordion>

  <Accordion title="3. Up-front payment (cancel if not paid)">
    When "Require up-front payment" is enabled for the customer type (member or contact), online bookings are flagged with `CancelIfNotPaid`.

    A background task (every 15 minutes) finds these bookings and:

    1. Posts the charge immediately
    2. Creates an invoice
    3. Attempts payment collection

    If payment isn't received within the configured window (default: 30 minutes, configurable via `Bookings.CancelUnPaidBookingsAfter`), the booking is **automatically cancelled** and charges are reverted.

    This only applies to **online bookings** (those made by the customer through the portal or calendar). Bookings created by administrators are not affected.
  </Accordion>

  <Accordion title="4. Manual charge ('Post charges now')">
    When the "Calculate cost and post charges to customer account when this booking is saved" checkbox is enabled on the booking form, the charge is posted **immediately** when the booking is saved.

    The due date is set to now, meaning it will appear on the very next invoice.
  </Accordion>
</AccordionGroup>

#### Auto-invoicing after booking ends

Separately from charging, the system can also **automatically invoice** bookings after they end. When "Invoice and collect payment as bookings end" is enabled (for members or contacts), the system:

1. Waits until the booking ended at least 15 minutes ago
2. Creates an invoice containing the booking charges
3. Attempts to collect payment via the customer's payment method

This runs as part of the same 23-minute background task and only processes bookings from the last 3 days.

### Due date strategies

The charge **due date** determines when the charge becomes eligible for inclusion on an invoice. It's set based on the following priority:

| Priority | Condition                                           | Due date                                                            |
| -------- | --------------------------------------------------- | ------------------------------------------------------------------- |
| 1        | "Post charges now" is checked                       | Now (immediate)                                                     |
| 2        | Up-front payment required for customer type         | Now (immediate)                                                     |
| 3        | "Invoice as bookings end" enabled for customer type | Booking end time                                                    |
| 4        | Plan uses "Next Nth of month" strategy              | Next occurrence of that day (e.g., 1st of month after booking ends) |
| 5        | Plan uses "Booking end date" strategy               | Booking end time                                                    |
| 6        | Plan uses "Booking creation date" strategy          | When the booking was created                                        |
| 7        | Plan uses "Renewal date" strategy (default)         | Customer's next contract renewal / invoice date                     |
| 8        | Fallback (no plan, no settings)                     | Booking start time                                                  |

<Info>
  The due date is evaluated at the time the charge is posted. If a customer has multiple active plans with different strategies, the system uses the first matching strategy found across all active contracts.
</Info>

### Team billing and shared credits

When a customer belongs to a team with shared credits:

* The **paying member's** credit expiration dates are also considered when calculating the charge horizon
* If the team shares time credits or money credits, those are included in the charging eligibility window
* This means a booking for a team member may be charged earlier than expected if the paying member's credits are about to expire

### Cancelling a booking

When a booking is cancelled:

* If not yet charged: no financial impact
* If charged but not invoiced: charges are reverted automatically
* If invoiced: the invoice is not affected (you must handle refunds manually)

***

## Booking settings

Booking settings are found under **Settings → Billing & products → Bookings** (charges & payments section) and **Settings → Billing & products → Bookings → General** (behavior settings).

### Payment settings

| Setting                                                    | Effect                                                                                                                                                                                                                              |
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Require up-front payment for contacts**                  | Online bookings made by contacts are charged immediately. If not paid within the configured window (default 30 minutes), the booking is cancelled automatically. Only affects online bookings, not those created by administrators. |
| **Require up-front payment for members**                   | Same as above, but for customers with an active plan.                                                                                                                                                                               |
| **Cancel for all payment methods**                         | When enabled, up-front payment applies regardless of payment method. When disabled, customers paying via GoCardless, Forte, or Stripe direct debit are exempt.                                                                      |
| **Invoice and collect payment as bookings end (contacts)** | Automatically creates an invoice and attempts payment 15 minutes after a contact's booking ends.                                                                                                                                    |
| **Invoice and collect payment as bookings end (members)**  | Same as above, but for customers with an active plan.                                                                                                                                                                               |
| **Always calculate price / use credit immediately**        | Makes credits from future renewal periods eligible for use when evaluating booking costs. Does not change when charges are posted — that is controlled by the credit-horizon process.                                               |
| **Use money credit to pay for booking products**           | Allows money credit to offset product costs, not just the resource rate.                                                                                                                                                            |
| **Reject bookings if no credit available**                 | Prevents bookings if the customer has no credit or rate to cover the cost.                                                                                                                                                          |
| **Ignore products when calculating due dates**             | Only considers contract renewals (not product renewals) when determining the customer's next invoice date for due date calculation.                                                                                                 |
| **Cancellation policy for invoiced bookings**              | Controls whether customers can cancel or change bookings that have already been invoiced.                                                                                                                                           |
| **Disable automatic charge processing**                    | Prevents the background charge processes from running. Bookings must be charged manually.                                                                                                                                           |

### General settings

| Setting                                                          | Effect                                                                     |
| ---------------------------------------------------------------- | -------------------------------------------------------------------------- |
| **Allow new customers to register and book from the calendar**   | Lets unregistered users create an account and book directly.               |
| **Register contacts as visitors when booking**                   | Automatically creates a visitor record for contacts who make bookings.     |
| **Register known customers as visitors when added as attendees** | Creates visitor records for existing customers added as booking attendees. |
| **Require attendees to check in (NexBoard)**                     | Cancels bookings if attendees don't check in within the first 15 minutes.  |
| **Bookings by members require confirmation**                     | Member bookings are tentative until an administrator confirms them.        |
| **Bookings by contacts require confirmation**                    | Contact bookings are tentative until an administrator confirms them.       |
| **Customers can request a quote**                                | Allows customers to request a price quote instead of confirming a booking. |

### Notification settings

| Setting                               | Effect                                                                 |
| ------------------------------------- | ---------------------------------------------------------------------- |
| **Send booking confirmation email**   | Sends a confirmation to the customer after a booking is placed.        |
| **Send confirmation to guests**       | Sends a confirmation to every attendee added to the booking.           |
| **Send booking reminder email**       | Sends a reminder before the booking starts.                            |
| **Reminder email (X minutes before)** | How many minutes before a booking the reminder is sent.                |
| **Include Internet Access Token**     | Adds a temporary WiFi access code to confirmation and reminder emails. |

***

## The booking calendar

In addition to the list view, bookings can be managed from the **Booking Calendar** (Operations → Calendar → Bookings). The calendar provides:

* **Day, week, and month views** showing all bookings across resources
* **Drag-and-drop** to move or resize bookings
* **Click to create** new bookings directly on the calendar
* **Resource filtering** to show specific resources or resource types
* **Conflict highlighting** showing overlapping bookings

***

## Repeat bookings

Repeat bookings create a series of bookings at regular intervals.

### Configuration

* **Repeat every** — frequency (e.g., every 1 week, every 2 weeks)
* **Days** — which days of the week (Mon–Sun)
* **Until** — end date for the series

### Managing a series

When you edit a booking that belongs to a series, you're prompted to choose which bookings to update:

* **This booking only** — changes apply to the single occurrence
* **This and following bookings** — changes apply from this occurrence onwards
* **All bookings in the series** — changes apply to every occurrence

***

## Quick filter segments

The booking list provides these quick filters:

| Segment              | Shows                                          |
| -------------------- | ---------------------------------------------- |
| **Made by members**  | Bookings made by customers with an active plan |
| **Made by contacts** | Bookings made by customers without a plan      |
| **Upcoming**         | Future bookings                                |
| **This week**        | Bookings starting this week                    |
| **Last week**        | Bookings from last week                        |
| **This month**       | Bookings starting this month                   |
| **Last month**       | Bookings from last month                       |
| **Tentative**        | Unconfirmed bookings                           |
| **Confirmed**        | Confirmed but not yet charged                  |
| **Charged**          | Charges posted but not yet invoiced            |
| **Unpaid**           | Invoiced but not yet paid                      |
| **Paid**             | Fully paid                                     |
| **Anonymous**        | Bookings with no customer assigned             |

***

## Dynamic pricing

If dynamic pricing is enabled for your location, booking prices can adjust automatically based on demand and timing:

### Demand-based pricing

Prices increase or decrease based on predicted demand for the time slot:

* **High demand** — price increases by a configured percentage
* **Average demand** — price may adjust slightly or stay the same
* **Low demand** — price decreases by a configured percentage

Demand is predicted using historical booking patterns for each resource.

### Last-minute pricing

Prices can adjust for bookings made close to the start time:

* **Fixed** — a set percentage discount/surcharge for all last-minute bookings
* **Gradual** — the adjustment scales linearly as the booking approaches (bigger discount the closer to the start time)

Dynamic adjustments are shown as "Dynamic Adj." in the price panel.

***

## Commands

On existing bookings, the following commands are available:

| Command                    | Action                                            |
| -------------------------- | ------------------------------------------------- |
| **Remove booking charges** | Reverts posted charges (only if not yet invoiced) |
| **Invoice booking**        | Creates an invoice for the booking charges        |

***

## Best practices

* **Use tentative bookings** for holds that aren't confirmed — they won't be charged and can be easily removed.
* **Let the system choose rates** unless you have a specific reason to override — it always picks the cheapest valid option for the customer.
* **Configure up-front payment for contacts** to avoid no-shows from non-members who haven't committed financially.
* **Use time credits on plans** to give members included booking hours — it's the most transparent way to show value in a membership.
* **Add products to resources** for commonly requested extras (projectors, coffee, etc.) — this keeps everything on one invoice.
* **Use the "Invoice this customer directly" checkbox** when a team member is booking for personal use and shouldn't charge the team.
* **Review the "Charged" segment** regularly to ensure bookings are being invoiced on schedule.

***

## Related pages

<CardGroup>
  <Card title="Resources" icon="grid-2" href="/platform/billing/resources">
    Configure the bookable resources available at your location.
  </Card>

  <Card title="Time Credits" icon="clock" href="/platform/billing/time-credits">
    Manage time-based booking credits included in plans.
  </Card>

  <Card title="Visitors" icon="user-group" href="/platform/operations/visitors">
    Track attendees added to bookings as visitors.
  </Card>

  <Card title="Invoices" icon="file-invoice" href="/platform/finance/invoices">
    View and manage invoices generated from bookings.
  </Card>
</CardGroup>


# Check-ins
Source: https://learn.nexudus.com/platform/operations/check-ins

How to track who is on-site at your location using check-ins and handle failed check-in attempts in Nexudus.

## Overview

The **Check-ins** section shows you who is currently on-site at your location and their visit history. Customers check in when they arrive and check out when they leave — either manually, via door access activity, WiFi network detection, automation tiles, sensors, or automatically when a booking starts.

Check-ins are tied to **passes**, which represent a customer's entitlement to access your space. When a customer checks in, the system validates that they have a valid pass (from their plan or a standalone pass) and deducts usage time accordingly.

If a check-in attempt fails (e.g., no valid pass, account disabled, plan limits exceeded), it's recorded as a **failed check-in** for review.

## How to access

* **Check-ins calendar**: Navigate to **Operations → Access & Check-in → Customers on site**
* **Failed check-ins**: Navigate to **Operations → Access & Check-in → Failed check-ins**

<Note>
  Requires the **checkin** role.
</Note>

## Key concepts

| Term                   | Meaning                                                                                          |
| ---------------------- | ------------------------------------------------------------------------------------------------ |
| **Check-in**           | A record that a customer arrived at your location, with start and optional end time              |
| **Check-out**          | Closing a check-in by recording the departure time                                               |
| **Pass**               | A customer's entitlement to access the space (from a plan benefit or a standalone pass purchase) |
| **Pay-as-you-go**      | A mode where customers without a plan are charged per-minute for their time on-site              |
| **Daily cut-off time** | The hour at which all customers are automatically checked out (e.g., midnight or 2 AM)           |
| **Failed check-in**    | A check-in attempt that was rejected because the customer didn't meet the requirements           |
| **Check-in source**    | How the check-in was triggered (manual, door access, WiFi, etc.)                                 |

***

## Check-in sources

Check-ins can be created through several methods:

| Source                      | How it works                                                                                              |
| --------------------------- | --------------------------------------------------------------------------------------------------------- |
| **Manual / NexIO**          | An administrator checks the customer in from the dashboard, or the customer uses the NexIO front-desk app |
| **Door access**             | A door access integration (Kisi, Salto, Gallagher, etc.) detects the customer entering the building       |
| **Network activity (WiFi)** | The system detects the customer's device MAC address on the WiFi network                                  |
| **Automation tile**         | A configured automation tile triggers a check-in (e.g., tapping an NFC tag)                               |
| **Sensor**                  | An IoT sensor detects the customer's presence                                                             |
| **Booking**                 | A booking starts and the customer is automatically checked in for the duration                            |

***

## The check-in calendar

The main check-ins page displays a **hybrid calendar and list view** showing:

* Who is currently on-site (open check-ins with no departure time)
* Recent check-ins and check-outs
* Booking-based check-ins (displayed separately)
* Visitor check-ins from bookings

### Calendar views

* **Month view** — Overview of check-in activity across the month
* **Timeline view** — Check-ins grouped by customer, showing durations as bars
* **List view** — Tabular list of check-ins by day

### Check-in list columns

| Column         | Description                                            |
| -------------- | ------------------------------------------------------ |
| **Customer**   | The customer's full name (links to their profile)      |
| **Start time** | When the customer checked in                           |
| **End time**   | When the customer checked out (blank if still on-site) |
| **Plan**       | The customer's active plan at the time of check-in     |
| **Team**       | The customer's team membership at the time of check-in |

***

## Creating a manual check-in

<Steps>
  <Step title="Open the check-in calendar">
    Navigate to **Operations → Access & Check-in → Customers on site**.
  </Step>

  <Step title="Click on a time slot or use the new button">
    Select a date/time on the calendar or click the "+" button to open the check-in form.
  </Step>

  <Step title="Select the location">
    Choose the location where the customer is checking in.
  </Step>

  <Step title="Select the customer">
    Choose the customer from the dropdown.
  </Step>

  <Step title="Set arrival and departure times">
    Set the arrival time. You can optionally set a departure time (or leave it open to check the customer out later). Use the duration shortcuts (1h, 2h, 4h, 8h) for quick selections.
  </Step>

  <Step title="Save">
    Click **Save**. The system validates that the customer has a valid pass and records the check-in.
  </Step>
</Steps>

<Info>
  Times are rounded to the nearest 15-minute interval automatically.
</Info>

***

## Check-in form fields

| Field             | Description                                                                          |
| ----------------- | ------------------------------------------------------------------------------------ |
| **Location**      | The location where the customer is checking in                                       |
| **Customer**      | The customer being checked in                                                        |
| **Check-in type** | The source of the check-in (read-only after creation — see "Check-in sources" above) |
| **Arrival**       | The check-in start time                                                              |
| **Departure**     | The check-out time (leave empty for an open check-in)                                |

***

## How pass validation works

When a customer checks in, the system validates their entitlement in this order:

1. **Is the account active?** — Disabled accounts cannot check in.
2. **Does the customer have a valid pass?** — The system looks for an unused pass that:
   * Is valid at the current time (within the pass's allowed hours and days)
   * Is valid at this location (if the pass is restricted to specific locations)
   * Has remaining time (if the pass is time-based)
   * Is not already in use by another check-in (for single-use passes)
3. **Are plan limits exceeded?** — For members with a plan, the system checks:
   * Weekly check-in limit (max number of check-ins per week)
   * Weekly hours limit (max hours per week)
   * Monthly check-in limit (max number of check-ins per month)
   * Monthly hours limit (max hours per month)
   * Plan-period check-in limit (total check-ins since last renewal)
   * Plan-period hours limit (total hours since last renewal)
4. **Is pay-as-you-go available?** — If no pass is found, the system checks if pay-as-you-go access is enabled and a valid pay-as-you-go pass exists.

If all checks fail, the check-in is rejected and recorded as a **failed check-in**.

### Pass priority

When multiple valid passes exist, the system selects one based on:

1. Passes with the highest priority value (configured on the pass)
2. Passes restricted to this location (more specific = preferred)
3. Passes linked to specific plans
4. Passes with the most remaining time
5. Plan-included passes over standalone passes

### Shared passes (teams)

If the customer doesn't have their own valid pass, the system checks if their team's paying member has shared passes available. Shared passes are used when:

* The team has pass-sharing enabled
* The paying member has valid passes with remaining time

***

## Failed check-ins

When a check-in attempt fails, a record is created in **Operations → Access & Check-in → Failed check-ins** with:

| Field                     | Description                                  |
| ------------------------- | -------------------------------------------- |
| **Customer**              | Who attempted to check in                    |
| **Check-in attempted at** | When the attempt was made                    |
| **Check-in type**         | The source (manual, door access, WiFi, etc.) |
| **Description**           | The reason the check-in failed               |

### Common failure reasons

| Reason                              | Meaning                                                                            |
| ----------------------------------- | ---------------------------------------------------------------------------------- |
| **Account disabled**                | The customer's account is inactive                                                 |
| **No valid pass**                   | The customer has no pass that's valid at this time and location                    |
| **Plan limits exceeded**            | The customer has used all their included check-ins or hours for the current period |
| **Pass not valid at this location** | The customer has a pass, but it's restricted to a different location               |
| **Pass expired**                    | The customer's pass has expired                                                    |

### Filter segments

Failed check-ins can be filtered by:

* Today
* This week
* Last week
* This month
* Last month

<Tip>
  Review failed check-ins regularly to identify customers who may need a plan upgrade or have an expired pass.
</Tip>

***

## Automatic check-out

The system automatically checks customers out in several scenarios:

### Daily cut-off time

All customers are automatically checked out at the configured **daily cut-off time** (e.g., midnight or 2 AM). This prevents check-ins from spanning into the next day when customers forget to check out.

The cut-off time is configured in hours (0–23) and represents the time in your location's timezone.

### Pass depletion

If a customer's pass runs out of remaining time while they're checked in, the system:

1. Continuously monitors whether the check-in is still valid via background processing
2. If the pass is depleted, automatically checks the customer out at the time the pass ran out (determined by checking backwards in 15-minute intervals)
3. Attempts to check the customer back in with a new pass (if one is available)
4. If no new pass is available, sends an auto-checkout notification (if enabled)

### Pass time restrictions

If a pass is only valid during certain hours (e.g., "Weekdays 9 AM – 6 PM"), the system continuously validates the check-in and automatically checks the customer out when the valid window ends. After checkout, the system attempts to check the customer back in with another available pass.

### Day change

If a check-in spans across the daily cut-off time (e.g., customer checked in at 10 PM, cut-off is midnight), the customer is checked out at the cut-off time. If they're still on-site after the cut-off, a new check-in is started for the new day.

***

## Pay-as-you-go access

Pay-as-you-go mode lets customers who don't have a plan (or who have exceeded their plan limits) still check in and be charged per-minute for their time.

### How it works

1. When a customer checks in with no valid pass, the system looks for a **pay-as-you-go pass** configured for their customer type (member or contact).
2. A temporary pass is created with zero minutes.
3. When the customer checks out, the total time is calculated and a charge is generated based on the pass's per-minute rate.
4. The charge appears on the customer's next invoice (or immediately for contacts, depending on settings).

### Pay-as-you-go settings

| Setting                            | Effect                                                                                                         |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| **Enable pay-as-you-go access**    | Allows customers without a valid pass to check in and be charged per minute                                    |
| **Exclude time used in bookings**  | Deducts time spent in bookings from the pay-as-you-go calculation (avoids double-charging)                     |
| **Members pay via their contract** | Pay-as-you-go charges for members are added to their contract invoice instead of generating a separate invoice |
| **Minimum daily price**            | The minimum charge for a day, regardless of how little time was used                                           |
| **Maximum daily price**            | The maximum charge for a day, regardless of how much time was used (acts as a daily cap)                       |

***

## Check-in settings

Check-in settings are found under **Settings → Members → Check-in settings**.

### General settings

| Setting                                              | Effect                                                                                                                                                              |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Notify customers when running low on access time** | Sends an email when the customer's remaining pass hours drop below the threshold                                                                                    |
| **Low credit threshold (hours)**                     | The number of hours below which the low-credit notification is sent                                                                                                 |
| **Notify customers if they forget to check out**     | Sends an email when the system auto-checks out a customer                                                                                                           |
| **Record multiple check-ins per day**                | When enabled, checking in and out multiple times in one day creates separate records. When disabled, re-checking in on the same day re-opens the previous check-in. |
| **Daily cut-off time**                               | The hour (0–23) at which all customers are automatically checked out                                                                                                |
| **Building capacity**                                | Maximum number of people allowed on-site simultaneously (enforced by NexIO)                                                                                         |

### Network check-in settings

| Setting                                                           | Effect                                                                                |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| **Automatically check known users in based on their MAC address** | When the system detects a registered device on WiFi, automatically creates a check-in |
| **Generate an access token for every pre-registered visitor**     | Creates a WiFi access token for visitors automatically                                |
| **Default duration for visitor access tokens**                    | How long visitor WiFi tokens remain valid (in minutes)                                |
| **Maximum devices per user**                                      | Limit on how many devices a single customer can register for network check-in         |
| **Maximum devices per visitor**                                   | Limit on how many devices a visitor can connect                                       |

***

## Webhooks

The following webhook events are triggered by check-in activity:

| Event                        | Triggered when                                       |
| ---------------------------- | ---------------------------------------------------- |
| **Customer checked in**      | A check-in is successfully created                   |
| **Customer checked out**     | A check-in is closed (departure time set)            |
| **Customer check-in failed** | A check-in attempt is rejected                       |
| **Check-in created**         | A check-in record is created (includes manual/admin) |
| **Check-in updated**         | A check-in record is modified                        |
| **Check-in deleted**         | A check-in record is removed                         |

***

## Best practices

* **Set a daily cut-off time** to prevent check-ins from spanning days when customers forget to check out. A time between midnight and 4 AM works well for most spaces.
* **Enable auto-checkout notifications** so customers know when they've been checked out and can see their usage for the day.
* **Use pay-as-you-go with a daily cap** to offer flexible drop-in access while capping the cost at a reasonable day rate.
* **Review failed check-ins weekly** to identify customers hitting plan limits — these are upgrade opportunities.
* **Enable network check-in** for a frictionless experience — customers are checked in automatically when their phone connects to WiFi.
* **Set building capacity** if your location has occupancy limits — NexIO will prevent check-ins when the space is full.

***

## Related pages

<CardGroup>
  <Card title="Passes" icon="ticket" href="/platform/billing/time-passes">
    Configure the passes that determine who can check in.
  </Card>

  <Card title="Plans" icon="file-contract" href="/platform/billing/plans">
    Set up plan benefits including check-in limits and included passes.
  </Card>

  <Card title="Access control" icon="lock" href="/platform/access-control/overview">
    Integrate with door systems for automated check-ins.
  </Card>

  <Card title="Bookings" icon="calendar" href="/platform/operations/bookings">
    Bookings can automatically check customers in for the duration of their reservation.
  </Card>
</CardGroup>


# Help desk
Source: https://learn.nexudus.com/platform/operations/help-desk

How to manage customer support requests using the built-in help desk in Nexudus — including departments, priorities, internal notes, and AI auto-replies.

## Overview

The **Help desk** lets your customers submit support requests directly from their members portal, and lets your team manage, assign, and resolve those requests from the dashboard. Each request becomes a threaded conversation where staff can reply publicly or leave internal notes.

Help desk messages can be routed to **departments**, assigned to specific **owners** (staff members), prioritised, and optionally answered automatically by AI using your FAQ articles.

## How to access

* **Help desk messages**: Navigate to **Operations → Front-desk → Help desk**
* **Help desk departments**: Navigate to **Operations → Front-desk → Help desk departments**

<Note>
  Requires the **helpDeskMessage** role.
</Note>

## Key concepts

| Term                  | Meaning                                                                                             |
| --------------------- | --------------------------------------------------------------------------------------------------- |
| **Help desk message** | A support request submitted by a customer, containing a subject, message, and optional attachment   |
| **Comment**           | A reply to a help desk message — can be public (visible to the customer) or internal (staff-only)   |
| **Department**        | A category for routing requests to the right team (e.g., "Billing", "Technical support", "Events")  |
| **Owner**             | The staff member assigned to handle a specific request                                              |
| **Priority**          | The urgency level of a request (Low, Normal, High, Critical)                                        |
| **Internal reply**    | A comment only visible to staff — useful for discussing a request before responding to the customer |

***

## The help desk message list

The message list shows all support requests, with quick filter segments:

| Segment            | Shows                                |
| ------------------ | ------------------------------------ |
| **Open** (default) | All unresolved requests              |
| **Critical**       | Open requests with Critical priority |
| **Closed**         | Resolved requests                    |

Messages are sorted by creation date, with the newest first. You can search by subject line.

***

## Viewing a help desk message

When you open a help desk message, the page is split into two areas:

### Conversation thread (centre)

* The original message from the customer (with any attachment)
* All subsequent replies in chronological order
* Each reply shows who posted it and when
* Internal replies are visually marked and hidden from the customer
* AI-generated replies show a link to the FAQ article used as the source

### Message details (right sidebar)

| Field          | Description                                             |
| -------------- | ------------------------------------------------------- |
| **Customer**   | The customer who created the request (read-only)        |
| **Location**   | The location the request was submitted from (read-only) |
| **Department** | The department this request is assigned to              |
| **Owner**      | The staff member responsible for this request           |
| **Priority**   | Low, Normal, High, or Critical                          |
| **Resolved**   | Checkbox to mark the request as closed                  |

***

## Creating a help desk message (as staff)

While customers typically create help desk messages from the members portal, staff can also create them on behalf of a customer:

<Steps>
  <Step title="Navigate to the help desk">
    Go to **Operations → Front-desk → Help desk** and click the "+" button.
  </Step>

  <Step title="Enter a subject">
    Write a brief title describing the request.
  </Step>

  <Step title="Write the message">
    Describe the request in the message field. Markdown formatting is supported.
  </Step>

  <Step title="Attach a file (optional)">
    Upload an image or document if relevant.
  </Step>

  <Step title="Save">
    Click **Save**. Then assign a customer, department, owner, and priority from the sidebar.
  </Step>
</Steps>

***

## Replying to a message

<Steps>
  <Step title="Open the message">
    Click on a help desk message from the list.
  </Step>

  <Step title="Write your reply">
    Use the reply composer at the bottom of the conversation thread. Markdown formatting is supported.
  </Step>

  <Step title="Choose visibility">
    * Leave the **Internal** checkbox unchecked to send a public reply (customer will see it and be notified).
    * Check **Internal** to post a staff-only note that the customer cannot see.
  </Step>

  <Step title="Attach a file (optional)">
    Upload an image or document with your reply.
  </Step>

  <Step title="Submit">
    Click the send button or press **Ctrl+Enter** to submit.
  </Step>
</Steps>

<Info>
  When a staff member posts a public reply and the message has no owner yet, the replying staff member is automatically assigned as the owner.
</Info>

***

## Assigning and managing requests

### Departments

Assign a request to a department to route it to the appropriate team. When a department is assigned:

* All **department managers** receive a notification about the new request
* If the department has a **linked task list**, that task list is automatically started for the customer

### Owner

Assign a specific staff member as the owner to indicate who is responsible for resolving the request. The owner receives:

* Notifications when the customer replies
* Periodic reminders about open requests they own (if they have reminders configured in their profile)

### Priority levels

| Level                | When to use                                                    |
| -------------------- | -------------------------------------------------------------- |
| **Low**              | General questions, non-urgent feedback                         |
| **Normal** (default) | Standard requests that need attention within normal timeframes |
| **High**             | Important issues that need prompt attention                    |
| **Critical**         | Urgent problems affecting the customer's ability to work       |

### Resolving a request

Check the **"This help request is resolved"** checkbox in the sidebar to close the request. The closure time is recorded automatically.

If a customer replies to a closed request, it is **automatically re-opened**.

***

## Departments

Departments help you organise and route incoming help desk requests. Navigate to **Operations → Front-desk → Help desk departments** to manage them.

### Department fields

| Field                   | Description                                                                                                       |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Name**                | The department name shown to customers when they submit a request (unique per location)                           |
| **Description**         | Explains what type of requests should be sent here (shown to customers)                                           |
| **Active**              | Whether this department appears as an option for new requests                                                     |
| **Department managers** | Staff members who receive notifications for requests in this department                                           |
| **Start task list**     | An optional task list that is automatically assigned to the customer when a request is created in this department |

<Tip>
  Use the "Start task list" feature to create onboarding checklists or standard procedures that run automatically when a customer submits a specific type of request — for example, a "New member setup" task list triggered by the "Onboarding" department.
</Tip>

***

## AI auto-replies

When AI help desk replies are enabled, the system automatically attempts to answer incoming customer messages using your FAQ articles.

### How it works

1. A customer submits a help desk message (or replies to an existing one)
2. The system searches your FAQ articles for a relevant answer
3. If a match is found, an AI-generated reply is posted automatically, including a link to the source FAQ article
4. The message is marked as "AI responded"
5. If no relevant FAQ is found, the message is marked as "AI not responded" (requires manual follow-up)

### AI processing states

| State             | Meaning                                                                |
| ----------------- | ---------------------------------------------------------------------- |
| **Not processed** | AI reply is not enabled or was not attempted                           |
| **Responded**     | The AI found a relevant FAQ and posted an automatic reply              |
| **Not responded** | The AI was unable to find a relevant answer — requires staff attention |

<Info>
  AI replies are posted as public comments visible to the customer. They appear in the conversation thread with a reference to the FAQ article used. Staff can follow up with additional details if needed.
</Info>

***

## Notifications

### When a new request is created

| Recipient                          | Condition                    |
| ---------------------------------- | ---------------------------- |
| Department managers                | If a department is assigned  |
| Help desk notification subscribers | If no department is assigned |

### When a customer replies

| Recipient                          | Condition                                   |
| ---------------------------------- | ------------------------------------------- |
| The assigned owner                 | If the request has an owner                 |
| Department managers                | If no owner but a department is assigned    |
| Help desk notification subscribers | If neither owner nor department is assigned |

### When staff replies (public)

| Recipient    | Condition                          |
| ------------ | ---------------------------------- |
| The customer | Always (email + push notification) |

### Reminders

Staff members who own open help desk requests receive a weekly reminder email about their unresolved requests every Monday at 8:00 AM (in the location's local time).

***

## Webhooks

The following webhook events are triggered by help desk activity:

| Event                         | Triggered when                                                            |
| ----------------------------- | ------------------------------------------------------------------------- |
| **Help desk message created** | A new request is submitted                                                |
| **Help desk message updated** | A request is modified (priority change, department change, closure, etc.) |
| **Help desk comment created** | A reply is posted (public or internal)                                    |

***

## SLA metrics

The help desk tracks response time metrics for each request:

| Metric                  | Meaning                                                        |
| ----------------------- | -------------------------------------------------------------- |
| **First response time** | Minutes between the request creation and the first staff reply |
| **Minutes to close**    | Total minutes from creation to resolution                      |

These metrics are available in the request data and can be used in reports to track your team's support performance.

***

## Member portal settings

Customers can submit help desk requests from their members portal. To control this:

| Setting                                               | Location                             | Effect                                                          |
| ----------------------------------------------------- | ------------------------------------ | --------------------------------------------------------------- |
| **Users can request help using the help-desk module** | Settings → Members → Portal features | Enables or disables the help desk section in the members portal |

***

## Best practices

* **Create departments** that match your team structure (e.g., "Billing", "Facilities", "IT Support") so requests reach the right people immediately.
* **Assign owners** as soon as possible to ensure accountability and prevent requests from being missed.
* **Use internal replies** to discuss sensitive matters with your team before responding to the customer.
* **Set up FAQ articles** comprehensively — when AI auto-reply is enabled, well-written FAQs can resolve common questions automatically, reducing staff workload.
* **Monitor the "Critical" segment** daily to ensure urgent requests get immediate attention.
* **Use the task list automation** on departments to trigger standard procedures (e.g., "WiFi issue" department triggers a troubleshooting checklist).
* **Review first response time** regularly to ensure your team is meeting customer expectations.

***

## Related pages

<CardGroup>
  <Card title="FAQ articles" icon="circle-question" href="/platform/content/faq">
    Create FAQ articles that power AI auto-replies and help customers self-serve.
  </Card>

  <Card title="Members" icon="users" href="/platform/operations/members">
    View a customer's help desk history from their profile.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/platform/settings/webhooks">
    Set up automations triggered by help desk events.
  </Card>

  <Card title="AI assistant" icon="robot" href="/platform/ai/overview">
    Learn more about AI-powered features in Nexudus.
  </Card>
</CardGroup>


# Members & Contacts
Source: https://learn.nexudus.com/platform/operations/members

How to manage customer profiles in Nexudus — creating members and contacts, editing profiles, configuring access, and handling billing details.

## Overview

The **Members & Contacts** page is your customer database. Every person or company registered in your system lives here — whether they have an active plan (members) or not (contacts).

From this page you can create new customers, view their profiles, manage access and billing, assign them to teams and locations, and track their activity across bookings, invoices, and check-ins.

## How to access

Navigate to **Operations → Members & contacts** in the left sidebar.

<Note>
  Requires the **coworker** role. The list is sorted by registration date (newest first) by default. If your location has the Finance module enabled, the list initially shows only customers with an active plan — clear the filter to see all customers.
</Note>

## Members vs contacts

The distinction between members and contacts is automatic:

* A **member** is a customer with at least one active contract.
* A **contact** is a customer without any active contracts.

You don't set this manually. When you assign a contract to a customer, they become a member. When all contracts end, they revert to a contact.

<Info>
  Both members and contacts appear in the same list. Use the plan filter to show only members (those with a plan) or clear it to see everyone.
</Info>

## The customer list

The list shows key information at a glance:

| Column           | Details                                                                                                     |
| ---------------- | ----------------------------------------------------------------------------------------------------------- |
| **Name**         | Full name (individuals) or company name (companies), plus avatar and team names                             |
| **Plan**         | The names of any active plans (contracts)                                                                   |
| **Registration** | Date the customer was added                                                                                 |
| **Status**       | Badges indicate: Individual/Company, Member (has plan), Administrator, Suspended/Archived, No portal access |

### Status badges

* **Individual** / **Company** — customer type
* **Member** (refresh icon) — has at least one active contract
* **Administrator** (lock icon) — is a full platform administrator
* **Suspended** (red, pause icon) — account is suspended (`Active = false`)
* **Archived** (red) — account has been archived
* **No portal access** (grey) — no user account, cannot log in

***

## Creating a customer

<Steps>
  <Step title="Click Add customer">
    From the Members list, click the **Add customer** button. You can also use one of the available quick-start wizards:

    * **Quick member** — create a customer and assign a plan in one flow
    * **Quick contact (sale)** — create a contact with sale opportunity
    * **Company with employees** — create a company and add team members
    * **Member of staff** — add a staff member to your location
    * **Import customers** — bulk import from CSV
  </Step>

  <Step title="Choose the customer type">
    Select **Individual** or **Company**. For companies, the primary field is the company name. For individuals, it's the full name.
  </Step>

  <Step title="Fill in required fields">
    The minimum required fields are:

    * **Full name** (or Company name)
    * **Email address**
    * **Country**
    * **Timezone**

    The country and timezone default to your current location's settings.
  </Step>

  <Step title="Grant online access (optional)">
    Enable **Create user account** to give the customer login access to the Members Portal and mobile app. This sends them a welcome email with sign-in instructions.

    <Warning>
      Once a customer is created without a user account, you can grant access later using the **Grant online access** command on their profile. However, the `CreateUser` option is only available during initial creation.
    </Warning>
  </Step>

  <Step title="Assign a plan (optional)">
    During creation, you can immediately assign a plan (contract). This is the fastest way to onboard a member.
  </Step>

  <Step title="Save">
    Click **Save** to create the customer record. The system validates all required fields and, if a user account was requested, creates the login and sends the welcome email.
  </Step>
</Steps>

***

## Customer profile structure

When you open a customer, the profile is organized into top-level tabs. The tabs visible depend on your modules and role.

### Dashboard tab

A summary view showing:

* Key metrics (revenue generated, bookings made, check-ins since last renewal)
* Summary charts (activity over time)
* Key events timeline (recent actions and milestones)

<Note>
  The Dashboard tab only appears for existing customers and requires the **Invoices** module.
</Note>

### Account tab

The main configuration area, organized into sub-sections:

#### Account details

Core identity and contact information:

| Field             | Description                                                                        |
| ----------------- | ---------------------------------------------------------------------------------- |
| **Customer type** | Individual or Company                                                              |
| **Full name**     | Required. For individuals, the full name. For companies, the primary contact name. |
| **Company name**  | Required for Company type. The organization's name.                                |
| **Salutation**    | How to address this customer in communications (auto-populated from first name)    |
| **Email**         | Required. Used for login (if user account exists), invoices, and notifications.    |
| **Avatar**        | Profile photo (uploaded to blob storage)                                           |
| **Banner image**  | Header image for their profile page                                                |
| **Notes**         | Private admin notes (not visible to the customer)                                  |

#### Locations

| Field                    | Description                                                                                                              |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| **Home location**        | The primary location for invoicing. Determines which location bills this customer.                                       |
| **Registered locations** | All locations this customer can access. A customer can belong to multiple locations without creating duplicate profiles. |

#### Teams

Assign this customer to one or more teams. Teams can represent companies, departments, or any logical grouping. Team membership is bidirectional — adding here also adds the customer to the team's member list.

#### Contact and billing

Address fields for correspondence and invoicing:

* **Contact address** — street, city, postcode, state, country
* **Billing address** — separate billing details if they differ (billing name, email, address). Used on all generated invoices.
* **Phone numbers** — mobile and landline

#### Professional profile

Public-facing information shown in the Members Portal directory:

| Field                 | Description                                                                                                        |
| --------------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Profile summary**   | A short bio shown in the directory                                                                                 |
| **Profile website**   | Link to their website or portfolio                                                                                 |
| **Profile tags**      | Skills or interests used for networking and discovery                                                              |
| **Profile is public** | Toggle visibility in the member directory                                                                          |
| **Social links**      | LinkedIn, Twitter, Instagram, GitHub, Facebook, Telegram, Skype, Pinterest, Flickr, Vimeo, Tumblr, Blogger, Google |

<Tip>
  If your location has AI features enabled, you can use the **Generate profile** button to auto-generate a profile summary and tags based on the customer's information.
</Tip>

#### Attendance

Expected on-site schedule for each day of the week (Monday through Sunday). Used for occupancy planning and reporting.

#### Demographics

Categorical information:

* **Gender** — Not set, Male, Female, Other, Rather not say
* **Date of birth** — used for birthday automations and age calculation
* **Business area** — industry or sector

#### Identifiers

| Field                       | Description                                                                       |
| --------------------------- | --------------------------------------------------------------------------------- |
| **Tag**                     | Short labels to categorize this customer (supports multiple tags)                 |
| **Unique reference number** | Your own internal ID for this customer across all locations                       |
| **Show alert on check-in**  | When enabled, displays a custom message to staff whenever this customer checks in |
| **Alert message**           | The message to display                                                            |

#### Notifications

Control which automated emails this customer receives:

| Setting                               | Effect                                            |
| ------------------------------------- | ------------------------------------------------- |
| **Send new invoices by email**        | Automatically emails new invoices                 |
| **Send payment receipts by email**    | Sends confirmation when a payment is recorded     |
| **Send failed payment notifications** | Alerts the customer when automatic payment fails  |
| **Notify team on deliveries**         | Notifies the entire team when a delivery arrives  |
| **Delivery notification email**       | Override email address for delivery notifications |

#### Access rights

Controls what the customer can do in the portal and on-site:

| Permission                      | What it controls                                                                        |
| ------------------------------- | --------------------------------------------------------------------------------------- |
| **Can connect to IT network**   | Whether they can authenticate for WiFi / network access                                 |
| **Can make bookings**           | Whether they can book resources in the portal (requires user account)                   |
| **Can book for team members**   | Whether they can create bookings on behalf of their team (requires bookings permission) |
| **Can purchase products**       | Whether they can buy add-on products (requires user account)                            |
| **Can purchase events**         | Whether they can buy event tickets (requires user account)                              |
| **Can post community messages** | Whether they can participate in community forums (requires user account)                |
| **Can access team invoices**    | Whether they can view invoices for their team's paying member                           |

Physical access credentials:

| Field            | Description                                                                   |
| ---------------- | ----------------------------------------------------------------------------- |
| **PIN code**     | Used for internet access, check-in terminals, and printing services           |
| **Access cards** | One or more card IDs linked to door access systems (supports multiple values) |
| **Access fobs**  | One or more RFID fob numbers (supports multiple values)                       |

<Info>
  Permissions that require a user account are automatically disabled if the customer has no online access. You'll see a warning banner and a **Grant online access** button if this is the case.
</Info>

You can also **Revoke online access** from this section to remove a customer's ability to log in without deleting their record.

#### Integrations & Services

Per-customer configuration for external services:

* **PaperCut** — free printing quota, pay-as-you-print toggle
* **Ezeep / Ezeep Blue** — cloud printing enablement and free printing flag

***

### Payments tab

Payment gateway configuration and financial settings for this customer. Requires the **Finance** module.

| Field                                     | Description                                                                           |
| ----------------------------------------- | ------------------------------------------------------------------------------------- |
| **Payment provider**                      | Which gateway processes this customer's automatic payments (Stripe, GoCardless, etc.) |
| **Tax rate type**                         | Default, Reduced, or Exempt                                                           |
| **Tax ID number**                         | VAT number or tax exemption reference                                                 |
| **Invoice due date period**               | Number of days after issue before an invoice is overdue                               |
| **Do not process invoices automatically** | Prevents the system from attempting automatic payment collection                      |
| **Bank details**                          | Bank name, account, branch — for manual payment or direct debit setups                |

Gateway-specific sub-sections (Stripe BACS, GoCardless, Spreedly) appear based on which integrations your location has enabled.

***

### Sales tab

A consolidated view of all commercial activity:

* **Invoices** — full invoice history with status and amounts
* **Contracts** — active and past plan subscriptions
* **Bookings** — booking history
* **Event tickets** — purchased event registrations
* **Charges** — one-off charges and credits

Requires the **Finance** and **Products** modules.

***

### Benefits tab

Tracks credits, passes, and discounts assigned to this customer:

* **Booking credits** — time-based or count-based booking allowances
* **Passes** — pre-purchased access passes
* **Time credits and printing credits** — usage-based credits active on their account
* **Discount codes** — assigned promotional codes

Requires the **BookingCredits**, **AccessCredit**, **TimeCredit**, or **DiscountCodes** module.

***

### CRM tab

Relationship management data for this customer:

* Notes and activity history
* Tasks assigned to or about this customer
* Messages and communications
* Documents and files
* Proposals sent
* Opportunities (sales pipeline)
* Visitor history

Requires the **Crm**, **Tasks**, **Messages**, **Proposals**, or **Opportunities** module.

***

### Invoices tab

Dedicated invoice list filtered to this customer. Shows unpaid invoice count as a badge on the tab. Requires the **Invoices** module.

***

### Ledger tab

Financial transaction ledger for this customer. Shows the current balance as a badge:

* A **positive** balance means the customer has credit.
* A **negative** balance means the customer owes you.

Requires the **Invoices** module.

***

## Suspending and archiving

Customers have two independent status flags:

| Status                           | Effect                                                                                                                                                             |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Suspended** (`Active = false`) | The customer's account is deactivated. Access may be restricted depending on your configuration. The customer still appears in lists with a red "Suspended" badge. |
| **Archived** (`Archived = true`) | Marks the customer as no longer active. Used for former members you want to keep on record but hide from daily operations. Shows a red "Archived" badge.           |

Both can be set via the customer's profile or through bulk commands. Neither deletes the customer record — all history and data is preserved.

<Warning>
  Suspending a customer does not automatically cancel their contracts but it will stop all automatic billing. You must manage contracts separately.
</Warning>

***

## Granting and revoking online access

A customer needs a **user account** to log in to the Members Portal and mobile app.

**Granting access:**

* During creation: enable **Create user account** — sends a welcome email automatically.
* On an existing customer: use the **Grant online access** command from the Access rights section. This creates the user account and sends the welcome email.

**Revoking access:**

* Use the **Revoke online access** button in the Access rights section. This removes the user account but preserves the customer record and all associated data.

***

## Filtering and searching

The customer list supports:

* **Global search** — searches across name, email, company, billing name, and team names
* **Plan filter** — show only customers on a specific plan (or those without any plan)
* **Team filter** — customers belonging to a specific team
* **Active/Archived status** — filter by account status
* **Location filter** — show customers at a specific location or across all locations
* **Custom fields** — filter by any custom field value
* **Date range** — filter by registration date or date of birth
* **Tags** — filter by assigned tags
* **Customer type** — Individual or Company

***

## Bulk commands

From the list view, select multiple customers and use the **Run command** action to perform bulk operations such as:

* Suspend or reactivate accounts
* Archive accounts
* Send bulk emails
* Assign tags
* Create contracts
* Grant or revoke online access

Commands have eligibility rules — only customers in the correct state for a given action will be affected.

***

## Multi-location behaviour

* A customer can be registered at multiple locations without duplication.
* The **home location** (Invoicing Business) determines which location handles their billing.
* When viewing the customer list, you can switch between seeing only the current location's customers or all customers across your network.
* Adding or removing location associations requires edit access to the customer and the relevant location.

***

## Best practices

<Tip>
  Keep customer profiles complete — accurate email addresses ensure invoices and notifications reach them, and correct billing addresses keep your invoices compliant.
</Tip>

* **Grant online access** if the customer needs to use the portal or app. Without a user account, they cannot log in, make bookings, or pay invoices online.
* **Use tags** to segment customers (e.g., "Enterprise", "Freelancer", "Trial") for targeted communication, filtering, and reporting.
* **Set up billing details early** — configuring the payment provider and tax settings before the first invoice avoids manual corrections later.
* **Review access permissions** when onboarding — by default all permissions are enabled, but you can restrict specific capabilities per customer.
* **Set check-in alerts** for important situations (outstanding balances, VIP guests, special access needs) so front-desk staff are always informed.
* **Use attendance tracking** to plan occupancy and understand which days your space is busiest.

## Related pages

<CardGroup>
  <Card title="Teams" icon="people-group" href="/platform/operations/teams">
    Group customers into teams for shared billing and access.
  </Card>

  <Card title="Contracts" icon="file-signature" href="/platform/finance/contracts">
    Assign plans to customers to activate membership.
  </Card>

  <Card title="Plans" icon="layer-group" href="/platform/billing/plans">
    Configure the plans your customers can subscribe to.
  </Card>

  <Card title="Access Control" icon="lock" href="/platform/access-control/overview">
    Set up physical access systems linked to customer credentials.
  </Card>
</CardGroup>


# Operations
Source: https://learn.nexudus.com/platform/operations/overview

An introduction to the Operations module — where you manage your members, teams, bookings, check-ins, visitors, and support tickets.

## Overview

The Operations module is where you handle the day-to-day activity of your coworking space. It gives you a unified view of the people using your space, how they interact with your resources, and any support they need.

From here you can manage:

* Who is in your space (members, contacts, and visitors)
* How they organize (teams)
* What they book (meeting rooms, desks, equipment)
* When they arrive (check-ins)
* What they need help with (help desk)

## Sections

<CardGroup>
  <Card title="Members & Contacts" icon="users" href="/platform/operations/members">
    View, create, and manage all customer profiles — both active members and contacts without a plan.
  </Card>

  <Card title="Teams" icon="people-group" href="/platform/operations/teams">
    Group customers into teams for shared billing, access, and communication.
  </Card>

  <Card title="Visitors" icon="id-badge" href="/platform/operations/visitors">
    Track visitor arrivals, pre-register guests, and manage visitor logs.
  </Card>

  <Card title="Bookings" icon="calendar-check" href="/platform/operations/bookings">
    View and manage all resource bookings, including the booking calendar.
  </Card>

  <Card title="Check-ins" icon="right-to-bracket" href="/platform/operations/check-ins">
    Monitor who is currently in your space and review check-in history.
  </Card>

  <Card title="Help Desk" icon="headset" href="/platform/operations/help-desk">
    Manage support tickets submitted by your members.
  </Card>
</CardGroup>

## How to access

Navigate to **Operations** in the left sidebar. The section expands to show all available sub-pages depending on your role and enabled modules.

## Key concepts

| Term         | Meaning                                                                                                      |
| ------------ | ------------------------------------------------------------------------------------------------------------ |
| **Customer** | Any person in your system. Customers are either members (with an active contract) or contacts (without one). |
| **Member**   | A customer with at least one active contract. Membership is determined automatically by contract status.     |
| **Contact**  | A customer without an active contract. Contacts can still log in and interact with limited portal features.  |
| **Team**     | A group of customers — often representing a company — that can share plans, invoices, and access.            |
| **Booking**  | A reservation for a resource (room, desk, equipment) at a specific date and time.                            |
| **Check-in** | A record of a customer arriving at your space, captured via QR code, access card, app, or manual entry.      |

## Common workflows

<Accordion title="Onboarding a new customer">
  1. Go to **Operations → Members** and click **Add customer**.
  2. Fill in their profile details (name, email, company).
  3. Optionally assign them to a team.
  4. Create a contract under the **Contracts** tab to make them a member.
  5. They receive a welcome email and can log in to the Members Portal.
</Accordion>

<Accordion title="Handling a booking on behalf of a member">
  1. Go to **Operations → Bookings** and click **New booking**.
  2. Select the customer, resource, date, and time.
  3. Confirm the booking — the member is notified automatically.
</Accordion>

<Accordion title="Reviewing today's check-ins">
  1. Go to **Operations → Check-ins**.
  2. Filter by today's date to see who has arrived.
  3. Use this to monitor occupancy or verify access.
</Accordion>

<Accordion title="Responding to a help desk ticket">
  1. Go to **Operations → Help Desk**.
  2. Open a message to view the member's request.
  3. Reply directly — your response is sent to the member by email and appears in their portal.
</Accordion>

## Related pages

<CardGroup>
  <Card title="Billing & Products" icon="tag" href="/platform/billing/overview">
    Set up the plans, products, and resources that drive your operations.
  </Card>

  <Card title="Access Control" icon="lock" href="/platform/access-control/overview">
    Configure how members check in and access your space.
  </Card>
</CardGroup>


# Teams
Source: https://learn.nexudus.com/platform/operations/teams

How to create and manage teams in Nexudus — group customers into companies or departments for shared billing, benefits, and access.

## Overview

Teams let you group customers into logical units — typically companies, departments, or project groups. Teams unlock shared billing, pooled benefits, consolidated invoices, and a team profile visible in your members directory.

## How to access

Navigate to **Operations → Teams** in the left sidebar.

<Note>
  Requires the **team** role.
</Note>

## Key concepts

| Term                   | Meaning                                                                                              |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| **Team**               | A named group of customers. Can represent a company, department, or any logical grouping.            |
| **Team member**        | A customer who belongs to the team. A customer can belong to multiple teams.                         |
| **Team administrator** | A customer who can manage the team from the Members Portal (invite members, view team details).      |
| **Paying member**      | The customer whose account is charged for consolidated team invoices.                                |
| **Merged invoicing**   | When enabled, all team members' charges are consolidated into a single invoice to the paying member. |
| **Sign-up link**       | A unique URL that new or existing customers can use to join the team directly.                       |

***

## Creating a team

<Steps>
  <Step title="Click Add team">
    From the Teams list, click **Add team**.
  </Step>

  <Step title="Select the location">
    Choose which location this team belongs to.
  </Step>

  <Step title="Enter the team name">
    Give the team a descriptive name (e.g., "Acme Corp" or "Marketing Department"). This is the only required field.
  </Step>

  <Step title="Add a description (optional)">
    Provide context about the team for your staff.
  </Step>

  <Step title="Save">
    Click **Save** to create the team. You can then add members, configure billing, and set up benefits.
  </Step>
</Steps>

***

## Team profile tabs

### Details

Core team information and sign-up configuration:

| Field           | Description                                            |
| --------------- | ------------------------------------------------------ |
| **Location**    | The location this team belongs to (required)           |
| **Team name**   | The team's display name (required, max 254 characters) |
| **Description** | Internal description for your staff                    |

Once the team is saved, additional sign-up options appear:

| Field                 | Description                                                                                             |
| --------------------- | ------------------------------------------------------------------------------------------------------- |
| **Sign-up link**      | A unique URL customers can use to join this team. Share with new customers for self-service onboarding. |
| **Default plan**      | The plan automatically assigned when a customer joins via the sign-up link                              |
| **Maximum team size** | Limits how many members can join the team. Leave blank for unlimited.                                   |

<Tip>
  The sign-up link works for both new customers (who create an account) and existing customers (who log in and join the team). This is useful for companies onboarding their own staff.
</Tip>

***

### Members

An embedded customer list filtered to this team's members. From here you can:

* View all current team members with their profiles and plan status
* Add existing customers to the team
* Remove customers from the team

Adding or removing members is bidirectional — the change is reflected on both the team and the customer's profile.

***

### Billing

Configure how the team is billed:

| Field                              | Description                                                                                                                          |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Team paying customer**           | The customer whose account receives consolidated charges. Select a team member, or leave blank for individual billing.               |
| **Create single invoice for team** | When enabled, all team members' charges are merged into one invoice issued to the paying member. Requires a paying member to be set. |

<Warning>
  Merged invoicing consolidates all team members' charges (plan fees, bookings, products) onto the paying member's invoice at each billing cycle. All team members must share the same billing day for this to work correctly.
</Warning>

**What happens when you clear the paying member:**

Removing the paying member automatically resets all shared billing options:

* Create single invoice → disabled
* Transfer credits to paying member → disabled
* Share booking credit → disabled
* Share passes → disabled
* Share time credits → disabled

***

### Benefits

Configure discounts and shared credits for team members.

#### Discounts

Apply percentage discounts that apply to all team members:

| Field                     | Description                                      |
| ------------------------- | ------------------------------------------------ |
| **Bookings discount**     | Percentage discount on resource bookings         |
| **Passes discount**       | Percentage discount on passes                    |
| **Time credits discount** | Percentage discount on time and printing credits |
| **Charges discount**      | Percentage discount on one-off charges           |
| **Plans discount**        | Percentage discount on plan fees                 |

#### Credit and benefit sharing

| Setting                               | Description                                                    |
| ------------------------------------- | -------------------------------------------------------------- |
| **Transfer credits to paying member** | Moves all team members' credits to the paying member's balance |
| **Share passes**                      | Team members share a pooled set of passes                      |
| **Share time credits**                | Team members share a pooled set of time and printing credits   |
| **Share booking credit**              | Team members share a common booking credit balance             |

<Info>
  Benefit sharing requires a paying member to be set. When credits are shared, any team member can consume from the same pool — useful for companies that purchase credits centrally.
</Info>

The Benefits tab also shows:

* Team time credits and their usage
* Team passes
* Team booking credits
* Team printing credits
* A benefits summary
* Usage history

***

### Sales

A consolidated view of all commercial activity across team members:

* **Contracts** — all active and past contracts for team members
* **Products** — one-off or recurring purchases
* **Bookings** — aggregated booking history
* **Event attendees** — event registrations
* **Charges** — financial charges applied
* **Invoices** — all invoices (individual or merged)

***

### Profile

Public-facing team information shown in the Members Portal directory:

| Field                    | Description                                                                           |
| ------------------------ | ------------------------------------------------------------------------------------- |
| **Team administrators**  | Customers who can manage the team from the portal (invite members, edit team details) |
| **Summary**              | A description shown in the directory (supports rich text)                             |
| **Skills/industries**    | Tags for discovery and networking                                                     |
| **Publish to directory** | Toggle visibility in the Members Portal community directory                           |
| **Website**              | Team's external website URL                                                           |
| **Google Maps link**     | Location pin for the team's office                                                    |
| **Team logo**            | Logo image shown in the directory and team profile                                    |
| **Team images**          | Up to 3 gallery images for the team profile                                           |

***

### Integrations

Per-team integration settings:

| Field                                   | Description                                                           |
| --------------------------------------- | --------------------------------------------------------------------- |
| **Create a secure network for members** | Enables a dedicated VLAN for team members via Radius/WiFi integration |
| **VLAN identifier**                     | The VLAN ID to assign. Type "AUTO" to generate automatically.         |

***

## Access control inheritance

When a team has a **paying member**, access control is handled at the team level. If the paying member's contract is connected to plans or resources that grant physical access (door access, check-in rights, floor access), **all team members automatically inherit that access**.

This means:

* You only need to configure access on the **paying member's contract** — individual team members don't need their own access-granting contracts.
* When the paying member's contract includes access to specific doors, floors, or time slots, every member of the team receives the same access rights.
* If the paying member's contract ends or is suspended, all team members lose the inherited access.

<Info>
  This makes teams the primary unit for access control in company setups. The Company customer record holds the contract that grants access, and all employees in the team benefit from it automatically.
</Info>

### How it works with the recommended company setup

Using the [recommended company structure](#setting-up-a-company-recommended-approach):

1. The **Company customer record** (paying member) has a contract on a plan that grants 24/7 door access.
2. All **Individual customer records** in the team inherit that door access — they can check in and open doors without needing their own access-granting contract.
3. When a new employee joins the team, they immediately get access. When someone leaves the team, their access is revoked.

### What team members still need

While access rights are inherited from the paying member, each individual team member still needs:

* Their own **access card**, **PIN code**, or **access fob** configured on their customer profile (under Access rights) — these are the physical credentials used to identify them at doors and terminals.
* **Online access** (a user account) if they need to check in via the portal or mobile app.

<Tip>
  This model simplifies access management for companies: manage the access entitlement centrally on the Company record's contract, and manage physical credentials individually on each person's profile.
</Tip>

***

## Managing team members

### Adding members

You can add customers to a team in two ways:

1. **From the team:** Open the team → Members tab → add customers from the list.
2. **From the customer:** Open a customer profile → Account → Teams section → assign teams.

Both methods create the same bidirectional relationship.

### Removing members

Remove a customer from the Members tab or from their individual profile. Removing a team member does not delete their customer record or cancel their contracts.

### Team administrators

Team administrators are members with management permissions in the portal. They can:

* Invite new members to the team
* View team member information
* Manage team settings (depending on portal configuration)

Set administrators from the Profile tab.

***

## Sign-up links

Each team has a unique sign-up URL in the format:

```
{your-portal-url}/signup/{team-unique-id}
```

When a customer uses this link:

1. **New customers** create an account and are automatically added to the team.
2. **Existing customers** log in and join the team.
3. If a **default plan** is set, the customer is assigned that plan automatically.
4. If a **maximum team size** is set, the link stops accepting new members once the limit is reached.

<Tip>
  Share sign-up links with companies to let them self-onboard their staff. Combined with a default plan, this creates a fully automated onboarding flow.
</Tip>

***

## Setting up a company (recommended approach)

The recommended way to set up a company in Nexudus is to separate the **billing entity** (the company) from the **individuals** (the people who use the space). This keeps invoicing clean and lets you manage people independently from the company's financial relationship.

### Structure

```
Team: "Acme Corp"
├── Paying member: "Acme Corp" (Company customer record)
├── Member: "Jane Smith" (Individual customer record)
├── Member: "Tom Brown" (Individual customer record)
└── Member: "Sara Lee" (Individual customer record)
```

### Step-by-step setup

<Steps>
  <Step title="Create a Company customer record">
    Go to **Operations → Members & contacts** and create a new customer:

    * Set **Customer type** to **Company**
    * Enter the company name (e.g., "Acme Corp")
    * Fill in the company's billing email, billing address, and tax ID
    * You do **not** need to create a user account for this record — it exists purely for billing purposes
  </Step>

  <Step title="Create Individual customer records for each employee">
    Create a separate customer record for each person who will use the space:

    * Set **Customer type** to **Individual**
    * Enter their personal name and email
    * Enable **Create user account** so they can log in to the portal
    * Assign their plan (contract) to their individual record
  </Step>

  <Step title="Create the team">
    Go to **Operations → Teams** and create a new team with the company name.
  </Step>

  <Step title="Add all customers to the team">
    Add both the Company record and all Individual records as team members.
  </Step>

  <Step title="Set the Company record as the paying member">
    In the team's **Billing** tab, select the Company customer record as the **Team paying customer**.
  </Step>

  <Step title="Enable merged invoicing">
    Check **Create single invoice for team**. All charges for every team member (plans, bookings, products) will now be consolidated into a single invoice issued to the Company record.
  </Step>
</Steps>

<Info>
  If the person responsible for paying is also a user of the space (e.g., the company founder works from a desk), create **two customer records**: one Company record for billing and one Individual record for their personal use. This keeps their personal bookings and check-ins separate from the company's billing entity.
</Info>

### Why this approach works

* **Clean invoices** — the company receives one invoice with all charges, addressed to the company name and billing details.
* **Individual tracking** — each person's bookings, check-ins, and portal activity are tracked under their own profile.
* **Flexible contracts** — each team member can be on a different plan, yet all charges roll up to one invoice.
* **No login needed for the company record** — it exists solely as the billing entity. Only the individuals need portal access.
* **Easy staff changes** — when an employee leaves, remove them from the team. The company record and remaining members are unaffected.

***

## Merged invoicing in detail

When **Create single invoice for team** is enabled:

1. At each billing cycle, the system generates a single invoice addressed to the **paying member** (the Company record).
2. All charges from every team member are included — plan fees, bookings, product purchases, and one-off charges.
3. Each line item on the invoice identifies which team member incurred the charge.
4. The paying member's payment provider is used to collect payment automatically (if configured).

### Requirements

* A **paying member** must be set on the team.
* All team members should share the same **billing day** for charges to align correctly on the merged invoice.
* The paying member's billing address and tax settings are used on the consolidated invoice.

### What is not merged

* Invoices that were already generated before enabling merged billing remain on individual accounts.
* If a team member also belongs to another team with its own paying member, the charge goes to whichever team has merged invoicing enabled.

<Warning>
  Enabling merged invoicing does not retroactively move existing unpaid invoices. It only affects invoices generated from that point forward. Make sure to enable it before the next billing cycle.
</Warning>

***

## Other team billing scenarios

<Accordion title="Company provides shared credits">
  1. Set the Company record as the paying member.
  2. Enable **Share booking credit** and/or **Share passes** in the Benefits tab.
  3. Purchase credits or passes on the Company record's account.
  4. All team members can now consume from the shared pool.
</Accordion>

<Accordion title="Company gets a group discount">
  1. Set discount percentages in the Benefits tab (e.g., 10% bookings discount).
  2. All team members automatically receive the discount when making bookings or purchasing products.
  3. No paying member is required for discounts — they apply individually to each member's invoices.
</Accordion>

<Accordion title="Individual billing with team grouping">
  Leave the paying member blank. Each team member is billed individually. The team serves as an organizational grouping for filtering, communication, and access management — no billing consolidation occurs.
</Accordion>

***

## Best practices

* **Use a Company customer record as the paying member** rather than an individual person. This keeps invoices addressed correctly and avoids confusion when personnel changes occur.
* **Create separate Individual records** for each person using the space, even if one of them is also the company owner — this ensures their personal activity is tracked properly.
* **Use sign-up links** for company onboarding — it saves you from manually adding each employee.
* **Set a maximum team size** when the company has a fixed number of seats in their contract.
* **Assign team administrators** so the company's point of contact can manage their own members without needing your help.
* **Use the Profile tab** to make teams visible in the directory, helping members discover companies in your space for networking.
* **Enable merged invoicing before the billing cycle** — it only affects future invoices, not existing ones.

***

## Related pages

<CardGroup>
  <Card title="Members & Contacts" icon="users" href="/platform/operations/members">
    Manage individual customer profiles and assign them to teams.
  </Card>

  <Card title="Plans" icon="layer-group" href="/platform/billing/plans">
    Configure the plans that team members can be assigned to.
  </Card>

  <Card title="Invoices" icon="file-invoice" href="/platform/finance/invoices">
    View and manage team invoices, including merged billing.
  </Card>

  <Card title="Contracts" icon="file-signature" href="/platform/finance/contracts">
    Manage plan subscriptions for team members.
  </Card>
</CardGroup>


# Visitor Approval
Source: https://learn.nexudus.com/platform/operations/visitor-approval

Configure and manage the visitor approval workflow — require hosts to approve or reject walk-in visitors before granting access.

When visitors walk in without being pre-registered, you can require the host to approve the visit before granting access. This is especially useful for secure spaces or locations with a staffed front desk.

## Approval statuses

| Status                             | Meaning                                                                      |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| **Not required**                   | No approval needed — visitor is expected and accepted (default)              |
| **Requested**                      | Approval has been requested from the host; waiting for response              |
| **Rejected**                       | Host has rejected the visitor                                                |
| **Accepted — hold for collection** | Host approved; visitor should wait at reception for the host to collect them |
| **Accepted — grant access**        | Host approved; visitor can be directed to the host's desk or unit            |

***

## Configuring visitor approval

Visitor approval settings are found under **Settings → Apps and integrations → Companion apps → NexIO**.

| Setting                                                    | Effect                                                                                                                   |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Require host approval for walk-in visitors**             | Enables the approval flow. Walk-in visitors registered via NexIO receive a "Requested" status instead of "Not required". |
| **Automatically check approved visitors in**               | When enabled, an approved visitor is immediately checked in without staff intervention.                                  |
| **Host can choose to collect visitors at reception**       | Shows the "Accept — hold for collection" option in the approval email so the host can come to reception.                 |
| **Host can choose to send visitors to their unit or desk** | Shows the "Accept — grant access" option in the approval email so the visitor can proceed without escort.                |

<Info>
  You can disable either the "collect at reception" or the "grant access" response option to simplify the host's decision. If you disable both, only the reject option remains available.
</Info>

***

## When approval is triggered

Visitor approval is only triggered when **all** of the following are true:

1. The "Require host approval" setting is enabled for your location.
2. The visitor is registered via **NexIO** (walk-in self-registration at a kiosk or front-desk tablet).
3. A host (customer) is assigned to the visitor.

Visitors created **by staff in the Dashboard** or **by customers from the Members Portal** always receive a "Not required" status — they are considered pre-approved by nature of who registered them.

***

## How the approval flow works

<Steps>
  <Step title="Visitor self-registers at NexIO">
    The visitor enters their details and selects a host at the NexIO kiosk. The visitor's status is set to **Requested**.
  </Step>

  <Step title="Host receives an approval request">
    The system notifies the host through every channel you have enabled:

    * **Email** — always sent. The email contains action buttons to approve or reject.
    * **WhatsApp** — sent when the AI WhatsApp channel is enabled for the location and the host has a mobile number on their customer profile. See [Visitor approval on WhatsApp](visitor-approval-whatsapp).
    * **Mobile app push notification** — sent to hosts who have the Passport mobile app installed and signed in.

    The available actions depend on your settings:

    * **Accept — collect at reception**: Host will come to get the visitor.
    * **Accept — grant access**: Visitor can proceed to the host's desk.
    * **Reject**: Visitor is turned away.
  </Step>

  <Step title="Host responds">
    The host clicks one of the action links in the email, taps the Passport mobile app push notification, or replies to the WhatsApp message (with a number, a natural-language reply such as "approve Alex", or "approve all" for multiple visitors). The visitor's approval status is updated as soon as the host confirms the decision.
  </Step>

  <Step title="Staff and host are notified">
    Staff members subscribed to visitor notifications receive a system message indicating the visitor was accepted or rejected. If "Automatically check approved visitors in" is enabled and the host chose to grant access, the visitor is also checked in automatically.
  </Step>
</Steps>

***

## Visitor limits on plans

You can restrict how many visitors a customer can invite per day, week, or month by setting limits on their pricing plan. These limits are defined on each plan and enforced at the time a visitor is created:

| Plan setting           | Enforced when                                                          |
| ---------------------- | ---------------------------------------------------------------------- |
| **Visitors per day**   | Visitor's expected arrival falls on the same calendar day as the limit |
| **Visitors per week**  | Visitor's expected arrival falls in the same calendar week             |
| **Visitors per month** | Visitor's expected arrival falls in the same calendar month            |

If the customer exceeds the limit for their active plan(s), the visitor cannot be created and an error is displayed.

<Note>
  Visitor limits are cumulative across all active contracts — if a customer has two plans that both include visitor limits, the totals are summed.
</Note>

***

## Notification channels

### Email approval request

The system always sends an email to the host with action buttons to approve or reject the visitor. This email includes:

* The visitor's name, company, and reason for visit
* Expected arrival time
* Action buttons for each available response option

### WhatsApp approval

When the AI WhatsApp channel is enabled, hosts receive the approval request as a WhatsApp message and can reply with a number, in natural language, or process multiple visitors at once. See [Visitor approval on WhatsApp](visitor-approval-whatsapp) for full setup and configuration.

### Mobile app push notification

Hosts who have the Passport mobile app installed receive a push notification and can approve or reject directly from the app.

***

## Best practices

* **Enable approval for secure spaces** where you need explicit host permission before granting visitor access.
* **Use the "grant access" option** to reduce front-desk workload — approved visitors can proceed directly to the host's area.
* **Encourage hosts to use WhatsApp** for fastest response times, especially for mobile workers.
* **Set visitor limits on plans** to control how many guests members can invite and prevent abuse of the privilege.
* **Review pending approvals regularly** using the "Requested" status filter on the visitors list.

***

## Related pages

<CardGroup>
  <Card title="Visitors" icon="user-plus" href="visitors">
    Main visitor management — registration, check-in, and lifecycle.
  </Card>

  <Card title="Visitor Approval on WhatsApp" icon="whatsapp" href="visitor-approval-whatsapp">
    Configure WhatsApp approval messages and let hosts respond conversationally.
  </Card>

  <Card title="NexIO" icon="tablet-screen" href="/platform/apps/nexio">
    Configure the walk-in visitor self-registration kiosk.
  </Card>

  <Card title="Members & Contacts" icon="users" href="members">
    Manage the customers who host visitors.
  </Card>
</CardGroup>


# Visitor Approval on WhatsApp
Source: https://learn.nexudus.com/platform/operations/visitor-approval-whatsapp

Let hosts approve or reject their visitors by replying to a WhatsApp message. Configure the approval message, the response options, and the Twilio content template used outside the 24-hour messaging window.

When a walk-in visitor arrives at your NexIO front desk and selects a host, that host can be asked to approve the visit before access is granted. In addition to the standard approval email, Nexudus can also send the request over **WhatsApp** so the host can respond straight from their phone — by tapping a number, typing "approve", or asking your AI assistant to "approve all" pending visitors.

This page explains how to configure the WhatsApp visitor approval channel and how the flow works end to end.

<Note>
  This feature requires the AI WhatsApp channel to be set up first. If you have not connected WhatsApp yet, follow the [WhatsApp channel setup](/member-portal/ai/setup-whatsapp) guide before continuing.
</Note>

## What it does

When a visitor is registered via **NexIO** with a host assigned, visitor approval is required, and the AI WhatsApp channel is enabled for the location:

1. The host receives a WhatsApp message asking them to approve or reject the visitor.
2. The host replies — with **1**, **2**, **3**, or in their own words ("approve Alex and I'll collect them").
3. The visitor's approval status is updated on the visitor record, staff subscribed to visitor notifications are notified, and — if configured — the visitor is checked in automatically.

The host can also reply to your AI assistant at any time to list who is waiting ("any visitors?") or process multiple visitors at once ("approve all").

## Prerequisites

Before the WhatsApp approval message can be sent, all of the following must be true:

| Requirement                                                                                                                                          | Where to check                                            |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| **AI WhatsApp is enabled** for the location                                                                                                          | Settings → AI assistant → AI WhatsApp                     |
| **Visitor approval is required** for walk-in visitors at this location (the "Require host approval for walk-in visitors" checkbox in NexIO settings) | Settings → Apps and integrations → Companion apps → NexIO |
| **The host is a customer** with a saved **mobile phone number** in their profile                                                                     | Customer profile → Details                                |
| The visitor was registered through **NexIO** (walk-in), with a host assigned                                                                         | Visitor form → Host                                       |

If any of these conditions are not met, only the email approval request is sent. The WhatsApp message is silently skipped.

## Configure the approval message

The visitor approval settings are grouped together on the AI assistant page.

<Steps>
  <Step title="Open AI WhatsApp settings">
    In the Nexudus administration panel, go to **Settings → AI assistant** and scroll to the **AI WhatsApp** section. Make sure **AI WhatsApp** is toggled on.
  </Step>

  <Step title="Find the Visitor approval message block">
    Under AI WhatsApp, expand the **Visitor approval message** block. This is where you customise the message the host receives.
  </Step>

  <Step title="Fill in the fields">
    | Field                                                    | What it controls                                                                                                                                                                                                                             |
    | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Opt-in visitor approval message template content SID** | The Twilio content template SID (starts with `HX…`) used to reach the host when your last conversation with them on WhatsApp is more than 24 hours old. See [Create the Twilio content template](#create-the-twilio-content-template) below. |
    | **Custom approval message intro**                        | The first line of the approval message the host receives inside the 24-hour window. Use the placeholder `{{visitorName}}` to insert the visitor's name. The numbered options are appended automatically below this line.                     |
    | **"Approve, I'll collect them" label**                   | Label shown next to number 1 (or 2, depending on which options are enabled). Defaults to `Approve, I'll collect them`.                                                                                                                       |
    | **"Approve, send to my unit/desk" label**                | Label for the "grant access" option. Defaults to `Approve, send to my unit/desk`.                                                                                                                                                            |
    | **"Reject" label**                                       | Label for the rejection option. Defaults to `Reject`.                                                                                                                                                                                        |
  </Step>

  <Step title="Save">
    Click **Save** at the top of the page. The new message applies to the next visitor registered.
  </Step>
</Steps>

<Info>
  The **Approve, I'll collect them** and **Approve, send to my unit/desk** labels are disabled automatically if you have turned off the corresponding options in the NexIO visitor approval settings (`Host can choose to collect visitors at reception` / `Host can choose to send visitors to their unit or desk`). Only the options currently enabled for your location are shown to the host — and numbered accordingly.
</Info>

### What the host receives

With the default settings, a host with a pending visitor called Alex Smith receives a message that looks like this:

```
You have a visitor waiting for your approval: Alex Smith
1. Approve, I'll collect them
2. Approve, send to my unit/desk
3. Reject
```

If you customise the intro to, for example:

```
Hi! {{visitorName}} is at reception. Reply with one of the options below to let us know what you'd like to do.
```

…the host would see:

```
Hi! Alex Smith is at reception. Reply with one of the options below to let us know what you'd like to do.
1. Approve, I'll collect them
2. Approve, send to my unit/desk
3. Reject
```

## Create the Twilio content template

WhatsApp only allows you to send free-form messages to a customer if that customer has messaged your business on WhatsApp in the **last 24 hours**. Outside that window, WhatsApp requires you to send a **pre-approved template** — a fixed message reviewed by Meta.

For visitor approvals, Nexudus therefore uses a two-step flow when the host has not messaged you recently:

1. Send the pre-approved template asking the host to reply with the opt-in keyword (for example, "yes").
2. When the host replies with the keyword, the actual approval message (with the numbered options) is sent as a free-form follow-up.

<Steps>
  <Step title="Create a template in Twilio">
    In your Twilio Console, go to **Content > Templates** and click **Create Template**.

    Use a template that names the visitor and asks the host to reply to receive the approval options. For example:

    ```
    You have a visitor at reception: {{1}}. Reply YES to receive the approval options.
    ```

    The template uses a single variable:

    * `{{1}}` — the visitor's full name (Nexudus fills this in automatically for each approval request).

    Submit the template for Meta approval. Once approved, note its **Content SID** (starts with `HX`).
  </Step>

  <Step title="Paste the SID into Nexudus">
    Back in Nexudus, paste the SID into the **Opt-in visitor approval message template content SID** field under **AI WhatsApp → Visitor approval message**.
  </Step>

  <Step title="Confirm the opt-in keyword">
    The opt-in keyword is shared with the rest of the outbound messaging setup (**Settings → AI assistant → AI WhatsApp → Outbound messaging → Opt-in keyword**). It defaults to `yes` and is case-insensitive.
  </Step>
</Steps>

<Warning>
  If you leave the template SID empty, hosts who have not messaged you in the last 24 hours will not receive a WhatsApp approval request. The email approval request is still sent as normal.
</Warning>

## How the flow works

<Steps>
  <Step title="Visitor self-registers at NexIO">
    A guest walks in and registers at the NexIO kiosk. They select their host from the customer list. The visitor's approval status is set to **Requested**.
  </Step>

  <Step title="Nexudus sends the approval message">
    * **If the host has messaged your WhatsApp number in the last 24 hours**, Nexudus sends the customised approval message directly, with the numbered options.
    * **If not**, Nexudus first sends your approved Twilio template asking the host to reply with the opt-in keyword (e.g. "yes"). Once they reply with the keyword, the approval message with the numbered options is sent.

    The approval email is also sent, so the host can respond from whichever channel is more convenient.
  </Step>

  <Step title="Host replies on WhatsApp">
    The host can reply in whichever way is most natural:

    * **Number** — `1`, `2`, or `3`, matching the options shown in the message.
    * **By name** — `approve Alex`, `reject John`, `approve Maria and send her to my desk`, `approve Bob, I'll collect him`.
    * **By state** — if there is only one visitor waiting, `approve` on its own is enough.
    * **In bulk** — `approve all` processes every pending visitor for that host. The AI asks once which approval type to apply, then applies it to all of them.

    The host can also simply ask `any visitors?` or `who's waiting?` and the AI will list everyone currently pending.
  </Step>

  <Step title="AI confirms the choice">
    Before making any change, the AI reads the visitor's name, expected arrival time, and the chosen action back to the host, then asks them to confirm — for example:

    > Just to confirm: approve Alex Smith (expected at 10:30), option **Approve, I'll collect them**? Reply *confirm* to apply or *cancel* to abort.

    Nothing is updated until the host confirms.
  </Step>

  <Step title="Status is updated and staff are notified">
    Once confirmed, the visitor's approval status is set on the record — **Accepted — hold for collection**, **Accepted — grant access**, or **Rejected**. Staff members with **Visitor registration** notifications enabled receive a system message about the outcome.

    If the host chose **Approve, send to my unit/desk** and **Automatically check approved visitors in** is enabled in NexIO settings, the visitor is also checked in automatically at that moment.
  </Step>
</Steps>

### Handling multiple visitors

If a host mentions several visitors at once ("approve Bob but reject John"), the AI drafts each decision, presents a combined summary, and only applies the changes after the host confirms the full set. This makes it safe to process a busy morning of walk-ins in a single reply.

### If the AI cannot find the host

If the mobile number the host is messaging from does not match any customer profile, the AI asks the host to check the mobile number saved in their member profile. Approvals are only applied once the number can be matched to a customer.

## What happens on the visitor record

Regardless of whether the host replies by email, on WhatsApp, or via the Passport mobile app, the visitor record ends up in one of these states:

| Status on visitor record           | Meaning                                            |
| ---------------------------------- | -------------------------------------------------- |
| **Requested**                      | Waiting for the host's response                    |
| **Accepted — hold for collection** | Host will come to reception to collect the visitor |
| **Accepted — grant access**        | Visitor may proceed to the host's desk or unit     |
| **Rejected**                       | Host has turned the visitor away                   |

The status is visible in the callout at the top of the visitor form in the Nexudus administration panel and in the **Status** column on the visitors list.

## Turning it off for a specific location

* To stop sending WhatsApp approval requests entirely, turn off **AI WhatsApp** for the location.
* To keep the WhatsApp channel but skip the approval flow, disable **Require host approval for walk-in visitors** in the NexIO settings for that location. Visitors registered without approval requirements do not trigger a WhatsApp message.
* To remove one of the approval options (say, the "send to my unit/desk" option), toggle it off in NexIO settings. The corresponding option is automatically removed from the WhatsApp message and no longer accepted as a reply.

## Costs

The visitor approval message is sent via your Twilio WhatsApp sender. Twilio charges per WhatsApp conversation window in line with their [WhatsApp pricing](https://www.twilio.com/en-us/whatsapp/pricing). Nexudus does not add any extra charges.

Because the same 24-hour conversation window is reused for follow-up messages, a typical approval interaction (template + opt-in reply + approval message + host reply) costs one business-initiated conversation.

## Troubleshooting

<AccordionGroup>
  <Accordion title="The host never receives a WhatsApp message">
    Check, in order:

    * The host has a **mobile phone number** on their customer profile (including country code).
    * **AI WhatsApp** is enabled for the location.
    * **Require host approval for walk-in visitors** is enabled in NexIO settings for the location.
    * The visitor was registered via **NexIO** (visitors created by staff or by customers in the Members Portal do not trigger approval).
    * The Twilio **Auth Token** in Nexudus matches the current token in your Twilio Console.
  </Accordion>

  <Accordion title="The host receives the template but not the approval message">
    The template is sent when your last conversation with the host is more than 24 hours old. The follow-up message with the numbered options is only delivered when the host replies with the configured opt-in keyword (default: `yes`).

    * Ask the host to reply with the exact keyword.
    * Confirm the keyword under **Settings → AI assistant → AI WhatsApp → Outbound messaging → Opt-in keyword**.
    * If the host replies with something else, the template expires quietly after 24 hours and no approval message is sent.
  </Accordion>

  <Accordion title="The host replied but the visitor's status did not update">
    The AI always asks the host to confirm before applying a decision. If the host did not reply *confirm* (or an equivalent), the decision was drafted but not applied.

    * Ask the host to check the last message from the AI — it will either be the confirmation prompt (needs a `confirm` reply) or a message saying the confirmation window expired (needs a fresh reply).
  </Accordion>

  <Accordion title="The AI says it cannot match the phone number">
    The mobile number the host is messaging from does not match the mobile number stored on their customer profile. Update the customer's mobile number in the administration panel — including the country code and `+` prefix — and ask the host to send their reply again.
  </Accordion>

  <Accordion title="I want to change the wording after approval, not just the intro">
    The numbered option labels (`Approve, I'll collect them`, `Approve, send to my unit/desk`, `Reject`) are configurable in **AI WhatsApp → Visitor approval message**. Change any of them to match the language your hosts already use.

    The confirmation prompt shown by the AI cannot currently be customised.
  </Accordion>
</AccordionGroup>

## Related pages

<CardGroup>
  <Card title="Visitors" icon="user-plus" href="visitors">
    Main visitor management — registration, check-in, and lifecycle.
  </Card>

  <Card title="Visitor Approval" icon="circle-check" href="visitor-approval">
    Configure the visitor approval workflow and response options.
  </Card>

  <Card title="WhatsApp channel setup" icon="whatsapp" href="/member-portal/ai/setup-whatsapp">
    Connect your Twilio account and register a WhatsApp sender before configuring visitor approvals.
  </Card>
</CardGroup>


# Visitors
Source: https://learn.nexudus.com/platform/operations/visitors

How to track and manage visitors in Nexudus — register guests, manage tours, handle visitor approvals, and link visitors to bookings.

## Overview

The **Visitors** page lets you track everyone coming into your space who isn't a member — guests visiting your customers, people touring your space, or attendees of meetings booked by your members. You can register visitors in advance, check them in on arrival, notify hosts, and manage approval workflows.

Visitors can also be linked to specific bookings as guests, which connects them to the resource, time slot, and host for that meeting.

## How to access

Navigate to **Operations → Visitors** in the left sidebar.

<Note>
  Requires the **visitor** role.
</Note>

## Key concepts

| Term                 | Meaning                                                                                                                                          |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Visitor**          | A person coming to your space who is not a member — a guest, prospect, or meeting attendee.                                                      |
| **Host**             | The customer (member or contact) who the visitor is coming to see.                                                                               |
| **Booking visitor**  | A visitor linked to a specific booking. This connects the visitor to a resource reservation (e.g., "Guest for Jane's meeting in Room A at 2pm"). |
| **Tour**             | A visit specifically for someone interested in your space. Tours have a separate confirmation workflow.                                          |
| **Visitor approval** | A workflow where the host must approve or reject a visitor before they are granted access.                                                       |
| **Visitor code**     | An auto-generated unique code the visitor can use to check in at your front desk or kiosk.                                                       |

***

## Visitor types

The list view shows each visitor's type as a badge:

| Type               | Meaning                                                     |
| ------------------ | ----------------------------------------------------------- |
| **Visitor**        | A standard guest visiting a customer                        |
| **Booking guest**  | A visitor linked to a specific resource booking             |
| **Tour request**   | Someone requesting a tour of your space (not yet confirmed) |
| **Confirmed tour** | A tour that has been confirmed by your team                 |

***

## Creating a visitor

<Steps>
  <Step title="Click Add visitor">
    From the Visitors list, click the **Add** button.
  </Step>

  <Step title="Enter visitor details">
    Fill in the required fields:

    * **Full name** (required)
    * **Email** (required)
    * **Expected arrival** (required — date and time in 15-minute intervals)

    Optional fields:

    * **Phone number**
    * **Company name**
    * **Reason for the visit**
    * **Internal notes** (visible only to your staff)
  </Step>

  <Step title="Assign a host (optional)">
    Select the customer this visitor is coming to see. This enables host notifications and the approval workflow.
  </Step>

  <Step title="Mark as tour (optional)">
    Check **This visitor is coming for a tour** if they are a prospective customer touring your space rather than visiting an existing member.
  </Step>

  <Step title="Check in immediately (optional)">
    Enable **Check this visitor in now** if the visitor is already at your front desk. This sets their arrival time to now.
  </Step>

  <Step title="Save">
    Click **Save**. The visitor receives a check-in code automatically, and the host is notified if applicable.
  </Step>
</Steps>

***

## Visitor form fields

### Details tab

#### Visitor information

| Field                    | Description                                                        |
| ------------------------ | ------------------------------------------------------------------ |
| **Location**             | Which location this visitor is expected at (required)              |
| **Full name**            | Visitor's full name (required)                                     |
| **Email**                | Visitor's email address (required)                                 |
| **Phone number**         | Contact phone number                                               |
| **Company name**         | The visitor's company                                              |
| **Customer notes**       | Notes from the host/customer about this visit (read-only in admin) |
| **Internal notes**       | Private notes for your staff (not visible to the visitor or host)  |
| **Reason for the visit** | Why the visitor is coming                                          |

#### Arrival and departure

| Field                         | Description                                                               |
| ----------------------------- | ------------------------------------------------------------------------- |
| **Check this visitor in now** | Immediately marks the visitor as arrived (only available during creation) |
| **Expected arrival**          | Date and time the visitor is expected (required; locked once arrived)     |
| **Arrived on**                | Actual arrival date and time (set automatically on check-in; read-only)   |
| **Left on**                   | Departure date and time (read-only)                                       |

#### Host

| Field                                 | Description                                           |
| ------------------------------------- | ----------------------------------------------------- |
| **Host**                              | The customer this visitor is coming to see (optional) |
| **This visitor is coming for a tour** | Marks the visit as a prospective space tour           |

### Customers tab

If the visitor's email matches an existing customer record, this tab shows the linked customer profiles. This helps you identify return visitors who may already be in your system.

***

## Visitor approval

When visitors walk in without being pre-registered, you can require the host to approve the visit before granting access. Hosts can respond via email, WhatsApp, or the mobile app.

For full details on configuring and using the approval workflow, see:

* [Visitor Approval](visitor-approval) — configure approval settings, understand statuses, and manage the approval flow
* [Visitor Approval on WhatsApp](visitor-approval-whatsapp) — let hosts approve visitors conversationally via WhatsApp

***

## Visitors and bookings (booking guests)

Visitors can be linked to specific resource bookings through the **booking visitor** relationship. This is how you track guests attending a meeting booked by one of your members.

### How it works

* When a customer books a meeting room, they can add visitors (guests) to that booking.
* Each guest becomes a **booking visitor** — a link between the visitor record and the booking record.
* The visitor list shows these as **"Booking guest"** with the resource name (e.g., "For Jane Smith at Meeting Room A").
* A single visitor can be a guest at multiple bookings, and a single booking can have multiple visitors.

### Who can add booking visitors

Visitors can only be added to bookings that have a host (a customer associated with the booking). Bookings without a customer cannot have visitors.

### Where booking visitors appear

* On the **Visitors list** — shown with a purple "Booking guest" badge and the resource name
* On the **Booking detail** — listed as guests for that reservation
* The visitor's check-in code can be used by the guest to self-identify at reception

### Notifications

When a visitor is added to a booking, the system can send:

* A **booking confirmation** email to the customer who made the booking
* A **visitor invite** email to the visitor with details about the visit

These notifications depend on your location's email settings.

<Note>
  If the "Do not register known customers as visitors" setting is enabled, existing customers added as booking guests will not generate a new visitor record.
</Note>

***

## Visitor lifecycle

A visitor moves through these stages:

```
Expected → Arrived (checked in) → Departed (checked out)
```

### Check-in

A visitor can be checked in by:

* **Staff at front desk** — set the arrival date on the visitor record or use the "Check in now" flag on creation
* **Self-check-in** — the visitor uses their unique visitor code at a kiosk or NexIO terminal
* **AI agent** — visitors can register through an AI-powered channel and be checked in automatically

### Check-out

Set the **departure date** on the visitor record when they leave. This moves their status to "Departed".

***

## Visitor sources

Each visitor record tracks how it was created:

| Source            | Description                                                                            |
| ----------------- | -------------------------------------------------------------------------------------- |
| **Administrator** | Created manually by a staff member in the Dashboard                                    |
| **Customer**      | Created by the host customer from the Members Portal (pre-registering their own guest) |
| **NexIO**         | Created via self-registration at a kiosk, public booking portal, or AI agent           |

***

## The visitor list

### Default view

The list initially shows visitors **expected from today onwards who have not yet arrived** — your upcoming visitor schedule.

### Quick filter segments

| Segment             | Shows                                                   |
| ------------------- | ------------------------------------------------------- |
| **Expected today**  | Visitors expected today who haven't arrived yet         |
| **Expected**        | All future expected visitors (not yet arrived)          |
| **Requested tours** | Tour requests that haven't been confirmed               |
| **Expected tours**  | Confirmed tours with upcoming expected arrival          |
| **On site**         | Visitors who arrived today and haven't departed         |
| **Arrived**         | All visitors who have arrived (regardless of departure) |

### List columns

| Column            | Details                                                                                                                    |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Full name**     | Visitor name with host information (e.g., "For Jane Smith" or "For Jane Smith at Meeting Room A")                          |
| **Check-in code** | The visitor's unique code for self-check-in                                                                                |
| **Expected on**   | Expected arrival time; shows actual arrival/departure times once checked in                                                |
| **Type**          | Badge: Visitor, Booking guest, Tour request, or Confirmed tour                                                             |
| **Status**        | Approval status (Approved, Pending, Rejected, Grant access, Hold for collection) or check-in status (Checked in, Departed) |

### Filtering

You can filter the visitor list by:

* Host customer or team
* Location
* Visitor source (Administrator, Customer, NexIO)
* Approval status
* Tour status (tour vs. regular visit, confirmed vs. unconfirmed)
* Arrival status
* Resource name (for booking guests)
* Date ranges (expected arrival, actual arrival, departure)

***

## Tours

Tours are a special type of visitor for prospective customers evaluating your space.

### Tour workflow

<Steps>
  <Step title="Tour request received">
    A tour can be requested by the prospect (via the portal or AI agent) or created by your staff. It appears as a "Tour request" in the list.
  </Step>

  <Step title="Confirm the tour">
    Set **Tour confirmed** to schedule the tour. The visitor moves to "Confirmed tour" status.
  </Step>

  <Step title="Visitor arrives">
    Check the visitor in on arrival. You can then give them the tour.
  </Step>

  <Step title="Follow up">
    After the tour, the visitor record remains for your team to follow up — you can convert them into a customer if they decide to join.
  </Step>
</Steps>

<Tip>
  Use the "Requested tours" and "Expected tours" quick filters to keep track of your tour pipeline separately from regular visitor traffic.
</Tip>

***

## Notifications and emails

The system sends different notifications depending on the visitor's type, source, and approval status.

### Visitor emails

| Email                        | Sent to         | When                                                                                                                                                                                                                          |
| ---------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Visitor registered**       | Visitor         | When the visitor is created and either no approval is required, or approval has been granted. If a future expected arrival is set and scheduled notifications are enabled, the email is sent 24 hours before arrival instead. |
| **Visitor approval request** | Host (customer) | When the visitor is created via NexIO and visitor approval is required. Contains approve/reject action links.                                                                                                                 |
| **Visitor check-in**         | Host (customer) | When the visitor arrives and checks in (only if the host has approved or no approval is required).                                                                                                                            |

### WhatsApp approval message

When the AI WhatsApp channel is enabled for the location and the host has a mobile number on their customer profile, the approval request is also delivered as a WhatsApp message. The host can reply with a number, a name, or "approve all" for multiple visitors. See [Visitor approval on WhatsApp](visitor-approval-whatsapp) for the full setup and message customisation options.

### Staff notifications

| Notification           | Sent to                                                         | When                                                 |
| ---------------------- | --------------------------------------------------------------- | ---------------------------------------------------- |
| **Visitor registered** | Staff members with "Visitor registration" notifications enabled | When any visitor is created                          |
| **Visitor accepted**   | Staff members with "Visitor registration" notifications enabled | When a host accepts a visitor via the approval email |
| **Visitor rejected**   | Staff members with "Visitor registration" notifications enabled | When a host rejects a visitor via the approval email |

### Push notifications

When a visitor checks in and the host has a mobile device registered, the system sends a push notification saying "You have a visitor: \[visitor name]".

### Webhooks

| Webhook               | Triggered when                                |
| --------------------- | --------------------------------------------- |
| `VisitorRegistered`   | A new visitor is created                      |
| `VisitorCheckedin`    | A visitor checks in                           |
| `VisitorNotification` | A scheduled notification is sent to a visitor |
| `VisitorDeleted`      | A visitor record is deleted                   |

<Tip>
  To receive staff notifications for visitor events, go to your user profile and enable the **Visitor registration** notification preference.
</Tip>

***

## Access control for visitors

Visitors can be integrated with your access control system:

* When a visitor's approval status is set to **Accepted — grant access**, the system can schedule access control jobs to unlock doors or grant temporary credentials.
* The `AccessControlScheduledJobId` tracks automated access grants for the visitor's expected time window.
* Access is scoped to the visit duration (from expected arrival to expected departure or check-out).

***

## AI agent registration

If your location has AI channels configured, visitors can self-register through a conversational AI agent. When this happens:

* The visitor record is created with source **NexIO**
* The conversation history between the visitor and the AI agent is stored and displayed on the visitor's form in the admin Dashboard
* Staff can review the full conversation to understand what the visitor needs

***

## Best practices

* **Pre-register visitors** whenever possible — it speeds up the check-in process and ensures the host is notified in advance.
* **Use the visitor approval workflow** for secure spaces where you need the member's explicit permission before allowing a guest in.
* **Link visitors to bookings** for meeting room guests — this provides full context (who, where, when) and enables the right notifications.
* **Review the "Expected today" segment** each morning to prepare for the day's visitors.
* **Track tours separately** using the tour flag so your sales pipeline is visible alongside daily visitor traffic.
* **Encourage customers to pre-register their own visitors** from the Members Portal — this reduces your front-desk workload and ensures accurate host assignment.

***

## Related pages

<CardGroup>
  <Card title="Visitor Approval" icon="circle-check" href="visitor-approval">
    Configure the visitor approval workflow and response options.
  </Card>

  <Card title="Visitor Approval on WhatsApp" icon="whatsapp" href="visitor-approval-whatsapp">
    Let hosts approve visitors conversationally via WhatsApp.
  </Card>

  <Card title="Bookings" icon="calendar-check" href="bookings">
    Manage resource bookings that visitors may be attending as guests.
  </Card>

  <Card title="Check-ins" icon="right-to-bracket" href="check-ins">
    Monitor who is currently on site, including visitors.
  </Card>

  <Card title="Members & Contacts" icon="users" href="members">
    Manage the customers who host visitors.
  </Card>

  <Card title="Access Control" icon="lock" href="/platform/access-control/overview">
    Configure how visitors are granted physical access.
  </Card>
</CardGroup>


# What is the Nexudus Dashboard
Source: https://learn.nexudus.com/platform/overview

An introduction to the Nexudus Dashboard — the central hub where coworking operators manage their spaces, members, billing, and more.

## Overview

The Nexudus Dashboard is your central command center for managing every aspect of your coworking space. From member management and bookings to billing and analytics, the Dashboard gives you full control over your operations in one place.

Whether you run a single location or a global network of spaces, the Dashboard adapts to your needs with modular features you can enable as your business grows.

<Frame>
  <img alt="Nexudus Dashboard home screen" />
</Frame>

## What you can do

The Dashboard is organized into modules, each focused on a specific area of your business:

<CardGroup>
  <Card title="Operations" icon="users" href="/platform/operations/overview">
    Manage your members, teams, bookings, check-ins, and support tickets.
  </Card>

  <Card title="Billing & Products" icon="tag" href="/platform/billing/overview">
    Set up plans, products, resources, and pricing for your space.
  </Card>

  <Card title="Finance" icon="file-invoice" href="/platform/finance/overview">
    Handle invoices, contracts, payment gateways, and accounting integrations.
  </Card>

  <Card title="CRM" icon="address-book" href="/platform/crm/overview">
    Track leads, manage opportunities, send proposals, and organize tasks.
  </Card>

  <Card title="Content" icon="newspaper" href="/platform/content/overview">
    Create events, articles, courses, newsletters, and community features.
  </Card>

  <Card title="Access Control" icon="lock" href="/platform/access-control/overview">
    Configure check-in methods, door access integrations, and WiFi authentication.
  </Card>

  <Card title="Settings" icon="gear" href="/platform/settings/overview">
    Configure your locations, users, email templates, automations, and integrations.
  </Card>

  <Card title="Analytics" icon="chart-line" href="/platform/analytics/overview">
    View dashboards, build custom reports, and monitor your business health.
  </Card>
</CardGroup>

## Key concepts

Before diving in, here are a few terms used throughout the platform:

| Term         | Meaning                                                                                                       |
| ------------ | ------------------------------------------------------------------------------------------------------------- |
| **Location** | A physical coworking space you manage in Nexudus. Each location has its own settings, resources, and pricing. |
| **Customer** | Any person registered in your system — either a member or a contact.                                          |
| **Member**   | A customer with at least one active contract (plan subscription).                                             |
| **Contact**  | A customer without an active contract.                                                                        |
| **Plan**     | A subscription package that defines what a member gets (desk access, credits, discounts, etc.).               |
| **Resource** | Anything that can be booked — meeting rooms, desks, parking spots, equipment.                                 |
| **Contract** | The link between a customer and a plan, defining the membership period and billing terms.                     |

<Info>
  Membership is automatic — when a customer gets an active contract, they become a member. When all contracts end, they become a contact again.
</Info>

## How the Dashboard connects to the Members Portal

The Dashboard and the [Members Portal](/member-portal/overview) work together:

* **You configure** plans, resources, events, and content in the Dashboard.
* **Your members see** the results in the Members Portal — available bookings, their invoices, community features, and more.

Every setting you change in the Dashboard affects what members experience in the portal. For a deeper look at this relationship, see [How Admin Settings Affect Members](/get-started/platform-overview/how-configuration-flows-to-members).

## Next steps

<CardGroup>
  <Card title="Navigate the Dashboard" icon="compass" href="/platform/navigation">
    Learn how to find your way around the sidebar, header, and quick actions.
  </Card>

  <Card title="Roles & Permissions" icon="shield" href="/platform/roles-and-permissions">
    Understand who can access what in your team.
  </Card>

  <Card title="Multi-Location" icon="building" href="/platform/multi-location">
    Manage multiple spaces from a single account.
  </Card>
</CardGroup>


# Roles and Permissions
Source: https://learn.nexudus.com/platform/roles-and-permissions

Understand how user roles control access to features and data in the Nexudus Dashboard.

## Overview

The Nexudus Dashboard uses a role-based access system to control what each team member can see and do. This ensures that staff only access the tools they need, keeping your data secure and your workflows focused.

## How roles work

Each user in your Dashboard is assigned one or more roles. Roles determine:

* Which modules and pages are visible in the sidebar
* Which records the user can view, create, edit, or delete
* Which settings the user can change
* Which locations the user can access

<Info>
  A user can have multiple roles combined. Permissions are additive — if any assigned role grants access to a feature, the user can access it.
</Info>

## Built-in role levels

Nexudus provides several levels of access that can be combined to create the right permissions for each team member:

### Platform Administrator

Full access to all locations, settings, and features. Platform administrators can:

* Manage all locations in the network
* Create and manage other users and their roles
* Configure billing, integrations, and global settings
* Access all modules without restriction

<Warning>
  Limit the number of platform administrators. This role has unrestricted access to all data and settings across your entire Nexudus account.
</Warning>

### Location Manager

Day-to-day management access for one or more specific locations:

* View and manage members, bookings, and check-ins
* Handle invoices and billing
* Manage resources and content
* Access reports and analytics for assigned locations

### Front Desk / Operations Staff

Focused access for handling daily operations:

* Check members in and out
* Create and manage bookings
* View member profiles
* Handle help desk messages and visitor logs

### Finance

Access to financial tools and records:

* View and manage invoices
* Process payments and refunds
* Access contracts and billing runs
* Export financial data

### CRM

Access to sales and relationship management tools:

* Manage CRM boards and opportunities
* Create and send proposals
* Track tasks and reminders
* Handle document templates

## Module-based access

In addition to roles, some features are only available if the corresponding module is enabled for your location. For example:

| Module      | Features unlocked               |
| ----------- | ------------------------------- |
| CRM Boards  | Pipeline boards, opportunities  |
| Courses     | Course creation and management  |
| Video Rooms | Video collaboration rooms       |
| Surveys     | Feedback surveys and form pages |

<Note>
  If you don't see a feature in your sidebar, it may be because the module isn't enabled for your location or your role doesn't include access to it. Contact your platform administrator to enable modules.
</Note>

## Managing users and roles

To manage who has access to your Dashboard:

<Steps>
  <Step title="Go to Settings">
    Navigate to **Settings → Users & Roles** in the sidebar.
  </Step>

  <Step title="Add or edit a user">
    Create a new user or select an existing one to modify their role assignments.
  </Step>

  <Step title="Assign roles">
    Select the roles that match the user's responsibilities. You can assign multiple roles to create a custom permission set.
  </Step>

  <Step title="Assign locations">
    Choose which locations the user can access. This limits their view to only the relevant spaces.
  </Step>

  <Step title="Save">
    Confirm the changes. The user's sidebar and available features will update immediately.
  </Step>
</Steps>

## Best practices

<Tip>
  Follow the principle of least privilege — give each user only the access they need to perform their job.
</Tip>

* **Create specific roles** for different job functions rather than giving everyone administrator access.
* **Review access regularly** when team members change roles or leave your organization.
* **Use location restrictions** to prevent staff at one location from accidentally modifying data at another.
* **Test as the user** by signing in with a test account to verify that the right features are visible.

## Related pages

<CardGroup>
  <Card title="Users & Roles Settings" icon="user-gear" href="/platform/settings/users-and-roles">
    Detailed guide to configuring users and custom roles.
  </Card>

  <Card title="Multi-Location Management" icon="building" href="/platform/multi-location">
    Control access across multiple locations.
  </Card>
</CardGroup>


# Account Menu Visibility
Source: https://learn.nexudus.com/platform/settings/account-menu-visibility

Control which sections appear in the account menu of the members portal by hiding or showing specific menu items.

## Overview

Account menu visibility settings let you control which sections appear in the members portal navigation for your customers. By toggling individual menu items on or off, you can customize the portal experience to match the services your location offers.

These settings work alongside [feature configuration](/operators/portal-configuration/features/features-configuration) and [access control](/operators/portal-configuration/access) to provide granular control over what customers see and can access in their portal.

Navigate to [**Settings → Website → Account Menu**](https://dashboard.nexudus.com/settings/2/0/8) in your Nexudus dashboard to configure these settings.

## How it works

Each menu item in the portal can be hidden independently. When a setting is enabled (set to `true`), the corresponding menu item is hidden from customers. When disabled (set to `false` or not set), the menu item remains visible.

This gives you fine-grained control — for example, you might want to hide the billing details section while keeping personal details visible, or hide the directory profile section if you're not using the directory feature.

## Available Settings

### My Account Section

These settings control the visibility of subsections within the **My Account** area of the portal:

| Setting Key                                    | Menu Item          | Description                                                                        |
| ---------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------- |
| `PublicWebsite.Account.PersonalDetails.Hide`   | Personal details   | Hides the section where customers can view and edit their personal information     |
| `PublicWebsite.Account.BillingDetails.Hide`    | Billing details    | Hides the section where customers can manage their billing address and information |
| `PublicWebsite.Account.PaymentMethods.Hide`    | Payment methods    | Hides the section where customers can add, edit, or remove payment methods         |
| `PublicWebsite.Account.PlansAndBenefits.Hide`  | Plans and benefits | Hides the section showing active plans, benefits, and contract details             |
| `PublicWebsite.Account.DirectoryProfiles.Hide` | Directory profile  | Hides the section where customers can manage their public directory listing        |
| `PublicWebsite.Account.Settings.Hide`          | Settings           | Hides the account settings section for notifications and preferences               |

### My Activity Section

These settings control the visibility of subsections within the **My Activity** area:

| Setting Key                                | Menu Item  | Description                                                      |
| ------------------------------------------ | ---------- | ---------------------------------------------------------------- |
| `PublicWebsite.MyActivity.Invoices.Hide`   | Invoices   | Hides the section where customers can view their invoice history |
| `PublicWebsite.MyActivity.Bookings.Hide`   | Bookings   | Hides the section showing upcoming and past bookings             |
| `PublicWebsite.MyActivity.Visitors.Hide`   | Visitors   | Hides the section for managing visitor registrations             |
| `PublicWebsite.MyActivity.Deliveries.Hide` | Deliveries | Hides the section for tracking mail and package deliveries       |
| `PublicWebsite.MyActivity.Events.Hide`     | Events     | Hides the section showing upcoming and past events               |
| `PublicWebsite.MyActivity.Courses.Hide`    | Courses    | Hides the section for viewing enrolled courses and progress      |

### My Team Section

These settings control the visibility of subsections within the **My Team** area:

| Setting Key                           | Menu Item   | Description                                |
| ------------------------------------- | ----------- | ------------------------------------------ |
| `PublicWebsite.Team.Bookings.Hide`    | Bookings    | Hides the team bookings overview           |
| `PublicWebsite.Team.Profile.Hide`     | Profile     | Hides the team profile management section  |
| `PublicWebsite.Team.Members.Hide`     | Members     | Hides the team members list and management |
| `PublicWebsite.Team.Attendance.Hide`  | Attendance  | Hides the team attendance tracking section |
| `PublicWebsite.Team.Permissions.Hide` | Permissions | Hides the team permissions configuration   |

### Building Section

These settings control the visibility of subsections within the **Building** area:

| Setting Key                                | Menu Item    | Description                               |
| ------------------------------------------ | ------------ | ----------------------------------------- |
| `PublicWebsite.Building.Availability.Hide` | Availability | Hides the building availability calendar  |
| `PublicWebsite.Building.Environment.Hide`  | Environment  | Hides the environmental sensors dashboard |

## Configuration Process

<Steps>
  <Step title="Access Account Menu Settings">
    Navigate to [**Settings → Website → Account Menu**](https://dashboard.nexudus.com/settings/2/0/8) in your Nexudus dashboard.
  </Step>

  <Step title="Toggle Menu Items">
    For each menu item you want to hide, toggle the corresponding setting to `true`. To show a menu item, ensure the setting is `false` or not set.
  </Step>

  <Step title="Test the Portal">
    Review the members portal to verify that the hidden menu items are no longer visible to customers.
  </Step>
</Steps>

## How Settings Interact

### Feature Enablement vs. Menu Visibility

There are two layers of control:

1. **Feature enablement** — Controls whether a feature is available at all (e.g., "Help-desk" on/off)
2. **Menu visibility** — Controls whether the menu item appears in the navigation, even if the feature is enabled

A menu item will only appear if both conditions are met:

* The feature is enabled
* The menu visibility setting is not hiding it

### Access Control vs. Menu Visibility

[Access control settings](/operators/portal-configuration/access) determine *who* can access a section (everyone, logged-in users, members only, contacts only), while menu visibility settings determine *whether* the menu item appears at all.

If a section is hidden via menu visibility, customers won't see the menu item regardless of their access level.

## Best Practices

<Note>
  * **Hide selectively** — Only hide menu items for features you're not using. Hiding too many items may confuse customers who expect to find certain sections.
  * **Test before deploying** — Always review the portal after making changes to ensure the navigation still makes sense for your customers.
  * **Consider access levels** — If you want to restrict access to certain sections, consider using [access control](/operators/portal-configuration/access) instead of hiding menu items entirely.
</Note>

## Related Documentation

* [Features Configuration](/operators/portal-configuration/features/features-configuration) — Enable or disable portal features
* [Access Control](/operators/portal-configuration/access) — Control who can access each section
* [Navigation Settings](/platform/navigation) — Configure portal navigation structure


# Automation tiles
Source: https://learn.nexudus.com/platform/settings/automation-tiles

Configure NFC and QR automation tiles that trigger actions in your location.

## Overview

An **automation tile** is a physical NFC or QR tile that can trigger an action when a customer scans or taps it. Tiles can support workflows such as check-in, reservations, or access-related actions, with optional customer, location, resource, plan, or pass restrictions.

Go to **Settings → Modules → Automation tiles**. You need the automation-tile permission or administrator access.

## Create an automation tile

<Steps>
  <Step title="Open Automation tiles">
    Go to **Settings → Modules → Automation tiles** and add a tile.
  </Step>

  <Step title="Identify the physical tile">
    Enter a clear name. After saving the tile, use its generated QR code or tile URL to configure the physical NFC or QR tile.
  </Step>

  <Step title="Choose the action">
    Select the action the tile should perform and provide any action parameters it requires.
  </Step>

  <Step title="Set restrictions">
    Limit the tile to the appropriate resources, plans, passes, or floor plan units. Configure check-in and geofence controls if needed.
  </Step>

  <Step title="Set customer messages">
    Add the success and error messages shown after a scan, then save and test the tile on site.
  </Step>
</Steps>

## Field reference

| Field                      | Description                                                |
| -------------------------- | ---------------------------------------------------------- |
| Name                       | Internal name for the tile                                 |
| Action                     | The action Nexudus performs after a scan                   |
| Action parameters          | Additional information required by the selected action     |
| Check customer in          | Records a check-in as part of the tile action when enabled |
| Enable geofence            | Requires the customer to be within the configured area     |
| Latitude and longitude     | The centre point of the permitted geofence                 |
| Maximum distance           | The permitted distance from the centre point               |
| Success and error messages | Feedback shown after a scan succeeds or fails              |

## Restrictions and audit history

Use restrictions to prevent a tile from being used for the wrong resource, plan, pass, or floor plan unit. Nexudus records tile activity in the **Tile activity log**, where you can review successful and failed scans when troubleshooting.

<Warning>
  Test every tile with the actual customer permissions and location conditions that will apply in use. A tile that works for an administrator may be unavailable to a customer because of a pass, plan, geofence, or resource restriction.
</Warning>

## Related pages

* [Check-ins](/platform/operations/check-ins)
* [Floor plan editor](/platform/settings/floor-plan-editor)
* [Access control overview](/platform/access-control/overview)


# Custom domains
Source: https://learn.nexudus.com/platform/settings/domains

Connect and manage a custom domain for your location's members portal.

## Overview

A **custom domain** gives your members portal an address that uses your own domain, instead of the standard Nexudus address. For example, customers can visit `members.example.com`.

Go to **Settings → Website → Domains**. You need the relevant domain-management permission or administrator access.

## Before you start

* Choose a domain or subdomain that your organisation owns.
* Have access to its DNS records.
* Confirm the address uses HTTPS and plan the change outside busy booking or sign-up periods.

<Warning>
  Do not direct customers to a new address until its DNS and certificate setup are complete. An incomplete change can prevent customers from reaching the portal.
</Warning>

## Add a custom domain

<Steps>
  <Step title="Open Domains">
    In Settings, open **Website → Domains** and select the add button.
  </Step>

  <Step title="Enter an internal name">
    Give the record a recognisable name for your team, such as “Members portal domain”.
  </Step>

  <Step title="Enter the domain URL">
    Enter the full HTTPS address, for example `https://members.example.com`.
  </Step>

  <Step title="Set the active period">
    Keep the domain active, or use optional start and end dates when it should only be available for a defined period.
  </Step>

  <Step title="Save and complete DNS setup">
    Save the record, then apply the DNS instructions provided for your deployment before testing the address in a browser.
  </Step>
</Steps>

## Field reference

| Field       | Description                                      |
| ----------- | ------------------------------------------------ |
| Name        | An internal label for the domain record          |
| Domain URL  | The HTTPS address customers will use             |
| Active      | Controls whether the domain is available         |
| SSL proxy   | Controls SSL certificate proxying for the domain |
| Active from | Optional date from which the domain is active    |
| Active to   | Optional date after which the domain is inactive |

## Important behavior

Each location can use a domain URL only once. If you operate several locations, use a distinct subdomain for each portal unless your DNS and portal configuration are designed for a shared address.

After DNS changes, allow time for records and certificates to update. Test sign-in, public pages, booking, and payment links before communicating the new address to customers.

## Related pages

* [Settings and configuration](/platform/settings/overview)
* [Member portal overview](/member-portal/overview)
* [Custom domain setup](/operators/portal-configuration/custom-domain-setup)


# Email templates
Source: https://learn.nexudus.com/platform/settings/email-templates

Customise the emails Nexudus sends to customers for bookings, invoices, visitors, and other activity.

## Overview

Email templates define the subject, content, sender, and copy recipients for automated messages sent by Nexudus. You can maintain templates in more than one language for each location.

Go to **Settings → Email editor**. You need the email-template permission or administrator access.

## Edit a template

<Steps>
  <Step title="Choose the message type">
    Open the template for the event you want to change, such as a booking confirmation or invoice message.
  </Step>

  <Step title="Edit the subject and content">
    Update the email subject and body. Keep any existing merge tags unless you understand the data they insert.
  </Step>

  <Step title="Set sender and copy recipients">
    Set the sender name, reply-to address, and optional CC or BCC recipients.
  </Step>

  <Step title="Save and test">
    Save the template and trigger a suitable test workflow before relying on it for customers.
  </Step>
</Steps>

## Field reference

| Field         | Description                                                       |
| ------------- | ----------------------------------------------------------------- |
| Name          | Identifies the message type; it is required                       |
| Subject       | The subject line sent to the recipient; it supports merge tags    |
| File contents | The email body, normally formatted as HTML                        |
| Is text only  | Sends the email without HTML formatting                           |
| From name     | The name customers see as the sender                              |
| From email    | The reply-to address; location defaults are used when it is blank |
| CC emails     | Additional visible recipients, separated with semicolons          |
| BCC emails    | Additional hidden recipients, separated with semicolons           |

## Languages and shared recipient settings

Create and maintain the subject and body for each language your location uses. The Email editor can copy sender, CC, and BCC settings to the language variants of a template. It does not translate the subject or content for you.

<Note>
  The `VisitorRegistered` template always uses the host's email address as its reply-to address. You cannot override that address in the template.
</Note>

## Merge tags

Templates can include merge tags in the form `{%VariableName%}`. Nexudus replaces a tag with information from the event when it sends the email, such as a customer name, invoice number, or reservation information.

Keep required merge tags in place. Before publishing a new template, send or preview a real example to confirm the tags resolve correctly.

## Best practices

* Use a recognisable sender name and a monitored reply-to address.
* Add BCC recipients only where they are necessary for operations or compliance.
* Keep one tested version for each customer language you support.
* Review templates after changing booking, billing, or visitor workflows.

## Related pages

* [Languages](/platform/settings/languages)
* [Bookings](/platform/operations/bookings)


# Floor plan editor
Source: https://learn.nexudus.com/platform/settings/floor-plan-editor

Build visual floor plans that show units, resources, assets, and routes through your location.

## Overview

Use the **Floor plan editor** to create visual layouts for your location. A floor plan can include floor plan units, bookable resources, visual assets, boundaries, openings, zones, and transitions to other layouts.

Go to **Settings → Floor plan editor**. You need access to floor plans and the related inventory records.

## Plan your layout

Before you start, decide which floors or areas need separate layouts, identify the resources and floor plan units that should appear, and prepare any background images or asset information you need.

## Create a layout

<Steps>
  <Step title="Open the Floor plan editor">
    Select **Settings → Floor plan editor** and create or open a floor plan.
  </Step>

  <Step title="Create the visual layout">
    Add the layout structure, including its dimensions, background, boundaries, openings, and named zones where needed.
  </Step>

  <Step title="Add units and assets">
    Place floor plan units and visual assets at their physical positions. Link a unit to the relevant resource or operational use.
  </Step>

  <Step title="Set variants and transitions">
    Add variants when a unit needs different visual states. Add transitions where customers or staff need to move between layouts, such as floors or buildings.
  </Step>

  <Step title="Review connected workflows">
    Confirm that the layout, units, resources, and any contract assignments refer to the intended location.
  </Step>
</Steps>

## Key concepts

| Item            | Purpose                                                       |
| --------------- | ------------------------------------------------------------- |
| Floor plan      | A visual representation of a floor or area                    |
| Layout          | The dimensions, background, and structural drawing for a plan |
| Floor plan unit | A specific assignable or bookable area shown on the plan      |
| Asset           | A visual item such as furniture or equipment                  |
| Zone            | A named area within a layout                                  |
| Transition      | A link to another layout, such as stairs or a lift            |

## How floor plans are used

Floor plan units can be connected to reservations and to customer plan contracts. Keep the visual layout aligned with your live resources and unit assignments so that staff and customers see an accurate representation of the space.

## Best practices

* Create one layout per floor or separately navigable area.
* Use stable names for plans and units; those names are easier to recognise in reservations and contracts.
* Update the layout when desks, offices, or resources change physically.
* Review any connected reservations before removing or repurposing a unit.

## Related pages

* [Resources](/platform/billing/resources)
* [Floor plans](/operators/bookings-and-resources/floor-plans)
* [Bookings](/platform/operations/bookings)


# Import and export
Source: https://learn.nexudus.com/platform/settings/import-export

Bring records into Nexudus using supported importers and export dashboard lists for offline work.

## Overview

Use **Import and export** to move data between Nexudus and your operational tools. Imports run as tracked background jobs, so you can review their progress and any validation problems. You can also export records from supported dashboard lists.

Go to **Settings → Imports**. You need access to the relevant records and import tool.

## Prepare an import

* Use the template or field requirements supplied by the importer.
* Check that location names match the location records in Nexudus.
* Use the required date format and keep text values within the field limits.
* Start with a small, representative file before importing a full dataset.

## Run an import

<Steps>
  <Step title="Open Imports">
    Go to **Settings → Imports** and choose the type of data you want to import.
  </Step>

  <Step title="Upload and preview the file">
    Upload the file and review the preview or validation results before committing it.
  </Step>

  <Step title="Resolve validation problems">
    Correct invalid values, missing locations, date formats, or field lengths in the source file.
  </Step>

  <Step title="Start the import">
    Confirm the import. Nexudus creates a background job for the work.
  </Step>

  <Step title="Monitor the job">
    Check job status and percentage complete. Review the final result before treating the imported data as ready for use.
  </Step>
</Steps>

## Export records

Where a dashboard list provides an export action, apply filters first so the output contains only the records you need, then download it for offline analysis or use in another system.

## Validation behavior

Importers validate data before it is accepted. Common checks include text length, integer and decimal values, dates, and the location assigned to each row. Validation errors identify records that must be corrected before a successful import.

<Tip>
  Keep the original source file and a copy of the reviewed import file. They make it easier to investigate a result or repeat the process later.
</Tip>

## Related pages

* [Settings and configuration](/platform/settings/overview)
* [Customers](/platform/operations/members)


# Integrations
Source: https://learn.nexudus.com/platform/settings/integrations

Connect supported payment, access control, communication, accounting, Wi-Fi, and operational services to Nexudus.

## Overview

Use **Integrations** to connect Nexudus with services you already use to run your location. Available integrations vary by your Nexudus subscription, enabled modules, region, and the services configured for the selected location.

Go to **Settings → Integrations**. You need administrator access or the permission required by the integration.

## Connect an integration

<Steps>
  <Step title="Choose the correct location">
    Select the location that will use the connection. Multi-location networks can have different credentials and behavior at each location.
  </Step>

  <Step title="Open Integrations">
    In Settings, select **Integrations**, then choose the service you want to connect.
  </Step>

  <Step title="Review prerequisites">
    Confirm that the service account, subscription, hardware, API access, and any required Nexudus module are ready.
  </Step>

  <Step title="Connect and authorise">
    Enter the requested credentials or use the provider's authorisation flow. Save the configuration.
  </Step>

  <Step title="Test and monitor">
    Use the connection or sync action where available, then verify its status and any relevant operational workflow.
  </Step>
</Steps>

## Common integration categories

| Category                 | Examples of what it supports                                                      |
| ------------------------ | --------------------------------------------------------------------------------- |
| Payments                 | Taking card payments, direct debit, and payment provider processing               |
| Access control           | Door access, credentials, check-ins, and physical hardware                        |
| Accounting and invoicing | Accounting export, invoice synchronisation, and e-invoicing                       |
| Communications           | Email, SMS, push notifications, customer messaging, and CRM connections           |
| Wi-Fi and printing       | Network authentication, printing credit, and print-service configuration          |
| Operations               | Video meetings, resource services, data validation, and connected workplace tools |

## Connection status

An integration can show as connected, disconnected, or requiring attention. Some integrations also provide a **Synchronise** action. Use this after initial setup or when the provider requires a manual refresh.

<Warning>
  Disconnecting an integration can stop payment collection, access updates, synchronisation, or customer communications. Check the effect on active customers and operational workflows before disconnecting it.
</Warning>

## Best practices

* Use a dedicated service account where the provider supports one.
* Keep API credentials and OAuth access current, and update them only in the integration's configuration.
* Test with a non-critical transaction, reservation, or user before relying on a new connection.
* Review each integration after changing payment providers, access hardware, a custom domain, or your location network.

## Related pages

* [Payment gateways](/platform/finance/payment-gateways)
* [Access control integrations](/platform/access-control/integrations/overview)
* [Webhooks](/platform/settings/webhooks)
* [Settings hub](/platform/settings/settings-hub)


# Languages
Source: https://learn.nexudus.com/platform/settings/languages

Set the languages available at your location and choose defaults for the dashboard, portal, and notifications.

## Overview

Use **Languages** to make the dashboard, members portal, and customer communications appropriate for the people using your location. A language record includes its display name and culture code.

Go to **Settings → General settings → Languages**. You need the relevant settings permission or administrator access.

## Configure languages for a location

<Steps>
  <Step title="Add or review available languages">
    Open the Languages list and add the languages your location supports. Each language needs a name and culture code, such as `en` or `es-ES`.
  </Step>

  <Step title="Set your defaults">
    In location settings, select the default language used for date and number formatting and the language used for portal and notification content.
  </Step>

  <Step title="Review customer-facing content">
    Check translated email templates, portal content, and any customised text before making the language available to customers.
  </Step>
</Steps>

## Language fields

| Field   | Description                                                    |
| ------- | -------------------------------------------------------------- |
| Name    | The language name shown to administrators and customers        |
| Culture | The language and regional format code, such as `en` or `es-ES` |

## How language choices are used

| Setting               | Effect                                                                                |
| --------------------- | ------------------------------------------------------------------------------------- |
| Default language      | Sets the location's default date and number formatting                                |
| Notification language | Sets the language used for customer notifications and portal defaults                 |
| Available languages   | Determines the languages that can be selected for location content and communications |

<Warning>
  Changing the notification language affects future communications. Translate email templates and customer-facing content before changing the default.
</Warning>

## Best practices

* Use the exact culture code required for the regional date, number, and language conventions you need.
* Keep equivalent email templates available in every language you offer.

## Related pages

* [Email templates](/platform/settings/email-templates)
* [Settings hub](/platform/settings/settings-hub)
* [Settings and configuration](/platform/settings/overview)


# Settings and configuration
Source: https://learn.nexudus.com/platform/settings/overview

Use Settings to configure your location, its billing, member portal, connected services, and operational features.

## Overview

**Settings** is where you configure how your location operates and how it appears to customers. It includes location details, billing preferences, member portal options, connected services, access control, and data-management tools.

Go to **Settings** in the Nexudus dashboard. You need the **Settings** role or administrator access.

## Find a setting

Settings are organised into groups and pages. Use the settings search to find a setting by its name, then open the matching page and section.

Depending on your account, you can switch between viewing settings for the current location and viewing comparable data for all locations that you can access.

<Tip>
  Make changes while the correct location is selected. Location settings apply to that location unless you apply them through a settings template.
</Tip>

## Main areas

| Area                 | Use it to                                                                                       |
| -------------------- | ----------------------------------------------------------------------------------------------- |
| General settings     | Set location details, branding, opening hours, legal content, languages, and portal defaults    |
| Billing and payments | Configure invoices, tax, currency, financial accounts, and payment services                     |
| Website and portal   | Control customer-facing pages, features, navigation, and account-menu visibility                |
| Integrations         | Connect supported payment, access control, communication, accounting, Wi-Fi, and other services |
| Data management      | Import records, export lists, and monitor bulk jobs                                             |
| Advanced tools       | Configure custom domains, webhooks, automation tiles, floor plans, and administrator access     |

## Settings that need extra care

* Use [Settings hub](/platform/settings/settings-hub) when the same values should be maintained across multiple locations.
* Review [users and roles](/platform/settings/users-and-roles) before giving someone administrator access.
* Test member portal changes with a customer account before announcing them.
* Keep credentials and signing secrets in the relevant integration configuration; do not enter them in general text fields.

## Related pages

* [Settings hub](/platform/settings/settings-hub)
* [Domains](/platform/settings/domains)
* [Integrations](/platform/settings/integrations)
* [Users and roles](/platform/settings/users-and-roles)


# Settings hub
Source: https://learn.nexudus.com/platform/settings/settings-hub

Create reusable settings templates and apply them to multiple locations in your network.

## Overview

**Settings hub** lets you keep selected location settings consistent across a network. Create a template once, connect it to the locations that should receive it, and use it as the source for future changes.

Go to **Settings → Settings hub**. You need administrator access and access to the locations you want to manage.

## Before you start

* Decide which settings should be shared and which must remain local, such as a location's address or payment account.
* Ensure the destination locations already have any required features or integrations enabled.
* Start with a small group of locations and verify the result before applying a template more widely.

## Create a template

<Steps>
  <Step title="Open Settings hub">
    Select **Settings hub** from Settings.
  </Step>

  <Step title="Create a template">
    Choose to add a template and give it a name that explains its purpose, such as “Standard portal settings”.
  </Step>

  <Step title="Choose the settings">
    Add the location settings that the template should manage.
  </Step>

  <Step title="Connect locations">
    Associate the template with the locations or location network that should use it.
  </Step>

  <Step title="Review and apply">
    Confirm the selected locations, then apply the template and review each location's result.
  </Step>
</Steps>

## How templates work

Templates manage settings values, not every record belonging to a location. They are designed for repeatable configuration such as portal behavior, branding choices, or common operational settings.

When you update a template, use the hub to synchronise the revised values to its linked locations. The hub shows the locations connected to a template and records when its settings were last updated.

<Warning>
  Applying a template can replace existing values at a destination location. Check local exceptions before synchronising, particularly payment, access-control, and communication settings.
</Warning>

## Best practices

* Keep templates focused: use separate templates for portal settings, billing policy, and integrations.
* Use clear names that identify the affected locations and purpose.
* Maintain a short list of intentional local exceptions outside the template.
* Review a location after every template change, including its member portal where applicable.

## Related pages

* [Settings and configuration](/platform/settings/overview)
* [Languages](/platform/settings/languages)
* [Integrations](/platform/settings/integrations)


# Users and roles
Source: https://learn.nexudus.com/platform/settings/users-and-roles

Create administrator accounts, limit their location access, and assign permission groups.

## Overview

Use **Users and roles** to control who can access the Nexudus dashboard and what they can do. A user is an individual staff account. A role is a permission, and a user role is a reusable group of permissions that you assign to users.

Go to **Settings → Users** to manage staff accounts, and **Settings → Roles** to manage permission groups. You need administrator access or the corresponding user and role permissions.

<Info>
  Permissions are additive. A user receives the combined permissions of every user role assigned to them.
</Info>

## Create a user

<Steps>
  <Step title="Open Users">
    Select **Settings → Users** and add a user.
  </Step>

  <Step title="Enter account details">
    Add the person's name, email address, preferred language, and default location.
  </Step>

  <Step title="Set sign-in access">
    Set or generate a password. Enable password reset on first sign-in when appropriate.
  </Step>

  <Step title="Set location access">
    On the access section, select the locations the user can work with.
  </Step>

  <Step title="Assign user roles">
    Assign the permission groups needed for the person's work, then save the account.
  </Step>
</Steps>

## User fields

| Field              | Description                                                            |
| ------------------ | ---------------------------------------------------------------------- |
| Full name          | Identifies the staff member in the dashboard                           |
| Email              | Their sign-in address and, where enabled, SSO identity                 |
| Default location   | The location selected when the user signs in                           |
| Preferred language | The dashboard language for that user                                   |
| Password           | A new or generated password; you can require a reset at next sign-in   |
| Locations          | Limits the locations whose records the user can access                 |
| User roles         | Permission groups assigned to the user                                 |
| API access         | Allows this user account to authenticate API integrations when enabled |
| MAC addresses      | Optional device restrictions for the account                           |

## Build a permission group

<Steps>
  <Step title="Open user roles">
    Go to **Settings → Roles → User roles**.
  </Step>

  <Step title="Create or copy a group">
    Create a named group, or start from a supplied template such as read-only, billing, or operations.
  </Step>

  <Step title="Choose permissions">
    Select the permissions needed for the job, then save the group.
  </Step>

  <Step title="Assign the group">
    Return to the user record and add the group in its access section.
  </Step>
</Steps>

## Permission names

Permissions use an entity and action, such as `Customer-Read` or `Invoice-Create`.

| Suffix | Allows the user to        |
| ------ | ------------------------- |
| List   | View a list of records    |
| Read   | Open an individual record |
| Create | Add records               |
| Edit   | Change records            |
| Delete | Remove records            |

## Administrators and API access

An **administrator** has unrestricted dashboard access. Administrator access overrides assigned user roles, so reserve it for staff who administer the platform.

Enable **API access** only for accounts used by a trusted integration. Use a separate, least-privilege account where possible and review it when the integration changes.

## Best practices

* Give users the smallest set of permissions that lets them complete their work.
* Restrict users to the locations they need.
* Use named user roles instead of manually recreating the same permissions for each user.
* Remove access promptly when a staff member changes role or leaves.

## Related pages

* [Roles and permissions](/platform/roles-and-permissions)
* [Multi-location management](/platform/multi-location)
* [Settings and configuration](/platform/settings/overview)


# Webhooks
Source: https://learn.nexudus.com/platform/settings/webhooks

Send event notifications from Nexudus to another system when selected activity occurs.

## Overview

A **webhook** sends information to an external URL when a selected event occurs in Nexudus. Use webhooks when another system needs to react to activity in your location without repeatedly checking Nexudus for changes.

Go to **Settings → Integrations → Webhooks**. You need the webhook permission or administrator access.

## Before you start

* Confirm the receiving service can accept HTTPS requests.
* Obtain the exact URL and the event type it expects.
* Agree with the receiving-system owner how failures will be monitored and handled.

## Create a webhook

<Steps>
  <Step title="Open Webhooks">
    Go to **Settings → Integrations → Webhooks** and add a webhook.
  </Step>

  <Step title="Name the webhook">
    Use a clear internal name, such as “Send new reservations to CRM”.
  </Step>

  <Step title="Choose an action">
    Select the Nexudus event that should trigger the notification.
  </Step>

  <Step title="Enter the destination URL">
    Enter the secure URL provided by the receiving system.
  </Step>

  <Step title="Activate and monitor it">
    Save the webhook, activate it, then verify the first event reaches the destination.
  </Step>
</Steps>

## Field reference

| Field        | Description                                             |
| ------------ | ------------------------------------------------------- |
| Name         | An internal label for the webhook                       |
| Action       | The Nexudus event that triggers the notification        |
| URL          | The external destination that receives the notification |
| Active       | Turns delivery on or off without deleting the webhook   |
| Description  | Optional internal notes about the integration           |
| Last trigger | The most recent delivery attempt                        |
| Last error   | The most recent delivery error, if any                  |
| Error count  | The number of recorded delivery errors                  |

## Monitor delivery

Review **Last trigger**, **Last error**, and **Error count** after setup and whenever the receiving system changes. Deactivate the webhook before replacing an outdated URL so failed deliveries do not continue.

<Warning>
  Webhook URLs can give an external system access to operational data. Use a trusted HTTPS endpoint and avoid placing credentials directly in the URL unless the receiving system explicitly requires it.
</Warning>

## Related pages

* [Integrations](/platform/settings/integrations)
* [Automation tiles](/platform/settings/automation-tiles)


# Suggested Bookings
Source: https://learn.nexudus.com/portal-usage/members/predicted-bookings

How the Suggested Bookings feature works for members and how space operators can configure it.

# Suggested Bookings

The Suggested Bookings feature helps your members save time by intelligently surfacing booking suggestions based on their past behaviour. Instead of manually repeating the same booking every week, members see ready-made suggestions on their personal dashboard — one click away from confirming.

<img alt="Suggested Bookings section on the personal dashboard" />

*The Suggested Bookings section appears on the member's personal dashboard.*

***

## How It Works

Nexudus continuously monitors each member's booking history over the **previous 8 weeks**. When the system detects that a member has booked the **same resource at the same time on the same day of the week at least 3 times**, it treats that as a recurring pattern and generates a suggestion for each matching upcoming date within the next 28 days.

For example, if a member has booked **Meeting Room A every Tuesday from 10:00–12:00** at least three times in the past 8 weeks, the system will suggest that booking for every upcoming Tuesday that doesn't already have a confirmed booking in that slot.

### What counts as a pattern

| Condition                              | Requirement                                                        |
| -------------------------------------- | ------------------------------------------------------------------ |
| Booking history window                 | Last 8 weeks                                                       |
| Minimum repetitions to qualify         | 3 bookings                                                         |
| Pattern match criteria                 | Same resource + same day of week + same start time + same duration |
| Suggestion horizon                     | Next 28 calendar days                                              |
| Maximum suggestions shown on dashboard | 6                                                                  |

Suggestions are only generated for **time slots not already booked**. If the member already has a confirmed booking for a given slot, no duplicate suggestion is created.

If the space has hot-desking with individual desk assignments, the suggestion also includes the specific desk that was used most often for that pattern.

***

## What Members See

### Suggested Bookings Section

When a member has qualifying patterns, a **"Suggested Bookings"** section appears on their personal dashboard, above or alongside their upcoming confirmed bookings.

Each card displays:

* A **"Suggested"** blue badge to distinguish suggestions from confirmed bookings
* The date and time range
* The resource (and desk name, if applicable)
* The location name
* A **"Confirm"** button to book the slot
* A **"Modify"** link to open the booking form with pre-filled details

The section also shows a link to **Booking settings** so members can manage their preferences without navigating away.

<Info>
  Suggested bookings are **not real bookings**. They are suggestions held temporarily for the member. No charges apply until the member confirms.
</Info>

***

### Confirming a Suggested Booking

When a member clicks **Confirm**:

1. A booking confirmation dialog opens, showing the full details of the resource, date, and time.

   <img alt="Instant booking confirmation modal" />

   *The confirmation dialog lets the member review and adjust before committing.*

2. The member reviews the booking, optionally modifies it (date, time, desk, add-ons), and clicks **"Book now"**.

3. A final confirmation screen confirms the booking was saved.

The full standard booking flow applies at this point — credits are consumed, invoices raised, confirmation emails sent, and any approval workflows triggered, exactly as if the member had made the booking manually.

***

### Modifying a Suggested Booking

Members can click **"Modify"** instead of "Confirm" to open the standard booking form with all fields pre-filled. This is useful when the member wants to book a slightly different time, switch desks, or add services before confirming.

***

## Member Preferences

Members control their own suggested bookings behaviour from their **Profile → Settings → Bookings** section.

<Frame>
  <img alt="Booking settings page with suggested bookings toggles" />
</Frame>

*Members access suggested bookings settings from their profile settings page.*

### Available toggles

| Setting                                                                                 | What it does                                                                                                                                                                             |
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Show suggested booking suggestions in my dashboard**                                  | Controls whether the Suggested Bookings section appears on the personal dashboard. Members can turn this off if they prefer not to see suggestions.                                      |
| **Book suggested bookings automatically and notify me by email when a booking is made** | When enabled, Nexudus automatically confirms matching suggested bookings on the member's behalf and sends an email notification for each one. The member does not need to click Confirm. |

<Warning>
  The **automatic booking** option means Nexudus will make real, chargeable bookings without requiring the member to confirm each one. Members should only enable this if they are certain their patterns are stable and they are comfortable being charged automatically.
</Warning>

***

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Why isn't a member seeing any suggested bookings even though they book regularly?">
    The member must have booked the **exact same resource at the same start time and duration on the same day of the week at least 3 times** within the last 8 weeks. Variations in time, duration, or resource prevent a pattern from forming. Also check that the Suggested Bookings section is enabled in the portal editor and that the member has not hidden it in their personal settings.
  </Accordion>

  <Accordion title="Can suggested bookings be created across different locations in a network?">
    Yes. Patterns are detected per resource, which means a member who books the same resource in a specific location on a recurring basis will receive suggestions for that location. Patterns at different locations are tracked independently.
  </Accordion>

  <Accordion title="Can I stop specific members from using this feature?">
    The feature cannot currently be disabled per member from the admin side. Members can opt out themselves via their Booking settings. At the portal level, you can disable it entirely for all members by setting **Show suggested bookings** to **No** in the Personal Dashboard editor.
  </Accordion>

  <Accordion title="Are members charged when a suggested booking appears on their dashboard?">
    No. Suggested bookings are suggestions only. No booking is created and no charge applies until the member clicks **Confirm** and completes the booking flow. The exception is members who have enabled the **automatic booking** option — those members will be charged as soon as the system creates the booking on their behalf.
  </Accordion>

  <Accordion title="What happens if a suggested time slot is already taken by the time a member tries to confirm?">
    The standard booking conflict check runs at the moment the member confirms. If the slot has been taken, the member will see the same availability error they would see for any other booking attempt.
  </Accordion>

  <Accordion title="How do I know if members are using this feature?">
    Booking confirmations originating from suggested bookings go through the same pipeline as standard bookings and appear in your standard booking reports. At present there is no separate report specifically for confirmed suggested bookings.
  </Accordion>
</AccordionGroup>

***

<CardGroup>
  <Card title="Booking Desks and Rooms" icon="calendar-check" href="/portal-usage/members/booking-desks-rooms">
    Full guide to how members book resources through the portal.
  </Card>

  <Card title="Personal Dashboard" icon="gauge" href="/portal-sections/overview/user-journey-flows">
    Overview of all sections available on the member's personal dashboard.
  </Card>
</CardGroup>


# Delete Application
Source: https://learn.nexudus.com/rest-api/apps/delete-applications-by-id

DELETE /api/apps/applications/{id}
Delete an existing Application record by its Id.

Deletes a Application record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Application-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Application record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/apps/applications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/apps/applications/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Application was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete InstalledApplication
Source: https://learn.nexudus.com/rest-api/apps/delete-installedapplications-by-id

DELETE /api/apps/installedapplications/{id}
Delete an existing InstalledApplication record by its Id.

Deletes a InstalledApplication record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`InstalledApplication-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the InstalledApplication record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/apps/installedapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/apps/installedapplications/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledApplication was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete InstalledMarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/delete-installedmarketplaceapplications-by-id

DELETE /api/apps/installedmarketplaceapplications/{id}
Delete an existing InstalledMarketPlaceApplication record by its Id.

Deletes a InstalledMarketPlaceApplication record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the InstalledMarketPlaceApplication record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledMarketPlaceApplication was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# 📆Delete resource booking
Source: https://learn.nexudus.com/rest-api/apps/delete-marketplaceapplications

DELETE /api/apps/marketplaceapplications/book
Deletes a boking based on the booking unique Id and the marketplace which made it.

# 📆Delete resource booking

Deletes a boking based on the booking unique Id and the marketplace which made it.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Request Body

<ParamField type="string">
  The id of the booking to delete.
</ParamField>

<ParamField type="string">
  The id of the marketplace performing this action
</ParamField>

## Response

### 200

<ResponseField name="Status" type="integer">
  Example: `200`
</ResponseField>

<ResponseField name="Message" type="string">
  Example: `Booking "Example" was successfully deleted.`
</ResponseField>

<ResponseField name="Value" type="object" />

<ResponseField name="RedirectURL" type="any" />

<ResponseField name="UpdatedOn" type="string">
  Example: `2021-04-15T12:19:07Z`
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Example: `john@example.com`
</ResponseField>

<ResponseField name="Errors" type="any" />

<ResponseField name="WasSuccessful" type="boolean">
  Example: `true`
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Booking \"Example\" was successfully deleted.",
  "Value": {
    "Id": 10605
  },
  "RedirectURL": null,
  "UpdatedOn": "2021-04-15T12:19:07Z",
  "UpdatedBy": "john@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

## Example Request

```bash theme={null}
curl -X DELETE \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/book" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```


# Delete MarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/delete-marketplaceapplications-by-id

DELETE /api/apps/marketplaceapplications/{id}
Delete an existing MarketPlaceApplication record by its Id.

Deletes a MarketPlaceApplication record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`MarketPlaceApplication-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the MarketPlaceApplication record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "MarketPlaceApplication was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Search Applications
Source: https://learn.nexudus.com/rest-api/apps/get-applications

GET /api/apps/applications
Search and list Application records with filtering, sorting, and pagination.

An **Application** represents a third-party application that can be installed as an add-on in a Nexudus account.

Each application is owned by a developer and identified by a unique `ApplicationKey` and `SecretKey` pair. The `InstallUrl` is the endpoint Nexudus calls when a location installs the application.

## Authentication

<Note>
  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 **`Application-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the developer linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the application.
</ParamField>

<ParamField type="boolean">
  Filter by whether the application is published and available for installation.
</ParamField>

<ParamField type="string">
  Filter by unique key identifying the application, generated by Nexudus.
</ParamField>

<ParamField type="string">
  Filter by secret key used to authenticate API calls from the application.
</ParamField>

<ParamField type="string">
  Filter by brief summary of the application shown in listing views.
</ParamField>

<ParamField type="string">
  Filter by full description of the application shown on the detail page.
</ParamField>

<ParamField type="string">
  Filter by uRL that Nexudus calls when a location installs this application.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/applications?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/applications',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/applications?Application_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications?' + new URLSearchParams({
      Application_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/applications',
      params={
          'Application_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/applications?from_Application_UpdatedOn=2025-01-01T00:00&to_Application_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications?' + new URLSearchParams({
      from_Application_UpdatedOn: '2025-01-01T00:00',
      to_Application_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/applications',
      params={
          'from_Application_UpdatedOn': '2025-01-01T00:00',
          'to_Application_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Application[]">
  The list of Application records matching the query. See the [Get one Application](/rest-api/apps/get-applications-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Application. The following fields are **not populated** in the `Records[]` response: `SecretKey`, `Description`, `InstallUrl`.

  To get all fields, fetch the full record using the [Get one Application](/rest-api/apps/get-applications-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "DeveloperId": 0,
      "Name": "",
      "Published": false,
      "ApplicationKey": null,
      "ShortDescription": "",
      "RequiredRoles": [],
      "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": "Application Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Applications
Source: https://learn.nexudus.com/rest-api/apps/get-applications-batch

GET /api/apps/applications/?id=[{id1},{id2},{id3}]
Retrieve multiple Application records by their Ids in a single request.

Fetch several Application records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Application-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Application Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/applications/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/applications/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Application records. Each record has the same structure as the response from the [Get one Application](/rest-api/apps/get-applications-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Application. The following fields are **not populated** in the response: `SecretKey`, `Description`, `InstallUrl`.

  To get all fields, fetch the full record using the [Get one Application](/rest-api/apps/get-applications-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "DeveloperId": 0,
    "Name": "",
    "Published": false,
    "ApplicationKey": null,
    "ShortDescription": "",
    "RequiredRoles": [],
    "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": "Application Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Application
Source: https://learn.nexudus.com/rest-api/apps/get-applications-by-id

GET /api/apps/applications/{id}
Retrieve a single Application record by its Id.

An **Application** represents a third-party application that can be installed as an add-on in a Nexudus account.

Each application is owned by a developer and identified by a unique `ApplicationKey` and `SecretKey` pair. The `InstallUrl` is the endpoint Nexudus calls when a location installs the application.

## Authentication

<Note>
  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 **`Application-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Application record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/applications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="DeveloperId" type="integer">
  ID of the developer linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the application.
</ResponseField>

<ResponseField name="Published" type="boolean">
  Whether the application is published and available for installation.
</ResponseField>

<ResponseField name="ApplicationKey" type="string">
  Unique key identifying the application, generated by Nexudus.
</ResponseField>

<ResponseField name="SecretKey" type="string">
  Secret key used to authenticate API calls from the application.
</ResponseField>

<ResponseField name="ShortDescription" type="string">
  Brief summary of the application shown in listing views.
</ResponseField>

<ResponseField name="Description" type="string">
  Full description of the application shown on the detail page.
</ResponseField>

<ResponseField name="InstallUrl" type="string">
  URL that Nexudus calls when a location installs this application.
</ResponseField>

<ResponseField name="RequiredRoles" type="integer[]">
  List of required roles linked to this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "DeveloperId": 0,
  "Name": "",
  "Published": false,
  "ApplicationKey": null,
  "SecretKey": null,
  "ShortDescription": "",
  "Description": null,
  "InstallUrl": "",
  "RequiredRoles": [],
  "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": "Application Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search InstalledApplications
Source: https://learn.nexudus.com/rest-api/apps/get-installedapplications

GET /api/apps/installedapplications
Search and list InstalledApplication records with filtering, sorting, and pagination.

An **InstalledApplication** represents a third-party or internal application that has been installed and configured for a specific business location.

## Authentication

<Note>
  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 **`InstalledApplication-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the application linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="boolean">
  Filter by whether requires approval is enabled.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedapplications?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedapplications',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedapplications?InstalledApplication_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications?' + new URLSearchParams({
      InstalledApplication_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedapplications',
      params={
          'InstalledApplication_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedapplications?from_InstalledApplication_UpdatedOn=2025-01-01T00:00&to_InstalledApplication_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications?' + new URLSearchParams({
      from_InstalledApplication_UpdatedOn: '2025-01-01T00:00',
      to_InstalledApplication_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedapplications',
      params={
          'from_InstalledApplication_UpdatedOn': '2025-01-01T00:00',
          'to_InstalledApplication_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="InstalledApplication[]">
  The list of InstalledApplication records matching the query. See the [Get one InstalledApplication](/rest-api/apps/get-installedapplications-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ApplicationId": 0,
      "BusinessId": 0,
      "RequiresApproval": false,
      "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": "InstalledApplication Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple InstalledApplications
Source: https://learn.nexudus.com/rest-api/apps/get-installedapplications-batch

GET /api/apps/installedapplications/?id=[{id1},{id2},{id3}]
Retrieve multiple InstalledApplication records by their Ids in a single request.

Fetch several InstalledApplication records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`InstalledApplication-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of InstalledApplication Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedapplications/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedapplications/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of InstalledApplication records. Each record has the same structure as the response from the [Get one InstalledApplication](/rest-api/apps/get-installedapplications-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ApplicationId": 0,
    "BusinessId": 0,
    "RequiresApproval": false,
    "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": "InstalledApplication Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one InstalledApplication
Source: https://learn.nexudus.com/rest-api/apps/get-installedapplications-by-id

GET /api/apps/installedapplications/{id}
Retrieve a single InstalledApplication record by its Id.

An **InstalledApplication** represents a third-party or internal application that has been installed and configured for a specific business location.

## Authentication

<Note>
  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 **`InstalledApplication-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the InstalledApplication record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ApplicationId" type="integer">
  ID of the application linked to this record.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="RequiresApproval" type="boolean">
  Whether requires approval is enabled.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ApplicationId": 0,
  "BusinessId": 0,
  "RequiresApproval": false,
  "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": "InstalledApplication Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search InstalledMarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/get-installedmarketplaceapplications

GET /api/apps/installedmarketplaceapplications
Search and list InstalledMarketPlaceApplication records with filtering, sorting, and pagination.

An **InstalledMarketPlaceApplication** represents a marketplace application that has been installed for a business. Marketplace apps extend platform functionality with integrations, automations, and additional features.

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the market place application linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide products is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide resources is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide events is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide tariffs is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide resource availability is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether provide resource prices is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether accept bookings is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether accept event signups is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether accept payment requests is enabled.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?InstalledMarketPlaceApplication_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?' + new URLSearchParams({
      InstalledMarketPlaceApplication_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
      params={
          'InstalledMarketPlaceApplication_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?from_InstalledMarketPlaceApplication_UpdatedOn=2025-01-01T00:00&to_InstalledMarketPlaceApplication_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications?' + new URLSearchParams({
      from_InstalledMarketPlaceApplication_UpdatedOn: '2025-01-01T00:00',
      to_InstalledMarketPlaceApplication_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
      params={
          'from_InstalledMarketPlaceApplication_UpdatedOn': '2025-01-01T00:00',
          'to_InstalledMarketPlaceApplication_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="InstalledMarketPlaceApplication[]">
  The list of InstalledMarketPlaceApplication records matching the query. See the [Get one InstalledMarketPlaceApplication](/rest-api/apps/get-installedmarketplaceapplications-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "MarketPlaceApplicationId": 0,
      "BusinessId": 0,
      "ProvideProducts": false,
      "ProvideResources": false,
      "ProvideEvents": false,
      "ProvideTariffs": false,
      "ProvideResourceAvailability": false,
      "ProvideResourcePrices": false,
      "AcceptBookings": false,
      "AcceptEventSignups": false,
      "AcceptPaymentRequests": false,
      "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": "InstalledMarketPlaceApplication Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple InstalledMarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/get-installedmarketplaceapplications-batch

GET /api/apps/installedmarketplaceapplications/?id=[{id1},{id2},{id3}]
Retrieve multiple InstalledMarketPlaceApplication records by their Ids in a single request.

Fetch several InstalledMarketPlaceApplication records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of InstalledMarketPlaceApplication Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of InstalledMarketPlaceApplication records. Each record has the same structure as the response from the [Get one InstalledMarketPlaceApplication](/rest-api/apps/get-installedmarketplaceapplications-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "MarketPlaceApplicationId": 0,
    "BusinessId": 0,
    "ProvideProducts": false,
    "ProvideResources": false,
    "ProvideEvents": false,
    "ProvideTariffs": false,
    "ProvideResourceAvailability": false,
    "ProvideResourcePrices": false,
    "AcceptBookings": false,
    "AcceptEventSignups": false,
    "AcceptPaymentRequests": false,
    "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": "InstalledMarketPlaceApplication Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one InstalledMarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/get-installedmarketplaceapplications-by-id

GET /api/apps/installedmarketplaceapplications/{id}
Retrieve a single InstalledMarketPlaceApplication record by its Id.

An **InstalledMarketPlaceApplication** represents a marketplace application that has been installed for a business. Marketplace apps extend platform functionality with integrations, automations, and additional features.

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the InstalledMarketPlaceApplication record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="MarketPlaceApplicationId" type="integer">
  ID of the market place application linked to this record.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="ProvideProducts" type="boolean">
  Whether provide products is enabled.
</ResponseField>

<ResponseField name="ProvideResources" type="boolean">
  Whether provide resources is enabled.
</ResponseField>

<ResponseField name="ProvideEvents" type="boolean">
  Whether provide events is enabled.
</ResponseField>

<ResponseField name="ProvideTariffs" type="boolean">
  Whether provide tariffs is enabled.
</ResponseField>

<ResponseField name="ProvideResourceAvailability" type="boolean">
  Whether provide resource availability is enabled.
</ResponseField>

<ResponseField name="ProvideResourcePrices" type="boolean">
  Whether provide resource prices is enabled.
</ResponseField>

<ResponseField name="AcceptBookings" type="boolean">
  Whether accept bookings is enabled.
</ResponseField>

<ResponseField name="AcceptEventSignups" type="boolean">
  Whether accept event signups is enabled.
</ResponseField>

<ResponseField name="AcceptPaymentRequests" type="boolean">
  Whether accept payment requests is enabled.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "MarketPlaceApplicationId": 0,
  "BusinessId": 0,
  "ProvideProducts": false,
  "ProvideResources": false,
  "ProvideEvents": false,
  "ProvideTariffs": false,
  "ProvideResourceAvailability": false,
  "ProvideResourcePrices": false,
  "AcceptBookings": false,
  "AcceptEventSignups": false,
  "AcceptPaymentRequests": false,
  "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": "InstalledMarketPlaceApplication Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search MarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications

GET /api/apps/marketplaceapplications
Search and list MarketPlaceApplication records with filtering, sorting, and pagination.

A **MarketPlaceApplication** represents an application available in the Nexudus marketplace. Marketplace apps provide integrations with third-party services, automation tools, and additional platform features.

## Authentication

<Note>
  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 **`MarketPlaceApplication-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the developer linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the name value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by the terms and conditions value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by the support email value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by the developer name value for this market place application.
</ParamField>

<ParamField type="boolean">
  Filter by whether published is enabled.
</ParamField>

<ParamField type="string">
  Filter by the secret key value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by the short description value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this market place application.
</ParamField>

<ParamField type="string">
  Filter by the notification email value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by the notification url value for this market place application.
</ParamField>

<ParamField type="string">
  Filter by current file name of the logo (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the logo.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current logo file.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications?MarketPlaceApplication_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications?' + new URLSearchParams({
      MarketPlaceApplication_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications',
      params={
          'MarketPlaceApplication_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications?from_MarketPlaceApplication_UpdatedOn=2025-01-01T00:00&to_MarketPlaceApplication_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications?' + new URLSearchParams({
      from_MarketPlaceApplication_UpdatedOn: '2025-01-01T00:00',
      to_MarketPlaceApplication_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications',
      params={
          'from_MarketPlaceApplication_UpdatedOn': '2025-01-01T00:00',
          'to_MarketPlaceApplication_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="MarketPlaceApplication[]">
  The list of MarketPlaceApplication records matching the query. See the [Get one MarketPlaceApplication](/rest-api/apps/get-marketplaceapplications-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each MarketPlaceApplication. The following fields are **not populated** in the `Records[]` response: `TermsAndConditions`, `SecretKey`, `Description`, `NotificationEmail`, `NotificationUrl`.

  To get all fields, fetch the full record using the [Get one MarketPlaceApplication](/rest-api/apps/get-marketplaceapplications-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "DeveloperId": 0,
      "Name": "",
      "SupportEmail": "",
      "DeveloperName": "",
      "Published": false,
      "ShortDescription": "",
      "LogoFileName": null,
      "NewLogoUrl": null,
      "ClearLogoFile": 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": "MarketPlaceApplication Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# ✔️Check availability
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-2

GET /api/apps/marketplaceapplications/available
Lets you check if a resource can be booked at given date and time and returns any conflict information as well as a price.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="string" />

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string">
  The unique id of the location to get the availability for
</ParamField>

<ParamField type="string">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location. Defaults to the current date and time.
</ParamField>

<ParamField type="string">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

## Response

### 200

<ResponseField name="price" type="object" />

<ResponseField name="confirmation" type="object" />

<ResponseField name="available" type="boolean">
  Example: `false`
</ResponseField>

<ResponseField name="message" type="string">
  Example: `This resource is already booked. Please choose a different start and end times.`
</ResponseField>

<ResponseField name="error_code" type="string">
  Example: `BOOKING_CONFLICT`
</ResponseField>

```json Example Response theme={null}
{
  "price": {
    "amount": 4.81,
    "currency": "USD",
    "rate": {
      "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
      "name": "Large Conference Rooms",
      "description": "Large Conference Rooms",
      "price": 100,
      "tax_rate": 20,
      "period": "Minutes",
      "members_only": false,
      "contacts_only": false,
      "min_length_minutes": null,
      "max_length_minutes": null,
      "fixed_price": null,
      "fixed_price_length_minutes": null
    }
  },
  "confirmation": {
    "confirmed": false,
    "message": null,
    "booking_id": null
  },
  "available": false,
  "message": "This resource is already booked. Please choose a different start and end times.",
  "error_code": "BOOKING_CONFLICT"
}
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/available" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# 📅Calendar
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-3

GET /api/apps/marketplaceapplications/calendar
Gets a calendar feed with bookings in a given location and resource

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="string">
  The unique id of your marketplace application
</ParamField>

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string">
  The unique id of the location to get the calendar for
</ParamField>

<ParamField type="string (date)">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location. Defaults to the current date and time.
</ParamField>

<ParamField type="integer (int32)">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

## Response

```json Example Response theme={null}
[
  {
    "booking": {
      "id": "d9b8982f-1046-4bf7-afec-e7eeb6b80fd3",
      "from_time": "2022-03-18T15:15:00Z",
      "to_time": "2022-03-18T16:15:00Z",
      "from_time_local": "2022-03-18T08:15:00+00:00",
      "to_time_local": "2022-03-18T09:15:00+00:00",
      "customer": {
        "id": "d086e74f-9811-4704-b7a0-f9643b7c888b"
      },
      "resource": {
        "id": "8a0a7377-d8b5-41de-9342-4d531cecc0da",
        "name": "Router Room"
      }
    },
    "type": "bookingconfirmed"
  }
]
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/calendar" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# 🔎Search
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-4

GET /api/apps/marketplaceapplications/search
Searches for available resources across a location

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="string">
  The unique id of your marketplace application
</ParamField>

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string (date)">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location.
</ParamField>

<ParamField type="integer (int32)">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

## Response

```json Example Response theme={null}
[
    {
        "resource": {
            "id": "dfb844cd-f791-4d21-afa9-3b68c20f81e3",
            "name": "RJ-45 Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
            "unit_types": [
                "DedicatedDesk",
                "Other"
            ],
						"units": [
                {
                    "id": "7915c812-a12b-4e7c-bc94-a47055792fa4",
                    "name": "RJ-45 Desk 1"
                }
            ],
            "capacity": 15,
          	"bookable_up_to_capacity": false,
            "desk_capacity": 2,
            "resource_type": {
                "id": "Large Conference Rooms",
                "name": "Large Conference Rooms"
            },
          "time_slots": [
                {
                    "week_day": "Monday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
                {
                    "week_day": "Tuesday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
                {
                    "week_day": "Wednesday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
                {
                    "week_day": "Thursday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
                {
                    "week_day": "Friday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                }
            ],
            "rates": [
                {
                    "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
                    "name": "Large Conference Rooms",
                    "description": "Large Conference Rooms",
                    "price": 175.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": true,
                "internet": true,
                "standard_phone": false,
                "conference_phone": true,
                "whiteBoard": false,
                "large_display": true,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=dfb844cd-f791-4d21-afa9-3b68c20f81e3",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=dfb844cd-f791-4d21-afa9-3b68c20f81e3&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/103?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    },
    {
        "resource": {
            "id": "3a65e5e6-44a6-476d-ab21-2116f367de47",
            "name": "HDMI Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
            "unit_types": [
                "Other"
            ],
          	"desks": [],
            "capacity": 15,
            "desk_capacity": 1,
          	"bookable_up_to_capacity": false,
            "resource_type": {
                "id": "Large Conference Rooms",
                "name": "Large Conference Rooms"
            },
						"time_slots": [
                {
                    "week_day": "Monday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
                {
                    "week_day": "Tuesday",
                    "from": {
                        "hour": 9,
                        "minute": 0
                    },
                    "until": {
                        "hour": 18,
                        "minute": 0
                    }
                },
            ],
            "rates": [
                {
                    "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
                    "name": "Large Conference Rooms",
                    "description": "Large Conference Rooms",
                    "price": 175.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": true,
                "internet": true,
                "standard_phone": false,
                "conference_phone": true,
                "whiteBoard": false,
                "large_display": true,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3a65e5e6-44a6-476d-ab21-2116f367de47",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3a65e5e6-44a6-476d-ab21-2116f367de47&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/102?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    },
    {
        "resource": {
            "id": "477e9962-5b46-417c-ac62-a808ff94db43",
            "name": "Nexudus Main Locker Group 1",
            "description": null,
            "unit_types": [
                "0"
            ],
            "capacity": null,
            "desk_capacity": 2,
            "resource_type": {
                "id": "Salto Lockers",
                "name": "Salto Lockers"
            },
            "rates": [],
						"time_slots": [
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": false,
                "internet": false,
                "standard_phone": false,
                "conference_phone": false,
                "whiteBoard": false,
                "large_display": false,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=477e9962-5b46-417c-ac62-a808ff94db43",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=477e9962-5b46-417c-ac62-a808ff94db43&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/606?w=600&h=600&anchor=middlecenter&cache=2024-01-30T16:10:27.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    },
    {
        "resource": {
            "id": "460768ae-df3e-455b-9305-3eb3cbd641c3",
            "name": "DVI Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br>",
            "unit_types": [
                "DedicatedDesk"
            ],
            "capacity": 15,
            "desk_capacity": 1,
            "resource_type": {
                "id": "Large Conference Rooms",
                "name": "Large Conference Rooms"
            },
            "rates": [
                {
                    "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
                    "name": "Large Conference Rooms",
                    "description": "Large Conference Rooms",
                    "price": 175.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": true,
                "quiet_zone": true,
                "wireless_charger": true,
                "privacy_screen": true,
                "soundproof": true,
                "catering": true,
                "tea_and_coffee": true,
                "drinks": true,
                "projector": true,
                "internet": true,
                "standard_phone": true,
                "conference_phone": true,
                "whiteBoard": true,
                "large_display": true,
                "security_lock": true,
                "CCTV": true,
                "voice_recorder": true,
                "air_conditioning": true,
                "heating": true,
                "natural_lLight": true,
                "dual_display_screen": true,
                "display_screen": true,
                "wireless_presentation": true,
                "pa_system": true,
                "desktop_monitor": true,
                "flip_chart": true,
                "secure_storage": true
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=460768ae-df3e-455b-9305-3eb3cbd641c3",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=460768ae-df3e-455b-9305-3eb3cbd641c3&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/101?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": 100.00000,
                "type": "Percentage",
                "charges_fee": true,
                "cancellation_limit_minutes": 60
            }
        },
        "available": false,
        "available_units": 1,
        "message": "This resource can only be booked 72.00000 hours in advance.",
        "error_code": "START_TIME_TOO_EARLY"
    },
    {
        "resource": {
            "id": "33178c6c-b17f-468e-9e26-c76886139014",
            "name": "USB Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
            "unit_types": [],
            "capacity": 15,
            "desk_capacity": 0,
            "resource_type": {
                "id": "Small Conference Rooms",
                "name": "Small Conference Rooms"
            },
            "rates": [
                {
                    "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
                    "name": "Small Conference Rooms",
                    "description": "Small Conference Rooms",
                    "price": 35.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": true,
                "internet": true,
                "standard_phone": false,
                "conference_phone": true,
                "whiteBoard": false,
                "large_display": true,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=33178c6c-b17f-468e-9e26-c76886139014",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=33178c6c-b17f-468e-9e26-c76886139014&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/105?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    },
    {
        "resource": {
            "id": "d0b7ea00-83bf-4a7a-90d6-65efdb50d89c",
            "name": "Router Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
            "unit_types": [
                "Other"
            ],
            "capacity": 15,
            "desk_capacity": 1,
            "resource_type": {
                "id": "Small Conference Rooms",
                "name": "Small Conference Rooms"
            },
            "rates": [
                {
                    "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
                    "name": "Small Conference Rooms",
                    "description": "Small Conference Rooms",
                    "price": 35.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": true,
                "internet": true,
                "standard_phone": false,
                "conference_phone": true,
                "whiteBoard": false,
                "large_display": true,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=d0b7ea00-83bf-4a7a-90d6-65efdb50d89c",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=d0b7ea00-83bf-4a7a-90d6-65efdb50d89c&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/104?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    },
    {
        "resource": {
            "id": "ec542a0f-030c-4c3a-bd3a-63f10e977906",
            "name": "VGA Room",
            "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
            "unit_types": [],
            "capacity": 15,
            "desk_capacity": 0,
            "resource_type": {
                "id": "Small Conference Rooms",
                "name": "Small Conference Rooms"
            },
            "rates": [
                {
                    "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
                    "name": "Small Conference Rooms",
                    "description": "Small Conference Rooms",
                    "price": 35.00000,
                    "period": "Minutes",
                    "members_only": false,
                    "contacts_only": false,
                    "min_length_minutes": null,
                    "max_length_minutes": null,
                    "fixed_price": null,
                    "fixed_price_length_minutes": null
                }
            ],
            "features": {
                "standing_desk": false,
                "quiet_zone": false,
                "wireless_charger": false,
                "privacy_screen": false,
                "soundproof": false,
                "catering": false,
                "tea_and_coffee": false,
                "drinks": false,
                "projector": true,
                "internet": true,
                "standard_phone": false,
                "conference_phone": true,
                "whiteBoard": false,
                "large_display": true,
                "security_lock": false,
                "CCTV": false,
                "voice_recorder": false,
                "air_conditioning": false,
                "heating": false,
                "natural_lLight": false,
                "dual_display_screen": false,
                "display_screen": false,
                "wireless_presentation": false,
                "pa_system": false,
                "desktop_monitor": false,
                "flip_chart": false,
                "secure_storage": false
            },
            "group": null,
            "calendar_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=ec542a0f-030c-4c3a-bd3a-63f10e977906",
            "available_url": "https://xyz.spaces.nexudus.com/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=ec542a0f-030c-4c3a-bd3a-63f10e977906&start_local=2024-02-01T14:15&duration_minutes=60",
            "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/106?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
            "cancellation_policy": {
                "amount": null,
                "percent": null,
                "type": "0",
                "charges_fee": false,
                "cancellation_limit_minutes": null
            }
        },
        "available": true,
        "available_units": 1,
        "message": null,
        "error_code": null
    }
]
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/search" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# 📰Feed
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-5

GET /api/apps/marketplaceApplications/feed
Gets your marketplace application feed contents

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="string">
  The unique id of your marketplace application.
</ParamField>

<ParamField type="string">
  The unique id of the location you would like to filter the feed by
</ParamField>

## Response

```json Example Response theme={null}
[
  {
    "location": {
      "id": "d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
      "network_id": "d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
      "name": "Central Coworks",
      "description": null,
      "logo_url": "https://xyz.spaces.nexudus.com/en/business/GetLogoById/101?w=1024&w=1024&anchor=middlecenter&cache=2024-01-29T17:52:08.0000000Z",
      "banner_url": "https://xyz.spaces.nexudus.com/en/business/GetBannerById/101?w=1024&w=1024&anchor=middlecenter&cache=2024-01-29T17:52:08.0000000Z",
      "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
      "feed_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/feed?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
      "lng": 0,
      "lat": 0,
      "address": null,
      "postcode": null,
      "city": null,
      "email": null,
      "phone": null,
      "timezone": {
        "name": "GMT Standard Time",
        "description": "(UTC) Dublin, Edinburgh, Lisbon, London",
        "iana": "Europe/London"
      },
      "currency": {
        "name": "US Dollar (USD)",
        "code": "USD"
      },
      "country": {
        "name": "United Kingdom",
        "code": "GB"
      },
      "opening_times": {
        "monday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "tuesday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "wednesday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "thursday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "friday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "saturday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        },
        "sunday": {
          "location_is_closed": false,
          "from_minutes_from_midnight": null,
          "until_minutes_from_midnight": null
        }
      },
      "cancellation_policy": "CancelInvoice"
    },
    "price_settings": {
      "tax_rate": 10,
      "prices_include_tax": false,
      "display_tax": false
    },
    "resources": [
      {
        "id": "460768ae-df3e-455b-9305-3eb3cbd641c3",
        "name": "DVI Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br>",
        "unit_types": [
          "DedicatedDesk"
        ],
        "capacity": 15,
        "desk_capacity": 1,
        "resource_type": {
          "id": "Large Conference Rooms",
          "name": "Large Conference Rooms"
        },
        "rates": [
          {
            "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
            "name": "Large Conference Rooms",
            "description": "Large Conference Rooms",
            "price": 175,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": true,
          "quiet_zone": true,
          "wireless_charger": true,
          "privacy_screen": true,
          "soundproof": true,
          "catering": true,
          "tea_and_coffee": true,
          "drinks": true,
          "projector": true,
          "internet": true,
          "standard_phone": true,
          "conference_phone": true,
          "whiteBoard": true,
          "large_display": true,
          "security_lock": true,
          "CCTV": true,
          "voice_recorder": true,
          "air_conditioning": true,
          "heating": true,
          "natural_lLight": true,
          "dual_display_screen": true,
          "display_screen": true,
          "wireless_presentation": true,
          "pa_system": true,
          "desktop_monitor": true,
          "flip_chart": true,
          "secure_storage": true
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=460768ae-df3e-455b-9305-3eb3cbd641c3",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=460768ae-df3e-455b-9305-3eb3cbd641c3&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/101?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": 100,
          "type": "Percentage",
          "charges_fee": true,
          "cancellation_limit_minutes": 60
        }
      },
      {
        "id": "3a65e5e6-44a6-476d-ab21-2116f367de47",
        "name": "HDMI Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
        "unit_types": [
          "Other"
        ],
        "capacity": 15,
        "desk_capacity": 1,
        "resource_type": {
          "id": "Large Conference Rooms",
          "name": "Large Conference Rooms"
        },
        "rates": [
          {
            "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
            "name": "Large Conference Rooms",
            "description": "Large Conference Rooms",
            "price": 175,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": true,
          "internet": true,
          "standard_phone": false,
          "conference_phone": true,
          "whiteBoard": false,
          "large_display": true,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3a65e5e6-44a6-476d-ab21-2116f367de47",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3a65e5e6-44a6-476d-ab21-2116f367de47&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/102?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "dfb844cd-f791-4d21-afa9-3b68c20f81e3",
        "name": "RJ-45 Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
        "unit_types": [
          "DedicatedDesk",
          "Other"
        ],
        "capacity": 15,
        "desk_capacity": 2,
        "resource_type": {
          "id": "Large Conference Rooms",
          "name": "Large Conference Rooms"
        },
        "rates": [
          {
            "id": "3099381d-c8dd-4994-b8fb-be1736b12b60",
            "name": "Large Conference Rooms",
            "description": "Large Conference Rooms",
            "price": 175,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": true,
          "internet": true,
          "standard_phone": false,
          "conference_phone": true,
          "whiteBoard": false,
          "large_display": true,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=dfb844cd-f791-4d21-afa9-3b68c20f81e3",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=dfb844cd-f791-4d21-afa9-3b68c20f81e3&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/103?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "d0b7ea00-83bf-4a7a-90d6-65efdb50d89c",
        "name": "Router Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
        "unit_types": [
          "Other"
        ],
        "capacity": 15,
        "desk_capacity": 1,
        "resource_type": {
          "id": "Small Conference Rooms",
          "name": "Small Conference Rooms"
        },
        "rates": [
          {
            "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
            "name": "Small Conference Rooms",
            "description": "Small Conference Rooms",
            "price": 35,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": true,
          "internet": true,
          "standard_phone": false,
          "conference_phone": true,
          "whiteBoard": false,
          "large_display": true,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=d0b7ea00-83bf-4a7a-90d6-65efdb50d89c",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=d0b7ea00-83bf-4a7a-90d6-65efdb50d89c&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/104?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "33178c6c-b17f-468e-9e26-c76886139014",
        "name": "USB Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
        "unit_types": [],
        "capacity": 15,
        "desk_capacity": 0,
        "resource_type": {
          "id": "Small Conference Rooms",
          "name": "Small Conference Rooms"
        },
        "rates": [
          {
            "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
            "name": "Small Conference Rooms",
            "description": "Small Conference Rooms",
            "price": 35,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": true,
          "internet": true,
          "standard_phone": false,
          "conference_phone": true,
          "whiteBoard": false,
          "large_display": true,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=33178c6c-b17f-468e-9e26-c76886139014",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=33178c6c-b17f-468e-9e26-c76886139014&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/105?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "ec542a0f-030c-4c3a-bd3a-63f10e977906",
        "name": "VGA Room",
        "description": "All you need to host your meetings and videoconferences. Equipped with: <br><ul> <li>Large TV</li> <li>10 Gb internet connection</li> <li>Conference phone</li> <li>Air-con, heating&nbsp;</li> <li>Natural light</li> </ul> <br> ",
        "unit_types": [],
        "capacity": 15,
        "desk_capacity": 0,
        "resource_type": {
          "id": "Small Conference Rooms",
          "name": "Small Conference Rooms"
        },
        "rates": [
          {
            "id": "708d450a-9a19-4345-92c6-6a20fb68dd1d",
            "name": "Small Conference Rooms",
            "description": "Small Conference Rooms",
            "price": 35,
            "period": "Minutes",
            "members_only": false,
            "contacts_only": false,
            "min_length_minutes": null,
            "max_length_minutes": null,
            "fixed_price": null,
            "fixed_price_length_minutes": null
          }
        ],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": true,
          "internet": true,
          "standard_phone": false,
          "conference_phone": true,
          "whiteBoard": false,
          "large_display": true,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=ec542a0f-030c-4c3a-bd3a-63f10e977906",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=ec542a0f-030c-4c3a-bd3a-63f10e977906&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/106?w=600&h=600&anchor=middlecenter&cache=2024-01-24T17:20:53.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "477e9962-5b46-417c-ac62-a808ff94db43",
        "name": "Nexudus Main Locker Group 1",
        "description": null,
        "unit_types": [
          "0"
        ],
        "capacity": null,
        "desk_capacity": 2,
        "resource_type": {
          "id": "Salto Lockers",
          "name": "Salto Lockers"
        },
        "rates": [],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": false,
          "internet": false,
          "standard_phone": false,
          "conference_phone": false,
          "whiteBoard": false,
          "large_display": false,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=477e9962-5b46-417c-ac62-a808ff94db43",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=477e9962-5b46-417c-ac62-a808ff94db43&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/606?w=600&h=600&anchor=middlecenter&cache=2024-01-30T16:10:27.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      },
      {
        "id": "3748847d-ba17-4e33-8736-2c2ed061cc78",
        "name": "Nexudus Main Locker Group 2",
        "description": null,
        "unit_types": [
          "0"
        ],
        "capacity": null,
        "desk_capacity": 0,
        "resource_type": {
          "id": "Salto Lockers",
          "name": "Salto Lockers"
        },
        "rates": [],
        "features": {
          "standing_desk": false,
          "quiet_zone": false,
          "wireless_charger": false,
          "privacy_screen": false,
          "soundproof": false,
          "catering": false,
          "tea_and_coffee": false,
          "drinks": false,
          "projector": false,
          "internet": false,
          "standard_phone": false,
          "conference_phone": false,
          "whiteBoard": false,
          "large_display": false,
          "security_lock": false,
          "CCTV": false,
          "voice_recorder": false,
          "air_conditioning": false,
          "heating": false,
          "natural_lLight": false,
          "dual_display_screen": false,
          "display_screen": false,
          "wireless_presentation": false,
          "pa_system": false,
          "desktop_monitor": false,
          "flip_chart": false,
          "secure_storage": false
        },
        "group": null,
        "calendar_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3748847d-ba17-4e33-8736-2c2ed061cc78",
        "available_url": "https://ellison.redirectme.net/api/apps/marketplaceapplications/available?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e&resource_id=3748847d-ba17-4e33-8736-2c2ed061cc78&start_local=2024-01-31T15:00&duration_minutes=60",
        "image_url": "https://xyz.spaces.nexudus.com/en/publicresources/getimage/707?w=600&h=600&anchor=middlecenter&cache=2024-01-30T16:10:27.0000000Z",
        "cancellation_policy": {
          "amount": null,
          "percent": null,
          "type": 0,
          "charges_fee": false,
          "cancellation_limit_minutes": null
        }
      }
    ],
    "plans": [
      {
        "id": "429f39d5-3f9c-45e0-9f43-a5a68bc56200",
        "name": "Hot-desk",
        "description": "A fully kitted desk at Default. Includes 10Gb internet connection, power and unlimited tea and coffee.",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fen%2Fsignup%2Fpriceplan%2F429f39d5-3f9c-45e0-9f43-a5a68bc56200",
        "price": {
          "amount": 250,
          "currency": "USD"
        },
        "price_per_day": 8.333333333333334,
        "group": null,
        "cycle_in_months": 1,
        "cycle_in_weeks": 0
      },
      {
        "id": "d4127ac9-c95e-4a18-97dc-40331bd189e1",
        "name": "Dedicated-desk",
        "description": "<p>Your own desk Default. Includes 10Gb internet connection, power, a private locker and unlimited tea and coffee.j</p>",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fen%2Fsignup%2Fpriceplan%2Fd4127ac9-c95e-4a18-97dc-40331bd189e1",
        "price": {
          "amount": 550,
          "currency": "USD"
        },
        "price_per_day": 18.333333333333332,
        "group": "Dedicated desks",
        "cycle_in_months": 1,
        "cycle_in_weeks": 0
      },
      {
        "id": "6965bdb2-4a76-4178-b206-fe43ed55f776",
        "name": "Private office",
        "description": "Your own private office Default. Includes 10Gb internet connection, bike racks, a parking space, unlimited tea and coffee and events for all your team.",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fen%2Fsignup%2Fpriceplan%2F6965bdb2-4a76-4178-b206-fe43ed55f776",
        "price": {
          "amount": 1150,
          "currency": "USD"
        },
        "price_per_day": 38.333333333333336,
        "group": null,
        "cycle_in_months": 1,
        "cycle_in_weeks": 0
      },
      {
        "id": "600d50c5-a024-4a9c-a32c-858e64315756",
        "name": "Part-time Access",
        "description": "Up to 10 days at Default. Includes 10Gb internet connection, unlimited tea and coffee and 30 USD of meeting room use a week.",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fen%2Fsignup%2Fpriceplan%2F600d50c5-a024-4a9c-a32c-858e64315756",
        "price": {
          "amount": 190,
          "currency": "USD"
        },
        "price_per_day": 6.333333333333333,
        "group": null,
        "cycle_in_months": 1,
        "cycle_in_weeks": 0
      }
    ],
    "products": [
      {
        "id": "38db1cd3-f268-4d43-923a-e8dcbf864820",
        "name": "Day Pass",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fstore%2Fproducts%3Fproduct_id%3D101",
        "image_url": "https://xyz.spaces.nexudus.com/en/products/getImage/101?w=600&w=600&anchor=middlecenter&cache=2023-08-22T17:09:38.0000000Z",
        "price": {
          "amount": 25,
          "currency": "USD"
        },
        "group": null
      },
      {
        "id": "6ee6bb60-1288-4d48-b255-d81b46f70069",
        "name": "10 day passes",
        "buy_url": "https://xyz.spaces.nexudus.com/login?returnurl=%2Fstore%2Fproducts%3Fproduct_id%3D102",
        "image_url": "https://xyz.spaces.nexudus.com/en/products/getImage/102?w=600&w=600&anchor=middlecenter&cache=2023-06-15T11:55:49.0000000Z",
        "price": {
          "amount": 200,
          "currency": "USD"
        },
        "group": "Day Passes"
      }
    ],
    "events": [
      {
        "id": "b110dfee-99d1-42ec-a3bd-c86fb3f94512",
        "name": "Python bootcamp",
        "image_url": "https://xyz.spaces.nexudus.com/en/events/getSmallImage?id=101&h=100&w=100&cache=2024-01-29T18:02:31.0000000Z",
        "large_image_url": "https://xyz.spaces.nexudus.com/en/events/getLargeImage?id=101&h=600&w=600&cache=2024-01-29T18:02:31.0000000Z",
        "buy_url": "https://xyz.spaces.nexudus.com/en/events/101/python-bootcamp",
        "tickets": []
      }
    ]
  }
]
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceApplications/feed" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# ✅Installations
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-6

GET /api/apps/marketplaceApplications/installations
Gets information about all the locations which enabled your marketplace application

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="string">
  The unique id of your marketplace application.
</ParamField>

## Response

```json Example Response theme={null}
[
  {
    "location_name": "Central Coworks",
    "location_id": "d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
    "accept_bookings": false,
    "accept_event_signups": false,
    "accept_payment_requests": false,
    "provide_resource_rrices": false,
    "provide_resources": false,
    "provide_events": false,
    "provide_products": false,
    "provide_tariffs": false,
    "calendar_url": "https://spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e",
    "feed_url": "https://spaces.nexudus.com/api/apps/marketplaceapplications/feed?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e"
  }
]
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceApplications/installations" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# Get multiple MarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-batch

GET /api/apps/marketplaceapplications/?id=[{id1},{id2},{id3}]
Retrieve multiple MarketPlaceApplication records by their Ids in a single request.

Fetch several MarketPlaceApplication records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`MarketPlaceApplication-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of MarketPlaceApplication Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of MarketPlaceApplication records. Each record has the same structure as the response from the [Get one MarketPlaceApplication](/rest-api/apps/get-marketplaceapplications-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each MarketPlaceApplication. The following fields are **not populated** in the response: `TermsAndConditions`, `SecretKey`, `Description`, `NotificationEmail`, `NotificationUrl`.

  To get all fields, fetch the full record using the [Get one MarketPlaceApplication](/rest-api/apps/get-marketplaceapplications-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "DeveloperId": 0,
    "Name": "",
    "SupportEmail": "",
    "DeveloperName": "",
    "Published": false,
    "ShortDescription": "",
    "LogoFileName": null,
    "NewLogoUrl": null,
    "ClearLogoFile": 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": "MarketPlaceApplication Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one MarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-by-id

GET /api/apps/marketplaceapplications/{id}
Retrieve a single MarketPlaceApplication record by its Id.

A **MarketPlaceApplication** represents an application available in the Nexudus marketplace. Marketplace apps provide integrations with third-party services, automation tools, and additional platform features.

## Authentication

<Note>
  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 **`MarketPlaceApplication-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the MarketPlaceApplication record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="DeveloperId" type="integer">
  ID of the developer linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this market place application.
</ResponseField>

<ResponseField name="TermsAndConditions" type="string">
  The terms and conditions value for this market place application.
</ResponseField>

<ResponseField name="SupportEmail" type="string">
  The support email value for this market place application.
</ResponseField>

<ResponseField name="DeveloperName" type="string">
  The developer name value for this market place application.
</ResponseField>

<ResponseField name="Published" type="boolean">
  Whether published is enabled.
</ResponseField>

<ResponseField name="SecretKey" type="string">
  The secret key value for this market place application.
</ResponseField>

<ResponseField name="ShortDescription" type="string">
  The short description value for this market place application.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this market place application.
</ResponseField>

<ResponseField name="NotificationEmail" type="string">
  The notification email value for this market place application.
</ResponseField>

<ResponseField name="NotificationUrl" type="string">
  The notification url value for this market place application.
</ResponseField>

<ResponseField name="LogoFileName" type="string">
  Current file name of the logo (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewLogoUrl" type="string">
  URL of a new file to upload as the logo.
</ResponseField>

<ResponseField name="ClearLogoFile" type="boolean">
  Set to true to remove the current logo file.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "DeveloperId": 0,
  "Name": "",
  "TermsAndConditions": null,
  "SupportEmail": "",
  "DeveloperName": "",
  "Published": false,
  "SecretKey": null,
  "ShortDescription": "",
  "Description": null,
  "NotificationEmail": "",
  "NotificationUrl": "",
  "LogoFileName": null,
  "NewLogoUrl": null,
  "ClearLogoFile": 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": "MarketPlaceApplication Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Commands for MarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/get-marketplaceapplications-commands

GET /api/apps/marketplaceapplications/commands
This endpoint lets you get the list of available commands for Market Place Application records.

# Commands for MarketPlaceApplications

This endpoint lets you get the list of available commands for Market Place Application records.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Query Parameters

<ParamField type="integer (int32)">
  If provided, only commands available for this Market Place Application will be returned.
</ParamField>

## Response

```json Example Response theme={null}
[
  {
    "Key": "COMMAND_KEY_1",
    "Name": "Command name",
    "AppliesOnlyToMultipleEntities": false,
    "DisplayInDropdown": false,
    "DisplayInDropdownV2": true,
    "AppliesOnlyToOneEntity": true,
    "AppliesOnlyToTwoEntities": false,
    "DisplayInGrid": false,
    "Icon": "/Content/Themes/Admin/Images/Icons/Fugue/gear.png",
    "NeedsEntitiesToRun": true,
    "Order": 8,
    "RequiresParameters": [
      {
        "Name": "Parameter name",
        "Type": "parameterType"
      }
    ]
  }
]
```

## Example Request

```bash theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/commands" \
  -H "Authorization: Bearer YOUR_TOKEN"
```


# Create Application
Source: https://learn.nexudus.com/rest-api/apps/post-applications

POST /api/apps/applications
Create a new Application record.

An **Application** represents a third-party application that can be installed as an add-on in a Nexudus account.

Each application is owned by a developer and identified by a unique `ApplicationKey` and `SecretKey` pair. The `InstallUrl` is the endpoint Nexudus calls when a location installs the application.

## Authentication

<Note>
  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 **`Application-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the developer linked to this record.
</ParamField>

<ParamField type="string">
  Display name of the application.
</ParamField>

<ParamField type="string">
  Brief summary of the application shown in listing views.
</ParamField>

<ParamField type="string">
  URL that Nexudus calls when a location installs this application.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether the application is published and available for installation.
</ParamField>

<ParamField type="string">
  Secret key used to authenticate API calls from the application.
</ParamField>

<ParamField type="string">
  Full description of the application shown on the detail page.
</ParamField>

<ParamField type="integer[]">
  List of required roles linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/apps/applications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "DeveloperId": 0,
      "Name": "",
      "ShortDescription": "",
      "InstallUrl": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        DeveloperId: 0,
        Name: '',
        ShortDescription: '',
        InstallUrl: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/apps/applications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'DeveloperId': 0,
          'Name': '',
          'ShortDescription': '',
          'InstallUrl': ''
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the application was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Application 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create InstalledApplication
Source: https://learn.nexudus.com/rest-api/apps/post-installedapplications

POST /api/apps/installedapplications
Create a new InstalledApplication record.

An **InstalledApplication** represents a third-party or internal application that has been installed and configured for a specific business location.

## Authentication

<Note>
  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 **`InstalledApplication-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the application linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether requires approval is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/apps/installedapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ApplicationId": 0,
      "BusinessId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ApplicationId: 0,
        BusinessId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/apps/installedapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ApplicationId': 0,
          'BusinessId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the installedapplication was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledApplication 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create InstalledMarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/post-installedmarketplaceapplications

POST /api/apps/installedmarketplaceapplications
Create a new InstalledMarketPlaceApplication record.

An **InstalledMarketPlaceApplication** represents a marketplace application that has been installed for a business. Marketplace apps extend platform functionality with integrations, automations, and additional features.

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the market place application linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether provide products is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resources is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide events is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide tariffs is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resource availability is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resource prices is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept bookings is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept event signups is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept payment requests is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "MarketPlaceApplicationId": 0,
      "BusinessId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        MarketPlaceApplicationId: 0,
        BusinessId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'MarketPlaceApplicationId': 0,
          'BusinessId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the installedmarketplaceapplication was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledMarketPlaceApplication 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create MarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/post-marketplaceapplications

POST /api/apps/marketplaceapplications
Create a new MarketPlaceApplication record.

A **MarketPlaceApplication** represents an application available in the Nexudus marketplace. Marketplace apps provide integrations with third-party services, automation tools, and additional platform features.

## Authentication

<Note>
  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 **`MarketPlaceApplication-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the developer linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this market place application.
</ParamField>

<ParamField type="string">
  The support email value for this market place application.
</ParamField>

<ParamField type="string">
  The developer name value for this market place application.
</ParamField>

<ParamField type="string">
  The short description value for this market place application.
</ParamField>

<ParamField type="string">
  The notification email value for this market place application.
</ParamField>

<ParamField type="string">
  The notification url value for this market place application.
</ParamField>

### Optional Fields

<ParamField type="string">
  The terms and conditions value for this market place application.
</ParamField>

<ParamField type="boolean">
  Whether published is enabled.
</ParamField>

<ParamField type="string">
  The secret key value for this market place application.
</ParamField>

<ParamField type="string">
  Free-text description of this market place application.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the logo.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current logo file.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "DeveloperId": 0,
      "Name": "",
      "SupportEmail": "",
      "DeveloperName": "",
      "ShortDescription": "",
      "NotificationEmail": "",
      "NotificationUrl": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        DeveloperId: 0,
        Name: '',
        SupportEmail: '',
        DeveloperName: '',
        ShortDescription: '',
        NotificationEmail: '',
        NotificationUrl: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'DeveloperId': 0,
          'Name': '',
          'SupportEmail': '',
          'DeveloperName': '',
          'ShortDescription': '',
          'NotificationEmail': '',
          'NotificationUrl': ''
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the marketplaceapplication was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "MarketPlaceApplication 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# 📆Book resource
Source: https://learn.nexudus.com/rest-api/apps/post-marketplaceapplications-2

POST /api/apps/marketplaceapplications/book
Creates a booking for a given resource, start date and duration.

# 📆Book resource

Creates a booking for a given resource, start date and duration.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Request Body

<ParamField type="string">
  The unique id of your marketplace application
</ParamField>

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string">
  The unique id of the location to get the calendar for
</ParamField>

<ParamField type="string (date-time)">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location.
</ParamField>

<ParamField type="string">
  The unique id of a desk defined within a resource.
</ParamField>

<ParamField type="integer (int32)">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

<ParamField type="string">
  The full name of the customer making this booking. Required when "email" is provided.
</ParamField>

<ParamField type="string">
  The email of the customer making this booking. . Required when "fullname" is provided.
</ParamField>

<ParamField type="string">
  A note to add alongside the booking. Customers will be able to see this note.
</ParamField>

<ParamField type="string">
  A note to add alongside the booking. Only operators will be able to see this note.
</ParamField>

<ParamField type="array" />

## Response

### 200

<ResponseField name="price" type="object" />

<ResponseField name="confirmation" type="object" />

<ResponseField name="available" type="boolean">
  Example: `false`
</ResponseField>

<ResponseField name="message" type="string">
  Example: `This resource is already booked. Please choose a different start and end times.`
</ResponseField>

<ResponseField name="error_code" type="string">
  Example: `BOOKING_CONFLICT`
</ResponseField>

```json Example Response theme={null}
{
  "price": {
    "amount": 4.81,
    "currency": "USD"
  },
  "confirmation": {
    "confirmed": false,
    "message": null,
    "booking_id": null
  },
  "available": false,
  "message": "This resource is already booked. Please choose a different start and end times.",
  "error_code": "BOOKING_CONFLICT"
}
```

## Example Request

```bash theme={null}
curl -X POST \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/book" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```


# 💲Quote resource
Source: https://learn.nexudus.com/rest-api/apps/post-marketplaceapplications-3

POST /api/apps/marketplaceapplications/quote
Obtains a price for a booking

# 💲Quote resource

Obtains a price for a booking

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Request Body

<ParamField type="string">
  The unique id of your marketplace application
</ParamField>

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string">
  The unique id of the location to get the calendar for
</ParamField>

<ParamField type="string (date-time)">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location.
</ParamField>

<ParamField type="integer (int32)">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

<ParamField type="string">
  The full name of the customer making this booking. Required when "email" is provided.
</ParamField>

<ParamField type="string">
  The email of the customer making this booking. . Required when "fullname" is provided.
</ParamField>

<ParamField type="array" />

## Response

```json Example Response theme={null}
{
    "price": {
        "amount": 4.17,
        "amount_with_tax": 5.00
        "currency": "USD"
    },
    "confirmation": {
        "confirmed": false,
        "message": null,
        "booking_id": null
    },
    "available": false,
    "message": "This resource is already booked. Please choose a different start and end times.",
    "error_code": "BOOKING_CONFLICT"
}
```

## Example Request

```bash theme={null}
curl -X POST \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/quote" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```


# Run command for MarketPlaceApplications
Source: https://learn.nexudus.com/rest-api/apps/post-marketplaceapplications-run-command

POST /api/apps/marketplaceapplications/runcommand
This endpoint lets you run a command for one or more Market Place Application records.

# Run command for MarketPlaceApplications

This endpoint lets you run a command for one or more Market Place Application records.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Request Body

<ParamField type="string">
  The key for the command to execute.
</ParamField>

<ParamField type="array">
  The list of record identifiers (Id field) for the Market Place Application records to execute this command for.
</ParamField>

<ParamField type="array">
  If this command requires any parameters, the name and value for each of them.
</ParamField>

## Response

### 200

<ResponseField name="Status" type="integer">
  Example: `200`
</ResponseField>

<ResponseField name="Message" type="string">
  Example: `The command was run correctly.`
</ResponseField>

<ResponseField name="Value" type="object" />

<ResponseField name="RedirectURL" type="any" />

<ResponseField name="UpdatedOn" type="string">
  Example: `2021-04-15T12:19:07Z`
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Example: `john@example.com`
</ResponseField>

<ResponseField name="Errors" type="any" />

<ResponseField name="WasSuccessful" type="boolean">
  Example: `true`
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": {
    "Id": 10605
  },
  "RedirectURL": null,
  "UpdatedOn": "2021-04-15T12:19:07Z",
  "UpdatedBy": "john@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

## Example Request

```bash theme={null}
curl -X POST \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/runcommand" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```


# Update Application
Source: https://learn.nexudus.com/rest-api/apps/put-applications

PUT /api/apps/applications
Update an existing Application record.

Updates an existing Application record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Application-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Application record to update.
</ParamField>

<ParamField type="integer">
  ID of the developer linked to this record.
</ParamField>

<ParamField type="string">
  Display name of the application.
</ParamField>

<ParamField type="string">
  Brief summary of the application shown in listing views.
</ParamField>

<ParamField type="string">
  URL that Nexudus calls when a location installs this application.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether the application is published and available for installation.
</ParamField>

<ParamField type="string">
  Secret key used to authenticate API calls from the application.
</ParamField>

<ParamField type="string">
  Full description of the application shown on the detail page.
</ParamField>

<ParamField type="integer[]">
  List of required roles linked to this record.
</ParamField>

<ParamField type="integer[]">
  Roles to add to the required roles list (used in partial updates).
</ParamField>

<ParamField type="integer[]">
  Roles to remove from the required roles list (used in partial updates).
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/apps/applications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "DeveloperId": 0,
      "Name": "",
      "ShortDescription": "",
      "InstallUrl": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/applications',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        DeveloperId: 0,
        Name: '',
        ShortDescription: '',
        InstallUrl: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/apps/applications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'DeveloperId': 0,
          'Name': '',
          'ShortDescription': '',
          'InstallUrl': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the application was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Application was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update InstalledApplication
Source: https://learn.nexudus.com/rest-api/apps/put-installedapplications

PUT /api/apps/installedapplications
Update an existing InstalledApplication record.

Updates an existing InstalledApplication record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`InstalledApplication-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the InstalledApplication record to update.
</ParamField>

<ParamField type="integer">
  ID of the application linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether requires approval is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/apps/installedapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ApplicationId": 0,
      "BusinessId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedapplications',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ApplicationId: 0,
        BusinessId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/apps/installedapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ApplicationId': 0,
          'BusinessId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the installedapplication was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledApplication was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update InstalledMarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/put-installedmarketplaceapplications

PUT /api/apps/installedmarketplaceapplications
Update an existing InstalledMarketPlaceApplication record.

Updates an existing InstalledMarketPlaceApplication record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`InstalledMarketPlaceApplication-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the InstalledMarketPlaceApplication record to update.
</ParamField>

<ParamField type="integer">
  ID of the market place application linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether provide products is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resources is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide events is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide tariffs is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resource availability is enabled.
</ParamField>

<ParamField type="boolean">
  Whether provide resource prices is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept bookings is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept event signups is enabled.
</ParamField>

<ParamField type="boolean">
  Whether accept payment requests is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/apps/installedmarketplaceapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "MarketPlaceApplicationId": 0,
      "BusinessId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        MarketPlaceApplicationId: 0,
        BusinessId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/apps/installedmarketplaceapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'MarketPlaceApplicationId': 0,
          'BusinessId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the installedmarketplaceapplication was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "InstalledMarketPlaceApplication was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update MarketPlaceApplication
Source: https://learn.nexudus.com/rest-api/apps/put-marketplaceapplications

PUT /api/apps/marketplaceapplications
Update an existing MarketPlaceApplication record.

Updates an existing MarketPlaceApplication record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`MarketPlaceApplication-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the MarketPlaceApplication record to update.
</ParamField>

<ParamField type="integer">
  ID of the developer linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this market place application.
</ParamField>

<ParamField type="string">
  The support email value for this market place application.
</ParamField>

<ParamField type="string">
  The developer name value for this market place application.
</ParamField>

<ParamField type="string">
  The short description value for this market place application.
</ParamField>

<ParamField type="string">
  The notification email value for this market place application.
</ParamField>

<ParamField type="string">
  The notification url value for this market place application.
</ParamField>

### Optional Fields

<ParamField type="string">
  The terms and conditions value for this market place application.
</ParamField>

<ParamField type="boolean">
  Whether published is enabled.
</ParamField>

<ParamField type="string">
  The secret key value for this market place application.
</ParamField>

<ParamField type="string">
  Free-text description of this market place application.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the logo.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current logo file.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/apps/marketplaceapplications" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "DeveloperId": 0,
      "Name": "",
      "SupportEmail": "",
      "DeveloperName": "",
      "ShortDescription": "",
      "NotificationEmail": "",
      "NotificationUrl": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/apps/marketplaceapplications',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        DeveloperId: 0,
        Name: '',
        SupportEmail: '',
        DeveloperName: '',
        ShortDescription: '',
        NotificationEmail: '',
        NotificationUrl: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/apps/marketplaceapplications',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'DeveloperId': 0,
          'Name': '',
          'SupportEmail': '',
          'DeveloperName': '',
          'ShortDescription': '',
          'NotificationEmail': '',
          'NotificationUrl': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the marketplaceapplication was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "MarketPlaceApplication was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# 📆Update resource booking
Source: https://learn.nexudus.com/rest-api/apps/put-marketplaceapplications-2

PUT /api/apps/marketplaceapplications/book
Updates a booking for a given resource, start date and duration.

# 📆Update resource booking

Updates a booking for a given resource, start date and duration.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
</Note>

## Request Body

<ParamField type="integer (int32)">
  The id of the booking to update.
</ParamField>

<ParamField type="string">
  The unique id of your marketplace application
</ParamField>

<ParamField type="string">
  The unique id of a location
</ParamField>

<ParamField type="string">
  The unique id of the location to get the calendar for
</ParamField>

<ParamField type="string (date-time)">
  The earliest date to show bookings for. The date and time are parsed in the local time of the passed in location.
</ParamField>

<ParamField type="string">
  The full name of the customer making this booking. Required when "email" is provided.
</ParamField>

<ParamField type="string">
  The email of the customer making this booking. . Required when "fullname" is provided.
</ParamField>

<ParamField type="integer (int32)">
  The amount of minutes after the start\_local time to show data for. Defaults to 60 minutes.
</ParamField>

<ParamField type="array" />

<ParamField type="string">
  A note to add alongside the booking. Customers will be able to see this note.
</ParamField>

<ParamField type="string">
  A note to add alongside the booking. Only operators will be able to see this note.
</ParamField>

## Response

### 200

<ResponseField name="price" type="object" />

<ResponseField name="confirmation" type="object" />

<ResponseField name="available" type="boolean">
  Example: `false`
</ResponseField>

<ResponseField name="message" type="string">
  Example: `This resource is already booked. Please choose a different start and end times.`
</ResponseField>

<ResponseField name="error_code" type="string">
  Example: `BOOKING_CONFLICT`
</ResponseField>

```json Example Response theme={null}
{
  "price": {
    "amount": 4.81,
    "currency": "USD"
  },
  "confirmation": {
    "confirmed": false,
    "message": null,
    "booking_id": null
  },
  "available": false,
  "message": "This resource is already booked. Please choose a different start and end times.",
  "error_code": "BOOKING_CONFLICT"
}
```

## Example Request

```bash theme={null}
curl -X PUT \
  "https://spaces.nexudus.com/api/apps/marketplaceapplications/book" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```


# Authentication
Source: https://learn.nexudus.com/rest-api/authentication

How to authenticate requests to the Nexudus REST API using Bearer tokens or Basic Auth

# Authentication

All REST API endpoints require authentication unless otherwise noted. The API supports two authentication schemes: **Bearer token** (recommended) and **Basic Auth**.

## Getting a Token

Use the [POST /api/token](/api/endpoints/auth/get-token) endpoint to exchange a username and password for a bearer token.

<Note>
  This request must be encoded as `application/x-www-form-urlencoded`, **not** `application/json`. Sending a JSON body will result in an `unsupported_grant_type` error.
</Note>

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=admin%40example.com&password=S3cur3P%40ss
```

The `client_id` parameter is optional. If provided, you must use the same value when refreshing the token. If omitted, the username (email) is used as the `client_id` automatically.

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=admin%40example.com&password=S3cur3P%40ss&client_id=my-app-identifier
```

```json theme={null}
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 604799,
  "refresh_token": "8xLOxBtZp8"
}
```

Use the `refresh_token` to obtain a new `access_token` after it expires without requiring the user to re-enter their password. See [Refresh a bearer token](/api/endpoints/auth/refresh-bearer-token) for details.

### Two-Factor Authentication

If the user has 2FA enabled, include the `totp` parameter with their current TOTP code:

```http theme={null}
POST /api/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=admin%40example.com&password=S3cur3P%40ss&totp=482910
```

## Bearer Token

Include the `access_token` in the `Authorization` header of every authenticated request:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  https://spaces.nexudus.com/api/spaces/coworkers
```

Bearer tokens are the recommended authentication method for server-to-server integrations and automated scripts.

## Basic Auth

You can also authenticate using HTTP Basic Auth by passing your Nexudus username and password directly:

```bash theme={null}
curl -u "admin@example.com:your-password" \
  https://spaces.nexudus.com/api/spaces/coworkers
```

Or by setting the `Authorization` header manually with a Base64-encoded `username:password` string:

```bash theme={null}
curl -H "Authorization: Basic $(echo -n 'admin@example.com:your-password' | base64)" \
  https://spaces.nexudus.com/api/spaces/coworkers
```

<Warning>
  Basic Auth transmits credentials on every request. Prefer Bearer tokens for long-running integrations to reduce credential exposure.
</Warning>

## Failed Authentication

When authentication fails or the account does not have permission for the requested resource, the API returns a `401 Unauthorized` response.


# Delete BasketSession
Source: https://learn.nexudus.com/rest-api/billing/delete-basketsessions-by-id

DELETE /api/billing/basketsessions/{id}
Delete an existing BasketSession record by its Id.

Deletes a BasketSession record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BasketSession-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BasketSession record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/basketsessions/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BasketSession was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete BusinessCharge
Source: https://learn.nexudus.com/rest-api/billing/delete-businesscharges-by-id

DELETE /api/billing/businesscharges/{id}
Delete an existing BusinessCharge record by its Id.

Deletes a BusinessCharge record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BusinessCharge-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BusinessCharge record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/businesscharges/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BusinessCharge was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Charge
Source: https://learn.nexudus.com/rest-api/billing/delete-charges-by-id

DELETE /api/billing/charges/{id}
Delete an existing Charge record by its Id.

Deletes a Charge record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Charge-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Charge record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/charges/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Charge was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ContractContact
Source: https://learn.nexudus.com/rest-api/billing/delete-contractcontacts-by-id

DELETE /api/billing/contractcontacts/{id}
Delete an existing ContractContact record by its Id.

Deletes a ContractContact record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ContractContact-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractContact record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/contractcontacts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractContact was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ContractDeposit
Source: https://learn.nexudus.com/rest-api/billing/delete-contractdeposits-by-id

DELETE /api/billing/contractdeposits/{id}
Delete an existing ContractDeposit record by its Id.

Deletes a ContractDeposit record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ContractDeposit-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractDeposit record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/contractdeposits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractDeposit was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ContractPausedPeriod
Source: https://learn.nexudus.com/rest-api/billing/delete-contractpausedperiods-by-id

DELETE /api/billing/contractpausedperiods/{id}
Delete an existing ContractPausedPeriod record by its Id.

Deletes a ContractPausedPeriod record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ContractPausedPeriod-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractPausedPeriod record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractPausedPeriod was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ContractProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-contractproducts-by-id

DELETE /api/billing/contractproducts/{id}
Delete an existing ContractProduct record by its Id.

Deletes a ContractProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ContractProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/contractproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/delete-contractschedules-by-id

DELETE /api/billing/contractschedules/{id}
Delete an existing ContractSchedule record by its Id.

Deletes a ContractSchedule record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ContractSchedule-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractSchedule record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/contractschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractSchedule was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerbookingcredits-by-id

DELETE /api/billing/coworkerbookingcredits/{id}
Delete an existing CoworkerBookingCredit record by its Id.

Deletes a CoworkerBookingCredit record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerBookingCredit-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerBookingCredit record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerBookingCredit was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerContract
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkercontracts-by-id

DELETE /api/billing/coworkercontracts/{id}
Delete an existing CoworkerContract record by its Id.

Deletes a CoworkerContract record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerContract record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkercontracts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerContract was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerDiscountCode
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerdiscountcodes-by-id

DELETE /api/billing/coworkerdiscountcodes/{id}
Delete an existing CoworkerDiscountCode record by its Id.

Deletes a CoworkerDiscountCode record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerDiscountCode-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerDiscountCode record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerDiscountCode was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerExtraService
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerextraservices-by-id

DELETE /api/billing/coworkerextraservices/{id}
Delete an existing CoworkerExtraService record by its Id.

Deletes a CoworkerExtraService record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerExtraService-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerExtraService record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraService was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerExtraServiceUseHistory
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerextraserviceusehistories-by-id

DELETE /api/billing/coworkerextraserviceusehistories/{id}
Delete an existing CoworkerExtraServiceUseHistory record by its Id.

Deletes a CoworkerExtraServiceUseHistory record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerExtraServiceUseHistory record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraServiceUseHistory was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerInvoiceHistory
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerinvoicehistories-by-id

DELETE /api/billing/coworkerinvoicehistories/{id}
Delete an existing CoworkerInvoiceHistory record by its Id.

Deletes a CoworkerInvoiceHistory record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoiceHistory record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoiceHistory was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerInvoicePaymentToken
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerinvoicepaymenttokens-by-id

DELETE /api/billing/coworkerinvoicepaymenttokens/{id}
Delete an existing CoworkerInvoicePaymentToken record by its Id.

Deletes a CoworkerInvoicePaymentToken record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoicePaymentToken record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoicePaymentToken was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerLedgerEntry
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerledgerentries-by-id

DELETE /api/billing/coworkerledgerentries/{id}
Delete an existing CoworkerLedgerEntry record by its Id.

Deletes a CoworkerLedgerEntry record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerLedgerEntry record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerLedgerEntry was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerPaymentMethod
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerpaymentmethods-by-id

DELETE /api/billing/coworkerpaymentmethods/{id}
Delete an existing CoworkerPaymentMethod record by its Id.

Deletes a CoworkerPaymentMethod record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerPaymentMethod record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerPaymentMethod was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkerproducts-by-id

DELETE /api/billing/coworkerproducts/{id}
Delete an existing CoworkerProduct record by its Id.

Deletes a CoworkerProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CoworkerProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkerproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CoworkerTimePass
Source: https://learn.nexudus.com/rest-api/billing/delete-coworkertimepasses-by-id

DELETE /api/billing/coworkertimepasses/{id}
Delete an existing CoworkerTimePass record by its Id.

Deletes a CoworkerTimePass record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerTimePass record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerTimePass was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete DiscountCode
Source: https://learn.nexudus.com/rest-api/billing/delete-discountcodes-by-id

DELETE /api/billing/discountcodes/{id}
Delete an existing DiscountCode record by its Id.

Deletes a DiscountCode record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`DiscountCode-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the DiscountCode record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/discountcodes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "DiscountCode was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ExtraServicePrice
Source: https://learn.nexudus.com/rest-api/billing/delete-extraserviceprices-by-id

DELETE /api/billing/extraserviceprices/{id}
Delete an existing ExtraServicePrice record by its Id.

Deletes a ExtraServicePrice record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ExtraServicePrice-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraServicePrice record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/extraserviceprices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServicePrice was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ExtraService
Source: https://learn.nexudus.com/rest-api/billing/delete-extraservices-by-id

DELETE /api/billing/extraservices/{id}
Delete an existing ExtraService record by its Id.

Deletes a ExtraService record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ExtraService-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraService record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/extraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraService was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ExtraServiceTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/delete-extraservicetimeslots-by-id

DELETE /api/billing/extraservicetimeslots/{id}
Delete an existing ExtraServiceTimeSlot record by its Id.

Deletes a ExtraServiceTimeSlot record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraServiceTimeSlot record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServiceTimeSlot was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete FinancialAccount
Source: https://learn.nexudus.com/rest-api/billing/delete-financialaccounts-by-id

DELETE /api/billing/financialaccounts/{id}
Delete an existing FinancialAccount record by its Id.

Deletes a FinancialAccount record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`FinancialAccount-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FinancialAccount record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/financialaccounts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FinancialAccount was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete PaymentGateway
Source: https://learn.nexudus.com/rest-api/billing/delete-paymentgateways-by-id

DELETE /api/billing/paymentgateways/{id}
Delete an existing PaymentGateway record by its Id.

Deletes a PaymentGateway record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`PaymentGateway-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the PaymentGateway record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/paymentgateways/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "PaymentGateway was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProductBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/delete-productbookingcredits-by-id

DELETE /api/billing/productbookingcredits/{id}
Delete an existing ProductBookingCredit record by its Id.

Deletes a ProductBookingCredit record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProductBookingCredit-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductBookingCredit record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/productbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductBookingCredit was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProductExtraService
Source: https://learn.nexudus.com/rest-api/billing/delete-productextraservices-by-id

DELETE /api/billing/productextraservices/{id}
Delete an existing ProductExtraService record by its Id.

Deletes a ProductExtraService record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProductExtraService-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductExtraService record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/productextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductExtraService was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Product
Source: https://learn.nexudus.com/rest-api/billing/delete-products-by-id

DELETE /api/billing/products/{id}
Delete an existing Product record by its Id.

Deletes a Product record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Product-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Product record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/products/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Product was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProductTimePass
Source: https://learn.nexudus.com/rest-api/billing/delete-producttimepasses-by-id

DELETE /api/billing/producttimepasses/{id}
Delete an existing ProductTimePass record by its Id.

Deletes a ProductTimePass record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProductTimePass-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductTimePass record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/producttimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductTimePass was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProposalContract
Source: https://learn.nexudus.com/rest-api/billing/delete-proposalcontracts-by-id

DELETE /api/billing/proposalcontracts/{id}
Delete an existing ProposalContract record by its Id.

Deletes a ProposalContract record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProposalContract-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalContract record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/proposalcontracts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContract was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProposalContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/delete-proposalcontractschedules-by-id

DELETE /api/billing/proposalcontractschedules/{id}
Delete an existing ProposalContractSchedule record by its Id.

Deletes a ProposalContractSchedule record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProposalContractSchedule-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalContractSchedule record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContractSchedule was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProposalProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-proposalproducts-by-id

DELETE /api/billing/proposalproducts/{id}
Delete an existing ProposalProduct record by its Id.

Deletes a ProposalProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProposalProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/proposalproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Proposal
Source: https://learn.nexudus.com/rest-api/billing/delete-proposals-by-id

DELETE /api/billing/proposals/{id}
Delete an existing Proposal record by its Id.

Deletes a Proposal record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Proposal-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Proposal record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/proposals/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Proposal was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ProposalSchedule
Source: https://learn.nexudus.com/rest-api/billing/delete-proposalschedules-by-id

DELETE /api/billing/proposalschedules/{id}
Delete an existing ProposalSchedule record by its Id.

Deletes a ProposalSchedule record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ProposalSchedule-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalSchedule record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/proposalschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalSchedule was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ResourceProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-resourceproducts-by-id

DELETE /api/billing/resourceproducts/{id}
Delete an existing ResourceProduct record by its Id.

Deletes a ResourceProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ResourceProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ResourceProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/resourceproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ResourceProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffbookingcredits-by-id

DELETE /api/billing/tariffbookingcredits/{id}
Delete an existing TariffBookingCredit record by its Id.

Deletes a TariffBookingCredit record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffBookingCredit-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffBookingCredit record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffBookingCredit was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffDefaultDueDate
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffdefaultduedates-by-id

DELETE /api/billing/tariffdefaultduedates/{id}
Delete an existing TariffDefaultDueDate record by its Id.

Deletes a TariffDefaultDueDate record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffDefaultDueDate-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffDefaultDueDate record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffDefaultDueDate was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffExtraService
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffextraservices-by-id

DELETE /api/billing/tariffextraservices/{id}
Delete an existing TariffExtraService record by its Id.

Deletes a TariffExtraService record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffExtraService-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffExtraService record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffExtraService was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffproducts-by-id

DELETE /api/billing/tariffproducts/{id}
Delete an existing TariffProduct record by its Id.

Deletes a TariffProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Tariff
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffs-by-id

DELETE /api/billing/tariffs/{id}
Delete an existing Tariff record by its Id.

Deletes a Tariff record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Tariff-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Tariff record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffs/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Tariff was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffSignupProduct
Source: https://learn.nexudus.com/rest-api/billing/delete-tariffsignupproducts-by-id

DELETE /api/billing/tariffsignupproducts/{id}
Delete an existing TariffSignupProduct record by its Id.

Deletes a TariffSignupProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffSignupProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffSignupProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffSignupProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TariffTimePass
Source: https://learn.nexudus.com/rest-api/billing/delete-tarifftimepasses-by-id

DELETE /api/billing/tarifftimepasses/{id}
Delete an existing TariffTimePass record by its Id.

Deletes a TariffTimePass record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TariffTimePass-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffTimePass record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffTimePass was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TimePass
Source: https://learn.nexudus.com/rest-api/billing/delete-timepasses-by-id

DELETE /api/billing/timepasses/{id}
Delete an existing TimePass record by its Id.

Deletes a TimePass record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TimePass-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePass record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/timepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePass was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TimePassPrice
Source: https://learn.nexudus.com/rest-api/billing/delete-timepassprices-by-id

DELETE /api/billing/timepassprices/{id}
Delete an existing TimePassPrice record by its Id.

Deletes a TimePassPrice record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TimePassPrice-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePassPrice record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/timepassprices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassPrice was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete TimePassTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/delete-timepasstimeslots-by-id

DELETE /api/billing/timepasstimeslots/{id}
Delete an existing TimePassTimeSlot record by its Id.

Deletes a TimePassTimeSlot record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`TimePassTimeSlot-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePassTimeSlot record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassTimeSlot was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Search BasketSessions
Source: https://learn.nexudus.com/rest-api/billing/get-basketsessions

GET /api/billing/basketsessions
Search and list BasketSession records with filtering, sorting, and pagination.

A **BasketSession** is an internal entity that temporarily stores basket items while a customer is checking out on the Members Portal. It is not intended for direct use via the API or CLI.

## Authentication

<Note>
  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 **`BasketSession-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by unique session identifier linking the basket to the customer's browser session.
</ParamField>

<ParamField type="string">
  Filter by jSON-serialised basket contents including selected products, quantities, and pricing.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/basketsessions?page=1&size=15&orderBy=SessionId&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'SessionId',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/basketsessions',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'SessionId',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by SessionId

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/basketsessions?BasketSession_SessionId=example-value&orderBy=SessionId&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions?' + new URLSearchParams({
      BasketSession_SessionId: 'example-value',
      orderBy: 'SessionId',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/basketsessions',
      params={
          'BasketSession_SessionId': 'example-value',
          'orderBy': 'SessionId',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/basketsessions?from_BasketSession_UpdatedOn=2025-01-01T00:00&to_BasketSession_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions?' + new URLSearchParams({
      from_BasketSession_UpdatedOn: '2025-01-01T00:00',
      to_BasketSession_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/basketsessions',
      params={
          'from_BasketSession_UpdatedOn': '2025-01-01T00:00',
          'to_BasketSession_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BasketSession[]">
  The list of BasketSession records matching the query. See the [Get one BasketSession](/rest-api/billing/get-basketsessions-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "SessionId": "",
      "JsonContents": 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": "BasketSession Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "SessionId",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BasketSessions
Source: https://learn.nexudus.com/rest-api/billing/get-basketsessions-batch

GET /api/billing/basketsessions/?id=[{id1},{id2},{id3}]
Retrieve multiple BasketSession records by their Ids in a single request.

Fetch several BasketSession records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BasketSession-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BasketSession Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/basketsessions/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/basketsessions/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BasketSession records. Each record has the same structure as the response from the [Get one BasketSession](/rest-api/billing/get-basketsessions-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "SessionId": "",
    "JsonContents": 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": "BasketSession Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BasketSession
Source: https://learn.nexudus.com/rest-api/billing/get-basketsessions-by-id

GET /api/billing/basketsessions/{id}
Retrieve a single BasketSession record by its Id.

A **BasketSession** is an internal entity that temporarily stores basket items while a customer is checking out on the Members Portal. It is not intended for direct use via the API or CLI.

## Authentication

<Note>
  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 **`BasketSession-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BasketSession record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/basketsessions/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="SessionId" type="string">
  Unique session identifier linking the basket to the customer's browser session.
</ResponseField>

<ResponseField name="JsonContents" type="string">
  JSON-serialised basket contents including selected products, quantities, and pricing.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "SessionId": "",
  "JsonContents": 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": "BasketSession Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search BusinessCharges
Source: https://learn.nexudus.com/rest-api/billing/get-businesscharges

GET /api/billing/businesscharges
Search and list BusinessCharge records with filtering, sorting, and pagination.

A **BusinessCharge** represents a charge issued by Nexudus to a specific location for platform services or subscription fees. Only Nexudus staff can create or manage these charges.

Charges can be one-off or recurring. Set `Recurrent` to `true` and provide `RepeatFrom` and `RepeatUntil` to define the recurrence window.

A charge moves through an approval workflow before it is invoiced. Use `ApprovedByBusiness` and `ApprovedBySender` to reflect the approval state. Once invoiced, the `Invoiced` flag will be set and `InvoicedOn` will record the date.

## Authentication

<Note>
  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 **`BusinessCharge-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the application linked to this record.
</ParamField>

<ParamField type="string">
  Filter by human-readable description of what this charge is for.
</ParamField>

<ParamField type="string">
  Filter by uRL that Nexudus will call back once the charge is processed or its status changes.
</ParamField>

<ParamField type="string">
  Filter by date by which the charge must be paid.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply to the charge amount (0–100).
</ParamField>

<ParamField type="number">
  Filter by total amount of the charge before tax.
</ParamField>

<ParamField type="number">
  Filter by tax amount applied to this charge.
</ParamField>

<ParamField type="boolean">
  Filter by true once the charge has been added to an invoice.
</ParamField>

<ParamField type="string">
  Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus.
</ParamField>

<ParamField type="boolean">
  Filter by true when the business (location) has approved the charge. Both parties must approve before the charge can be invoiced.
</ParamField>

<ParamField type="boolean">
  Filter by true when Nexudus (the sender) has approved the charge. Both parties must approve before the charge can be invoiced.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to make this a recurring charge. Use with `RepeatFrom` and `RepeatUntil` to define the recurrence window.
</ParamField>

<ParamField type="string">
  Filter by start date of the recurrence window. Required when `Recurrent` is true.
</ParamField>

<ParamField type="string">
  Filter by end date of the recurrence window. The charge will not be issued after this date.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date by which the charge must be paid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which the charge must be paid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply to the charge amount (0–100) greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply to the charge amount (0–100) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount of the charge before tax greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount of the charge before tax less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax amount applied to this charge greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax amount applied to this charge less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when the charge was included in an invoice. Set automatically by Nexudus less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the recurrence window. Required when `Recurrent` is true greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the recurrence window. Required when `Recurrent` is true less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the recurrence window. The charge will not be issued after this date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the recurrence window. The charge will not be issued after this date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges?page=1&size=15&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Description',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Description

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges?BusinessCharge_Description=example-value&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      BusinessCharge_Description: 'example-value',
      orderBy: 'Description',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'BusinessCharge_Description': 'example-value',
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges?from_BusinessCharge_UpdatedOn=2025-01-01T00:00&to_BusinessCharge_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges?' + new URLSearchParams({
      from_BusinessCharge_UpdatedOn: '2025-01-01T00:00',
      to_BusinessCharge_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      params={
          'from_BusinessCharge_UpdatedOn': '2025-01-01T00:00',
          'to_BusinessCharge_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BusinessCharge[]">
  The list of BusinessCharge records matching the query. See the [Get one BusinessCharge](/rest-api/billing/get-businesscharges-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each BusinessCharge. The following fields are **not populated** in the `Records[]` response: `CallBackUrl`, `DueDate`, `TaxAmount`.

  To get all fields, fetch the full record using the [Get one BusinessCharge](/rest-api/billing/get-businesscharges-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "ApplicationId": null,
      "Description": "",
      "PercentageDiscount": 0,
      "TotalAmount": 0,
      "Invoiced": false,
      "InvoicedOn": null,
      "ApprovedByBusiness": false,
      "ApprovedBySender": false,
      "Recurrent": false,
      "RepeatFrom": null,
      "RepeatUntil": 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": "BusinessCharge Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BusinessCharges
Source: https://learn.nexudus.com/rest-api/billing/get-businesscharges-batch

GET /api/billing/businesscharges/?id=[{id1},{id2},{id3}]
Retrieve multiple BusinessCharge records by their Ids in a single request.

Fetch several BusinessCharge records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BusinessCharge-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BusinessCharge Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/businesscharges/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BusinessCharge records. Each record has the same structure as the response from the [Get one BusinessCharge](/rest-api/billing/get-businesscharges-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each BusinessCharge. The following fields are **not populated** in the response: `CallBackUrl`, `DueDate`, `TaxAmount`.

  To get all fields, fetch the full record using the [Get one BusinessCharge](/rest-api/billing/get-businesscharges-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "ApplicationId": null,
    "Description": "",
    "PercentageDiscount": 0,
    "TotalAmount": 0,
    "Invoiced": false,
    "InvoicedOn": null,
    "ApprovedByBusiness": false,
    "ApprovedBySender": false,
    "Recurrent": false,
    "RepeatFrom": null,
    "RepeatUntil": 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": "BusinessCharge Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BusinessCharge
Source: https://learn.nexudus.com/rest-api/billing/get-businesscharges-by-id

GET /api/billing/businesscharges/{id}
Retrieve a single BusinessCharge record by its Id.

A **BusinessCharge** represents a charge issued by Nexudus to a specific location for platform services or subscription fees. Only Nexudus staff can create or manage these charges.

Charges can be one-off or recurring. Set `Recurrent` to `true` and provide `RepeatFrom` and `RepeatUntil` to define the recurrence window.

A charge moves through an approval workflow before it is invoiced. Use `ApprovedByBusiness` and `ApprovedBySender` to reflect the approval state. Once invoiced, the `Invoiced` flag will be set and `InvoicedOn` will record the date.

## Authentication

<Note>
  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 **`BusinessCharge-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BusinessCharge record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/businesscharges/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="ApplicationId" type="integer">
  ID of the application linked to this record.
</ResponseField>

<ResponseField name="Description" type="string">
  Human-readable description of what this charge is for.
</ResponseField>

<ResponseField name="CallBackUrl" type="string">
  URL that Nexudus will call back once the charge is processed or its status changes.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Date by which the charge must be paid.
</ResponseField>

<ResponseField name="PercentageDiscount" type="number">
  Percentage discount to apply to the charge amount (0–100).
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Total amount of the charge before tax.
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Tax amount applied to this charge.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  True once the charge has been added to an invoice.
</ResponseField>

<ResponseField name="InvoicedOn" type="string">
  Date and time when the charge was included in an invoice. Set automatically by Nexudus.
</ResponseField>

<ResponseField name="ApprovedByBusiness" type="boolean">
  True when the business (location) has approved the charge. Both parties must approve before the charge can be invoiced.
</ResponseField>

<ResponseField name="ApprovedBySender" type="boolean">
  True when Nexudus (the sender) has approved the charge. Both parties must approve before the charge can be invoiced.
</ResponseField>

<ResponseField name="Recurrent" type="boolean">
  Set to true to make this a recurring charge. Use with `RepeatFrom` and `RepeatUntil` to define the recurrence window.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Start date of the recurrence window. Required when `Recurrent` is true.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  End date of the recurrence window. The charge will not be issued after this date.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "ApplicationId": null,
  "Description": "",
  "CallBackUrl": "",
  "DueDate": null,
  "PercentageDiscount": 0,
  "TotalAmount": 0,
  "TaxAmount": 0,
  "Invoiced": false,
  "InvoicedOn": null,
  "ApprovedByBusiness": false,
  "ApprovedBySender": false,
  "Recurrent": false,
  "RepeatFrom": null,
  "RepeatUntil": 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": "BusinessCharge Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Charges
Source: https://learn.nexudus.com/rest-api/billing/get-charges

GET /api/billing/charges
Search and list Charge records with filtering, sorting, and pagination.

A **Charge** is a generic debit item applied to a customer account. Prefer more specific entities when available — use `CoworkerProduct` for product sales, `Booking` for room/resource bookings, `EventAttendee` for event registrations, and `CoworkerContract` for recurring plan charges.

Charges can reference the originating sale from another entity via its `UniqueId` (a GUID, not an integer ID). This is how items billed to a non-paying team member are passed through to the team's paying member: the charge appears on the paying member's account with a `UniqueId` reference back to the original `CoworkerProduct`, `Booking`, `EventAttendee`, or `CoworkerTimePass`.

Booking-related extra-service charges are represented by `CoworkerExtraService` records and referenced via `CoworkerExtraServiceUniqueId`.

## Authentication

<Note>
  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 **`Charge-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by business name.
</ParamField>

<ParamField type="string">
  Filter by business currency code.
</ParamField>

<ParamField type="string">
  Filter by charge number.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this charge.
</ParamField>

<ParamField type="string">
  Filter by display text on invoice line.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a regular charge.
</ParamField>

<ParamField type="number">
  Filter by discount amount.
</ParamField>

<ParamField type="number">
  Filter by credit amount.
</ParamField>

<ParamField type="string">
  Filter by discount code.
</ParamField>

<ParamField type="string">
  Filter by due date.
</ParamField>

<ParamField type="number">
  Filter by total amount.
</ParamField>

<ParamField type="string">
  Filter by purchase order.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the financial account linked to this record.
</ParamField>

<ParamField type="boolean">
  Filter by whether the charge has been invoiced.
</ParamField>

<ParamField type="string">
  Filter by date the charge was invoiced.
</ParamField>

<ParamField type="string">
  Filter by sale date.
</ParamField>

<ParamField type="boolean">
  Filter by whether from team member is enabled.
</ParamField>

<ParamField type="string">
  Filter by the coworker extra service name value for this charge.
</ParamField>

<ParamField type="string">
  Filter by the coworker time pass name value for this charge.
</ParamField>

<ParamField type="string">
  Filter by the coworker product name value for this charge.
</ParamField>

<ParamField type="string">
  Filter by the tariff name value for this charge.
</ParamField>

<ParamField type="string">
  Filter by iD of the coworker product unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by iD of the booking unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the CoworkerContract that originated this charge.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the CoworkerExtraService (booking extra-service charge) that originated this charge.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the ExtraService that originated this charge.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the CoworkerTimePass that originated this charge.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the original charge passed from a non-paying team member to the team's paying member.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the EventAttendee that originated this charge.
</ParamField>

<ParamField type="string">
  Filter by invoice period start date.
</ParamField>

<ParamField type="string">
  Filter by invoice period end date.
</ParamField>

<ParamField type="string">
  Filter by repeat from date.
</ParamField>

<ParamField type="string">
  Filter by repeat until date.
</ParamField>

<ParamField type="string">
  Filter by uniqueId of the CoworkerDiscountCode applied to this charge.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by total amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date the charge was invoiced greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the charge was invoiced less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by sale date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by sale date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice period start date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice period start date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice period end date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice period end date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/charges?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/charges',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/charges?Charge_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
      Charge_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/charges',
      params={
          'Charge_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/charges?from_Charge_UpdatedOn=2025-01-01T00:00&to_Charge_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
      from_Charge_UpdatedOn: '2025-01-01T00:00',
      to_Charge_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/charges',
      params={
          'from_Charge_UpdatedOn': '2025-01-01T00:00',
          'to_Charge_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Charge[]">
  The list of Charge records matching the query. See the [Get one Charge](/rest-api/billing/get-charges-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Charge. The following fields are **not populated** in the `Records[]` response: `DiscountAmount`, `CreditAmount`, `PurchaseOrder`.

  To get all fields, fetch the full record using the [Get one Charge](/rest-api/billing/get-charges-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "ChargeNumber": null,
      "Quantity": 0,
      "Description": null,
      "InvoiceLineDisplayAs": null,
      "RegularCharge": false,
      "DiscountCode": null,
      "DueDate": null,
      "TotalAmount": 0,
      "TaxRateId": null,
      "FinancialAccountId": null,
      "Invoiced": false,
      "InvoicedOn": null,
      "SaleDate": null,
      "FromTeamMember": false,
      "CoworkerExtraServiceName": null,
      "CoworkerTimePassName": null,
      "CoworkerProductName": null,
      "TariffName": null,
      "CoworkerProductUniqueId": null,
      "BookingUniqueId": null,
      "CoworkerContractUniqueId": null,
      "CoworkerExtraServiceUniqueId": null,
      "ExtraServiceUniqueId": null,
      "CoworkerTimePassUniqueId": null,
      "CoworkerChargeUniqueId": null,
      "EventAttendeeUniqueId": null,
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "CoworkerDiscountCodeUniqueId": 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": "Charge Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Charges
Source: https://learn.nexudus.com/rest-api/billing/get-charges-batch

GET /api/billing/charges/?id=[{id1},{id2},{id3}]
Retrieve multiple Charge records by their Ids in a single request.

Fetch several Charge records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Charge-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Charge Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/charges/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/charges/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Charge records. Each record has the same structure as the response from the [Get one Charge](/rest-api/billing/get-charges-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Charge. The following fields are **not populated** in the response: `DiscountAmount`, `CreditAmount`, `PurchaseOrder`.

  To get all fields, fetch the full record using the [Get one Charge](/rest-api/billing/get-charges-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessCurrencyCode": null,
    "ChargeNumber": null,
    "Quantity": 0,
    "Description": null,
    "InvoiceLineDisplayAs": null,
    "RegularCharge": false,
    "DiscountCode": null,
    "DueDate": null,
    "TotalAmount": 0,
    "TaxRateId": null,
    "FinancialAccountId": null,
    "Invoiced": false,
    "InvoicedOn": null,
    "SaleDate": null,
    "FromTeamMember": false,
    "CoworkerExtraServiceName": null,
    "CoworkerTimePassName": null,
    "CoworkerProductName": null,
    "TariffName": null,
    "CoworkerProductUniqueId": null,
    "BookingUniqueId": null,
    "CoworkerContractUniqueId": null,
    "CoworkerExtraServiceUniqueId": null,
    "ExtraServiceUniqueId": null,
    "CoworkerTimePassUniqueId": null,
    "CoworkerChargeUniqueId": null,
    "EventAttendeeUniqueId": null,
    "InvoiceFromDate": null,
    "InvoiceToDate": null,
    "RepeatFrom": null,
    "RepeatUntil": null,
    "CoworkerDiscountCodeUniqueId": 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": "Charge Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Charge
Source: https://learn.nexudus.com/rest-api/billing/get-charges-by-id

GET /api/billing/charges/{id}
Retrieve a single Charge record by its Id.

A **Charge** is a generic debit item applied to a customer account. Prefer more specific entities when available — use `CoworkerProduct` for product sales, `Booking` for room/resource bookings, `EventAttendee` for event registrations, and `CoworkerContract` for recurring plan charges.

Charges can reference the originating sale from another entity via its `UniqueId` (a GUID, not an integer ID). This is how items billed to a non-paying team member are passed through to the team's paying member: the charge appears on the paying member's account with a `UniqueId` reference back to the original `CoworkerProduct`, `Booking`, `EventAttendee`, or `CoworkerTimePass`.

Booking-related extra-service charges are represented by `CoworkerExtraService` records and referenced via `CoworkerExtraServiceUniqueId`.

## Authentication

<Note>
  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 **`Charge-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Charge record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/charges/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Business currency code.
</ResponseField>

<ResponseField name="ChargeNumber" type="string">
  Charge number.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this charge.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Display text on invoice line.
</ResponseField>

<ResponseField name="RegularCharge" type="boolean">
  Whether this is a regular charge.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount.
</ResponseField>

<ResponseField name="CreditAmount" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="DiscountCode" type="string">
  Discount code.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Due date.
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Total amount.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  ID of the tax rate linked to this record.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  ID of the financial account linked to this record.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  Whether the charge has been invoiced.
</ResponseField>

<ResponseField name="InvoicedOn" type="string">
  Date the charge was invoiced.
</ResponseField>

<ResponseField name="SaleDate" type="string">
  Sale date.
</ResponseField>

<ResponseField name="FromTeamMember" type="boolean">
  Whether from team member is enabled.
</ResponseField>

<ResponseField name="CoworkerExtraServiceName" type="string">
  The coworker extra service name value for this charge.
</ResponseField>

<ResponseField name="CoworkerTimePassName" type="string">
  The coworker time pass name value for this charge.
</ResponseField>

<ResponseField name="CoworkerProductName" type="string">
  The coworker product name value for this charge.
</ResponseField>

<ResponseField name="TariffName" type="string">
  The tariff name value for this charge.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  ID of the coworker product unique associated with this record.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  ID of the booking unique associated with this record.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  UniqueId of the CoworkerContract that originated this charge.
</ResponseField>

<ResponseField name="CoworkerExtraServiceUniqueId" type="string">
  UniqueId of the CoworkerExtraService (booking extra-service charge) that originated this charge.
</ResponseField>

<ResponseField name="ExtraServiceUniqueId" type="string">
  UniqueId of the ExtraService that originated this charge.
</ResponseField>

<ResponseField name="CoworkerTimePassUniqueId" type="string">
  UniqueId of the CoworkerTimePass that originated this charge.
</ResponseField>

<ResponseField name="CoworkerChargeUniqueId" type="string">
  UniqueId of the original charge passed from a non-paying team member to the team's paying member.
</ResponseField>

<ResponseField name="EventAttendeeUniqueId" type="string">
  UniqueId of the EventAttendee that originated this charge.
</ResponseField>

<ResponseField name="InvoiceFromDate" type="string">
  Invoice period start date.
</ResponseField>

<ResponseField name="InvoiceToDate" type="string">
  Invoice period end date.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Repeat from date.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Repeat until date.
</ResponseField>

<ResponseField name="CoworkerDiscountCodeUniqueId" type="string">
  UniqueId of the CoworkerDiscountCode applied to this charge.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "ChargeNumber": null,
  "Quantity": 0,
  "Description": null,
  "InvoiceLineDisplayAs": null,
  "RegularCharge": false,
  "DiscountAmount": 0,
  "CreditAmount": 0,
  "DiscountCode": null,
  "DueDate": null,
  "TotalAmount": 0,
  "PurchaseOrder": null,
  "TaxRateId": null,
  "FinancialAccountId": null,
  "Invoiced": false,
  "InvoicedOn": null,
  "SaleDate": null,
  "FromTeamMember": false,
  "CoworkerExtraServiceName": null,
  "CoworkerTimePassName": null,
  "CoworkerProductName": null,
  "TariffName": null,
  "CoworkerProductUniqueId": null,
  "BookingUniqueId": null,
  "CoworkerContractUniqueId": null,
  "CoworkerExtraServiceUniqueId": null,
  "ExtraServiceUniqueId": null,
  "CoworkerTimePassUniqueId": null,
  "CoworkerChargeUniqueId": null,
  "EventAttendeeUniqueId": null,
  "InvoiceFromDate": null,
  "InvoiceToDate": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "CoworkerDiscountCodeUniqueId": 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": "Charge Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ContractContacts
Source: https://learn.nexudus.com/rest-api/billing/get-contractcontacts

GET /api/billing/contractcontacts
Search and list ContractContact records with filtering, sorting, and pagination.

A **ContractContact** is a key contact entry on a virtual office contract (`CoworkerContract`). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract.

Each entry can be linked to an existing coworker via `CoworkerId`, in which case the coworker's name and email are resolved automatically. Alternatively, provide `FullName` and `Email` directly for contacts who do not have a coworker record.

Use `ContractContactType` to classify the contact:

| Type                 | Description                                                                 |
| -------------------- | --------------------------------------------------------------------------- |
| `Director`           | A director of the company registered under the virtual office contract      |
| `CompanyAlias`       | A trading name or alias used by the company                                 |
| `NominatedRecipient` | A person authorised to receive mail and deliveries on behalf of the company |

## Authentication

<Note>
  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 **`ContractContact-List`** role.
</Note>

## Enums

<Accordion title="eContractContactType — ContractContactType values">
  | Value | Name               |
  | ----- | ------------------ |
  | 0     | None               |
  | 1     | Director           |
  | 2     | CompanyAlias       |
  | 3     | NominatedRecipient |
</Accordion>

<Accordion title="eAmlCheckStatus — AmlCheckStatus values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | NotStarted      |
  | 1     | Pending         |
  | 2     | Clear           |
  | 3     | PotentialMatch  |
  | 4     | ConfirmedMatch  |
  | 5     | Error           |
  | 6     | ManuallyCleared |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker contract linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract contact.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk ids value for this contract contact.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk names value for this contract contact.
</ParamField>

<ParamField type="string">
  Filter by plan name of the associated virtual office contract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the linked coworker.
</ParamField>

<ParamField type="string">
  Filter by company name of the linked coworker.
</ParamField>

<ParamField type="string">
  Filter by billing name of the linked coworker.
</ParamField>

<ParamField type="string">
  Filter by email address of the linked coworker.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker active is enabled.
</ParamField>

<ParamField type="string">
  Filter by email address of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="string">
  Filter by full name of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="string">
  Filter by date of birth. Used for identity verification purposes.
</ParamField>

<ParamField type="string">
  Filter by street address.
</ParamField>

<ParamField type="string">
  Filter by post code.
</ParamField>

<ParamField type="string">
  Filter by city name.
</ParamField>

<ParamField type="string">
  Filter by state or province.
</ParamField>

<ParamField type="integer">
  Filter by iD of the country linked to this record.
</ParamField>

<ParamField type="string">
  Filter by country name.
</ParamField>

<ParamField type="string">
  Filter by phone number.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this contract contact.
</ParamField>

<ParamField type="integer">
  Filter by role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company).
</ParamField>

<ParamField type="integer">
  Filter by the AML check status for this contact.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was performed.
</ParamField>

<ParamField type="number">
  Filter by the score from the open sanctions check.
</ParamField>

<ParamField type="string">
  Filter by the response from the open sanctions check as JSON string.
</ParamField>

<ParamField type="string">
  Filter by the response from the Pappers AML check as TEXT string.
</ParamField>

<ParamField type="string">
  Filter by the status from the Pappers AML check.
</ParamField>

<ParamField type="string">
  Filter by notes related to the AML check. Customers cannot see this field, it's for internal use only.
</ParamField>

<ParamField type="string">
  Filter by the user who cleared the AML check.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was cleared.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract contact greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract contact less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date of birth. Used for identity verification purposes greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date of birth. Used for identity verification purposes less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was performed greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was performed less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by the score from the open sanctions check greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the score from the open sanctions check less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was cleared greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by the date when the AML check was cleared less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?page=1&size=15&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'FullName',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by FullName

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?ContractContact_FullName=example-value&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      ContractContact_FullName: 'example-value',
      orderBy: 'FullName',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'ContractContact_FullName': 'example-value',
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts?from_ContractContact_UpdatedOn=2025-01-01T00:00&to_ContractContact_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts?' + new URLSearchParams({
      from_ContractContact_UpdatedOn: '2025-01-01T00:00',
      to_ContractContact_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      params={
          'from_ContractContact_UpdatedOn': '2025-01-01T00:00',
          'to_ContractContact_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractContact[]">
  The list of ContractContact records matching the query. See the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractContact. The following fields are **not populated** in the `Records[]` response: `Address`, `PostCode`, `CityName`, `State`, `Notes`, `AmlOpenSanctionsResponse`, `AmlPappersResponse`.

  To get all fields, fetch the full record using the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerId": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerEmail": null,
      "CoworkerActive": null,
      "Email": null,
      "FullName": "",
      "DateOfBirth": null,
      "CountryId": null,
      "CountryName": null,
      "PhoneNumber": null,
      "ContractContactType": 0,
      "AmlCheckStatus": 0,
      "AmlCheckDate": null,
      "AmlOpenSanctionsScore": null,
      "AmlPappersStatus": null,
      "AmlNotes": null,
      "AmlClearedBy": null,
      "AmlClearedOn": 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": "ContractContact Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "FullName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ContractContacts
Source: https://learn.nexudus.com/rest-api/billing/get-contractcontacts-batch

GET /api/billing/contractcontacts/?id=[{id1},{id2},{id3}]
Retrieve multiple ContractContact records by their Ids in a single request.

Fetch several ContractContact records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ContractContact-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ContractContact Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractcontacts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ContractContact records. Each record has the same structure as the response from the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ContractContact. The following fields are **not populated** in the response: `Address`, `PostCode`, `CityName`, `State`, `Notes`, `AmlOpenSanctionsResponse`, `AmlPappersResponse`.

  To get all fields, fetch the full record using the [Get one ContractContact](/rest-api/billing/get-contractcontacts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerContractId": 0,
    "CoworkerContractQuantity": null,
    "CoworkerContractFloorPlanDeskIds": null,
    "CoworkerContractFloorPlanDeskNames": null,
    "CoworkerContractTariffName": null,
    "CoworkerId": null,
    "CoworkerFullName": null,
    "CoworkerCompanyName": null,
    "CoworkerBillingName": null,
    "CoworkerEmail": null,
    "CoworkerActive": null,
    "Email": null,
    "FullName": "",
    "DateOfBirth": null,
    "CountryId": null,
    "CountryName": null,
    "PhoneNumber": null,
    "ContractContactType": 0,
    "AmlCheckStatus": 0,
    "AmlCheckDate": null,
    "AmlOpenSanctionsScore": null,
    "AmlPappersStatus": null,
    "AmlNotes": null,
    "AmlClearedBy": null,
    "AmlClearedOn": 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": "ContractContact Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ContractContact
Source: https://learn.nexudus.com/rest-api/billing/get-contractcontacts-by-id

GET /api/billing/contractcontacts/{id}
Retrieve a single ContractContact record by its Id.

A **ContractContact** is a key contact entry on a virtual office contract (`CoworkerContract`). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract.

Each entry can be linked to an existing coworker via `CoworkerId`, in which case the coworker's name and email are resolved automatically. Alternatively, provide `FullName` and `Email` directly for contacts who do not have a coworker record.

Use `ContractContactType` to classify the contact:

| Type                 | Description                                                                 |
| -------------------- | --------------------------------------------------------------------------- |
| `Director`           | A director of the company registered under the virtual office contract      |
| `CompanyAlias`       | A trading name or alias used by the company                                 |
| `NominatedRecipient` | A person authorised to receive mail and deliveries on behalf of the company |

## Authentication

<Note>
  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 **`ContractContact-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractContact record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractcontacts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  ID of the coworker contract linked to this record.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  The coworker contract quantity value for this contract contact.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  The coworker contract floor plan desk ids value for this contract contact.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  The coworker contract floor plan desk names value for this contract contact.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Plan name of the associated virtual office contract.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the linked coworker.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the linked coworker.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the linked coworker.
</ResponseField>

<ResponseField name="CoworkerEmail" type="string">
  Email address of the linked coworker.
</ResponseField>

<ResponseField name="CoworkerActive" type="boolean">
  Whether coworker active is enabled.
</ResponseField>

<ResponseField name="Email" type="string">
  Email address of the contact. Used when the contact is not linked to a coworker record.
</ResponseField>

<ResponseField name="FullName" type="string">
  Full name of the contact. Used when the contact is not linked to a coworker record.
</ResponseField>

<ResponseField name="DateOfBirth" type="string">
  Date of birth. Used for identity verification purposes.
</ResponseField>

<ResponseField name="Address" type="string">
  Street address.
</ResponseField>

<ResponseField name="PostCode" type="string">
  Post code.
</ResponseField>

<ResponseField name="CityName" type="string">
  City name.
</ResponseField>

<ResponseField name="State" type="string">
  State or province.
</ResponseField>

<ResponseField name="CountryId" type="integer">
  ID of the country linked to this record.
</ResponseField>

<ResponseField name="CountryName" type="string">
  Country name.
</ResponseField>

<ResponseField name="PhoneNumber" type="string">
  Phone number.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this contract contact.
</ResponseField>

<ResponseField name="ContractContactType" type="integer">
  Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). See `eContractContactType` enum values: `0` = None, `1` = Director, `2` = CompanyAlias, `3` = NominatedRecipient.
</ResponseField>

<ResponseField name="AmlCheckStatus" type="integer">
  The AML check status for this contact. See `eAmlCheckStatus` enum values: `0` = NotStarted, `1` = Pending, `2` = Clear, `3` = PotentialMatch, `4` = ConfirmedMatch, `5` = Error, `6` = ManuallyCleared.
</ResponseField>

<ResponseField name="AmlCheckDate" type="string">
  The date when the AML check was performed.
</ResponseField>

<ResponseField name="AmlOpenSanctionsScore" type="number">
  The score from the open sanctions check.
</ResponseField>

<ResponseField name="AmlOpenSanctionsResponse" type="string">
  The response from the open sanctions check as JSON string.
</ResponseField>

<ResponseField name="AmlPappersResponse" type="string">
  The response from the Pappers AML check as TEXT string.
</ResponseField>

<ResponseField name="AmlPappersStatus" type="string">
  The status from the Pappers AML check.
</ResponseField>

<ResponseField name="AmlNotes" type="string">
  Notes related to the AML check. Customers cannot see this field, it's for internal use only.
</ResponseField>

<ResponseField name="AmlClearedBy" type="string">
  The user who cleared the AML check.
</ResponseField>

<ResponseField name="AmlClearedOn" type="string">
  The date when the AML check was cleared.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerId": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "CoworkerActive": null,
  "Email": null,
  "FullName": "",
  "DateOfBirth": null,
  "Address": null,
  "PostCode": null,
  "CityName": null,
  "State": null,
  "CountryId": null,
  "CountryName": null,
  "PhoneNumber": null,
  "Notes": null,
  "ContractContactType": 0,
  "AmlCheckStatus": 0,
  "AmlCheckDate": null,
  "AmlOpenSanctionsScore": null,
  "AmlOpenSanctionsResponse": null,
  "AmlPappersResponse": null,
  "AmlPappersStatus": null,
  "AmlNotes": null,
  "AmlClearedBy": null,
  "AmlClearedOn": 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": "ContractContact Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ContractDeposits
Source: https://learn.nexudus.com/rest-api/billing/get-contractdeposits

GET /api/billing/contractdeposits
Search and list ContractDeposit records with filtering, sorting, and pagination.

A **ContractDeposit** represents a security deposit or retainer associated with a plan contract (`CoworkerContract`). Each deposit is based on a `Product` and is charged to the member either on the first invoice generated for the contract, or on the next invoice for any contract that has `IncludeSignupFee = true`.

ContractDeposits are created automatically when a contract is signed for a plan (`Tariff`) that includes one or more `TariffSignupProducts`. Each `TariffSignupProduct` on the plan becomes a corresponding `ContractDeposit` on the new contract.

When `Refundable = true`, cancelling the parent contract automatically generates a credit note for the deposit amount. That credit note can then be applied — fully or partially — against any outstanding fees or damage charges raised via a separate invoice.

## Authentication

<Note>
  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 **`ContractDeposit-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker contract linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract deposit.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk ids value for this contract deposit.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk names value for this contract deposit.
</ParamField>

<ParamField type="string">
  Filter by name of the tariff/plan associated with the parent contract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the member holding the parent contract.
</ParamField>

<ParamField type="string">
  Filter by billing name of the member holding the parent contract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the product this deposit is based on.
</ParamField>

<ParamField type="number">
  Filter by default price of the underlying product (used when Price is not overridden).
</ParamField>

<ParamField type="string">
  Filter by iSO currency code of the underlying product.
</ParamField>

<ParamField type="string">
  Filter by optional notes or internal comments about this deposit.
</ParamField>

<ParamField type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product.
</ParamField>

<ParamField type="boolean">
  Filter by when true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ParamField>

<ParamField type="boolean">
  Filter by true once the deposit has been included in an invoice (either the first contract invoice or the next invoice when IncludeSignupFee = true on the contract).
</ParamField>

<ParamField type="boolean">
  Filter by true once a credit note has been issued for this refundable deposit following contract cancellation.
</ParamField>

<ParamField type="string">
  Filter by date and time when the deposit was included in an invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether invoice during online checkout is enabled.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract deposit greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract deposit less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by default price of the underlying product (used when Price is not overridden) greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by default price of the underlying product (used when Price is not overridden) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date and time when the deposit was included in an invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when the deposit was included in an invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?ContractDeposit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      ContractDeposit_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'ContractDeposit_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?from_ContractDeposit_UpdatedOn=2025-01-01T00:00&to_ContractDeposit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      from_ContractDeposit_UpdatedOn: '2025-01-01T00:00',
      to_ContractDeposit_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'from_ContractDeposit_UpdatedOn': '2025-01-01T00:00',
          'to_ContractDeposit_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractDeposit[]">
  The list of ContractDeposit records matching the query. See the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractDeposit. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductCurrencyCode": null,
      "Price": null,
      "Refundable": false,
      "Invoiced": false,
      "Credited": false,
      "InvoicedOn": null,
      "InvoiceDuringOnlineCheckout": false,
      "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": "ContractDeposit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ContractDeposits
Source: https://learn.nexudus.com/rest-api/billing/get-contractdeposits-batch

GET /api/billing/contractdeposits/?id=[{id1},{id2},{id3}]
Retrieve multiple ContractDeposit records by their Ids in a single request.

Fetch several ContractDeposit records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ContractDeposit-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ContractDeposit Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ContractDeposit records. Each record has the same structure as the response from the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ContractDeposit. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerContractId": 0,
    "CoworkerContractQuantity": null,
    "CoworkerContractFloorPlanDeskIds": null,
    "CoworkerContractFloorPlanDeskNames": null,
    "CoworkerContractTariffName": null,
    "CoworkerContractCoworkerId": null,
    "CoworkerContractCoworkerFullName": null,
    "CoworkerContractCoworkerBillingName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductCurrencyCode": null,
    "Price": null,
    "Refundable": false,
    "Invoiced": false,
    "Credited": false,
    "InvoicedOn": null,
    "InvoiceDuringOnlineCheckout": false,
    "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": "ContractDeposit Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ContractDeposit
Source: https://learn.nexudus.com/rest-api/billing/get-contractdeposits-by-id

GET /api/billing/contractdeposits/{id}
Retrieve a single ContractDeposit record by its Id.

A **ContractDeposit** represents a security deposit or retainer associated with a plan contract (`CoworkerContract`). Each deposit is based on a `Product` and is charged to the member either on the first invoice generated for the contract, or on the next invoice for any contract that has `IncludeSignupFee = true`.

ContractDeposits are created automatically when a contract is signed for a plan (`Tariff`) that includes one or more `TariffSignupProducts`. Each `TariffSignupProduct` on the plan becomes a corresponding `ContractDeposit` on the new contract.

When `Refundable = true`, cancelling the parent contract automatically generates a credit note for the deposit amount. That credit note can then be applied — fully or partially — against any outstanding fees or damage charges raised via a separate invoice.

## Authentication

<Note>
  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 **`ContractDeposit-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractDeposit record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  ID of the coworker contract linked to this record.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  The coworker contract quantity value for this contract deposit.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  The coworker contract floor plan desk ids value for this contract deposit.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  The coworker contract floor plan desk names value for this contract deposit.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Name of the tariff/plan associated with the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the coworker contract coworker associated with this record.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Full name of the member holding the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Billing name of the member holding the parent contract.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Name of the product this deposit is based on.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Default price of the underlying product (used when Price is not overridden).
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  ISO currency code of the underlying product.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or internal comments about this deposit.
</ResponseField>

<ResponseField name="Price" type="number">
  Deposit amount to charge. When set, overrides the default price of the linked product.
</ResponseField>

<ResponseField name="Refundable" type="boolean">
  When true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  True once the deposit has been included in an invoice (either the first contract invoice or the next invoice when IncludeSignupFee = true on the contract).
</ResponseField>

<ResponseField name="Credited" type="boolean">
  True once a credit note has been issued for this refundable deposit following contract cancellation.
</ResponseField>

<ResponseField name="InvoicedOn" type="string">
  Date and time when the deposit was included in an invoice.
</ResponseField>

<ResponseField name="InvoiceDuringOnlineCheckout" type="boolean">
  Whether invoice during online checkout is enabled.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "Notes": null,
  "Price": null,
  "Refundable": false,
  "Invoiced": false,
  "Credited": false,
  "InvoicedOn": null,
  "InvoiceDuringOnlineCheckout": false,
  "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": "ContractDeposit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ContractPausedPeriods
Source: https://learn.nexudus.com/rest-api/billing/get-contractpausedperiods

GET /api/billing/contractpausedperiods
Search and list ContractPausedPeriod records with filtering, sorting, and pagination.

A **ContractPausedPeriod** represents a freeze period applied to a customer's plan contract (`CoworkerContract`). Plan freezing lets admins — and optionally customers — suspend a contract for one or more billing cycles without cancelling it.

Freeze dates are always aligned to billing cycle boundaries: `PauseFrom` is always the first day of the customer's next billing cycle, and `PauseUntil` is always the first day of the billing cycle when the plan is due to restart.

While a contract is frozen:

* No charges are generated for the contract for the duration of the freeze.
* The customer's status reverts to **Contact** if they have no other active contract.
* No member rates or benefits from the frozen contract apply during the freeze.
* Invoices are still generated on the usual billing day for any purchases (bookings, products) linked to the contract.

Admins can freeze contracts from the customer's account, via teams, or in bulk from Finance > Contracts. Whether customers can freeze their own plans from the Members Portal is controlled by the `AllowContractFreezing` setting on the plan (`Tariff`).

## Authentication

<Note>
  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 **`ContractPausedPeriod-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the customer contract being frozen.
</ParamField>

<ParamField type="integer">
  Filter by quantity set on the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by comma-separated IDs of the floor plan desks assigned to the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by comma-separated names of the floor plan desks assigned to the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by name of the pricing plan (tariff) the frozen contract is for.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer holding the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by full name of the customer holding the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by billing name of the customer holding the frozen contract.
</ParamField>

<ParamField type="string">
  Filter by optional notes or reason for this freeze period.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze starts. Always falls on the first day of a billing cycle.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseFrom.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseUntil.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by quantity set on the frozen contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by quantity set on the frozen contract less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer holding the frozen contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer holding the frozen contract less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze starts. Always falls on the first day of a billing cycle greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze starts. Always falls on the first day of a billing cycle less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by uTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseFrom greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseFrom less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseUntil greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by location-timezone equivalent of PauseUntil less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods?ContractPausedPeriod_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods?' + new URLSearchParams({
      ContractPausedPeriod_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods',
      params={
          'ContractPausedPeriod_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods?from_ContractPausedPeriod_UpdatedOn=2025-01-01T00:00&to_ContractPausedPeriod_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods?' + new URLSearchParams({
      from_ContractPausedPeriod_UpdatedOn: '2025-01-01T00:00',
      to_ContractPausedPeriod_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods',
      params={
          'from_ContractPausedPeriod_UpdatedOn': '2025-01-01T00:00',
          'to_ContractPausedPeriod_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractPausedPeriod[]">
  The list of ContractPausedPeriod records matching the query. See the [Get one ContractPausedPeriod](/rest-api/billing/get-contractpausedperiods-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractPausedPeriod. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractPausedPeriod](/rest-api/billing/get-contractpausedperiods-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "PauseFrom": "2025-01-15T10:30:00Z",
      "PauseUntil": "2025-01-15T10:30:00Z",
      "PauseFromLocal": null,
      "PauseUntilLocal": 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": "ContractPausedPeriod Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ContractPausedPeriods
Source: https://learn.nexudus.com/rest-api/billing/get-contractpausedperiods-batch

GET /api/billing/contractpausedperiods/?id=[{id1},{id2},{id3}]
Retrieve multiple ContractPausedPeriod records by their Ids in a single request.

Fetch several ContractPausedPeriod records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ContractPausedPeriod-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ContractPausedPeriod Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ContractPausedPeriod records. Each record has the same structure as the response from the [Get one ContractPausedPeriod](/rest-api/billing/get-contractpausedperiods-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ContractPausedPeriod. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractPausedPeriod](/rest-api/billing/get-contractpausedperiods-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerContractId": 0,
    "CoworkerContractQuantity": null,
    "CoworkerContractFloorPlanDeskIds": null,
    "CoworkerContractFloorPlanDeskNames": null,
    "CoworkerContractTariffName": null,
    "CoworkerContractCoworkerId": null,
    "CoworkerContractCoworkerFullName": null,
    "CoworkerContractCoworkerBillingName": null,
    "PauseFrom": "2025-01-15T10:30:00Z",
    "PauseUntil": "2025-01-15T10:30:00Z",
    "PauseFromLocal": null,
    "PauseUntilLocal": 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": "ContractPausedPeriod Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ContractPausedPeriod
Source: https://learn.nexudus.com/rest-api/billing/get-contractpausedperiods-by-id

GET /api/billing/contractpausedperiods/{id}
Retrieve a single ContractPausedPeriod record by its Id.

A **ContractPausedPeriod** represents a freeze period applied to a customer's plan contract (`CoworkerContract`). Plan freezing lets admins — and optionally customers — suspend a contract for one or more billing cycles without cancelling it.

Freeze dates are always aligned to billing cycle boundaries: `PauseFrom` is always the first day of the customer's next billing cycle, and `PauseUntil` is always the first day of the billing cycle when the plan is due to restart.

While a contract is frozen:

* No charges are generated for the contract for the duration of the freeze.
* The customer's status reverts to **Contact** if they have no other active contract.
* No member rates or benefits from the frozen contract apply during the freeze.
* Invoices are still generated on the usual billing day for any purchases (bookings, products) linked to the contract.

Admins can freeze contracts from the customer's account, via teams, or in bulk from Finance > Contracts. Whether customers can freeze their own plans from the Members Portal is controlled by the `AllowContractFreezing` setting on the plan (`Tariff`).

## Authentication

<Note>
  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 **`ContractPausedPeriod-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractPausedPeriod record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  ID of the customer contract being frozen.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  Quantity set on the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  Comma-separated IDs of the floor plan desks assigned to the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  Comma-separated names of the floor plan desks assigned to the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Name of the pricing plan (tariff) the frozen contract is for.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Full name of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Billing name of the customer holding the frozen contract.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or reason for this freeze period.
</ResponseField>

<ResponseField name="PauseFrom" type="string">
  UTC date when the freeze starts. Always falls on the first day of a billing cycle.
</ResponseField>

<ResponseField name="PauseUntil" type="string">
  UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
</ResponseField>

<ResponseField name="PauseFromLocal" type="string">
  Location-timezone equivalent of PauseFrom.
</ResponseField>

<ResponseField name="PauseUntilLocal" type="string">
  Location-timezone equivalent of PauseUntil.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "Notes": null,
  "PauseFrom": "2025-01-15T10:30:00Z",
  "PauseUntil": "2025-01-15T10:30:00Z",
  "PauseFromLocal": null,
  "PauseUntilLocal": 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": "ContractPausedPeriod Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ContractProducts
Source: https://learn.nexudus.com/rest-api/billing/get-contractproducts

GET /api/billing/contractproducts
Search and list ContractProduct records with filtering, sorting, and pagination.

A **ContractProduct** is a product added to a contract that is billed every time the contract is invoiced. Use `ContractProduct` to append product charges to a specific member's billing cycle alongside the base plan.

**Price** — If `Price` is not set, the price of the underlying product (`ProductPrice`) is used instead. Set `Price` to override the product's default price for this specific contract line.

**Billing window** — `RepeatFrom` and `RepeatUntil` control the date range during which the product is included on invoices. Outside that range the product is silently skipped. Leave both null to bill the product on every invoice.

**Pro-rating** — `ApplyProRating` distributes the charge proportionally across the billing period, but only takes effect when the linked location plan has prorating enabled (`Tariff.ProrateDaysBefore > 0`). If the plan does not have prorating configured, `ApplyProRating` is ignored.

## Authentication

<Note>
  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 **`ContractProduct-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by contract to add this product to.
</ParamField>

<ParamField type="integer">
  Filter by quantity associated with the contract.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk IDs assigned to the contract.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk names assigned to the contract.
</ParamField>

<ParamField type="string">
  Filter by coworker contract tariff name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the member on the contract.
</ParamField>

<ParamField type="string">
  Filter by contract coworker full name.
</ParamField>

<ParamField type="string">
  Filter by contract coworker billing name.
</ParamField>

<ParamField type="integer">
  Filter by product to bill on each contract invoice.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="boolean">
  Filter by whether the underlying product applies pro-rating by default.
</ParamField>

<ParamField type="string">
  Filter by product currency code.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this contract product.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="number">
  Filter by price override.
</ParamField>

<ParamField type="string">
  Filter by repeat from date.
</ParamField>

<ParamField type="string">
  Filter by repeat until date.
</ParamField>

<ParamField type="boolean">
  Filter by apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by quantity associated with the contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by quantity associated with the contract less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the member on the contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the member on the contract less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by repeat from date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts?ContractProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts?' + new URLSearchParams({
      ContractProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractproducts',
      params={
          'ContractProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts?from_ContractProduct_UpdatedOn=2025-01-01T00:00&to_ContractProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts?' + new URLSearchParams({
      from_ContractProduct_UpdatedOn: '2025-01-01T00:00',
      to_ContractProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractproducts',
      params={
          'from_ContractProduct_UpdatedOn': '2025-01-01T00:00',
          'to_ContractProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractProduct[]">
  The list of ContractProduct records matching the query. See the [Get one ContractProduct](/rest-api/billing/get-contractproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractProduct. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractProduct](/rest-api/billing/get-contractproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductApplyProRating": null,
      "ProductCurrencyCode": null,
      "Quantity": 0,
      "Price": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "ApplyProRating": false,
      "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": "ContractProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ContractProducts
Source: https://learn.nexudus.com/rest-api/billing/get-contractproducts-batch

GET /api/billing/contractproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple ContractProduct records by their Ids in a single request.

Fetch several ContractProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ContractProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ContractProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ContractProduct records. Each record has the same structure as the response from the [Get one ContractProduct](/rest-api/billing/get-contractproducts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ContractProduct. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractProduct](/rest-api/billing/get-contractproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerContractId": 0,
    "CoworkerContractQuantity": null,
    "CoworkerContractFloorPlanDeskIds": null,
    "CoworkerContractFloorPlanDeskNames": null,
    "CoworkerContractTariffName": null,
    "CoworkerContractCoworkerId": null,
    "CoworkerContractCoworkerFullName": null,
    "CoworkerContractCoworkerBillingName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductApplyProRating": null,
    "ProductCurrencyCode": null,
    "Quantity": 0,
    "Price": null,
    "RepeatFrom": null,
    "RepeatUntil": null,
    "ApplyProRating": false,
    "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": "ContractProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ContractProduct
Source: https://learn.nexudus.com/rest-api/billing/get-contractproducts-by-id

GET /api/billing/contractproducts/{id}
Retrieve a single ContractProduct record by its Id.

A **ContractProduct** is a product added to a contract that is billed every time the contract is invoiced. Use `ContractProduct` to append product charges to a specific member's billing cycle alongside the base plan.

**Price** — If `Price` is not set, the price of the underlying product (`ProductPrice`) is used instead. Set `Price` to override the product's default price for this specific contract line.

**Billing window** — `RepeatFrom` and `RepeatUntil` control the date range during which the product is included on invoices. Outside that range the product is silently skipped. Leave both null to bill the product on every invoice.

**Pro-rating** — `ApplyProRating` distributes the charge proportionally across the billing period, but only takes effect when the linked location plan has prorating enabled (`Tariff.ProrateDaysBefore > 0`). If the plan does not have prorating configured, `ApplyProRating` is ignored.

## Authentication

<Note>
  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 **`ContractProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  Contract to add this product to.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  Quantity associated with the contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  Floor plan desk IDs assigned to the contract.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  Floor plan desk names assigned to the contract.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Coworker contract tariff name.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the member on the contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Contract coworker full name.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Contract coworker billing name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  Product to bill on each contract invoice.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductApplyProRating" type="boolean">
  Whether the underlying product applies pro-rating by default.
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  Product currency code.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this contract product.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Repeat from date.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Repeat until date.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductApplyProRating": null,
  "ProductCurrencyCode": null,
  "Notes": null,
  "Quantity": 0,
  "Price": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "ApplyProRating": false,
  "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": "ContractProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ContractSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-contractschedules

GET /api/billing/contractschedules
Search and list ContractSchedule records with filtering, sorting, and pagination.

A **ContractSchedule** defines a future price change for a plan contract (`CoworkerContract`). On the date specified by `ApplyOn`, the system automatically updates the contract's price to the value in `Price`.

Schedules allow operators to pre-configure stepped pricing — for example, an introductory rate for the first few months that transitions to a full rate on a known date — without any manual intervention at the time of the change.

Once a schedule has been processed, `Applied` is set to `true` and the record becomes read-only.

## Authentication

<Note>
  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 **`ContractSchedule-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker contract linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract schedule.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk ids value for this contract schedule.
</ParamField>

<ParamField type="string">
  Filter by the coworker contract floor plan desk names value for this contract schedule.
</ParamField>

<ParamField type="string">
  Filter by name of the tariff/plan associated with the parent contract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the member holding the parent contract.
</ParamField>

<ParamField type="string">
  Filter by billing name of the member holding the parent contract.
</ParamField>

<ParamField type="string">
  Filter by optional notes or internal comments about this scheduled price change.
</ParamField>

<ParamField type="number">
  Filter by the new contract price to apply on the scheduled date.
</ParamField>

<ParamField type="string">
  Filter by date on which the system will automatically update the contract price to the value in Price.
</ParamField>

<ParamField type="string">
  Filter by date/time value for apply on local.
</ParamField>

<ParamField type="boolean">
  Filter by true once the price change has been applied to the contract. The record becomes read-only after this point.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract schedule greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the coworker contract quantity value for this contract schedule less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker contract coworker associated with this record less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the new contract price to apply on the scheduled date greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the new contract price to apply on the scheduled date less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date on which the system will automatically update the contract price to the value in Price greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which the system will automatically update the contract price to the value in Price less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for apply on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for apply on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractschedules?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractschedules',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractschedules?ContractSchedule_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules?' + new URLSearchParams({
      ContractSchedule_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractschedules',
      params={
          'ContractSchedule_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractschedules?from_ContractSchedule_UpdatedOn=2025-01-01T00:00&to_ContractSchedule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules?' + new URLSearchParams({
      from_ContractSchedule_UpdatedOn: '2025-01-01T00:00',
      to_ContractSchedule_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractschedules',
      params={
          'from_ContractSchedule_UpdatedOn': '2025-01-01T00:00',
          'to_ContractSchedule_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ContractSchedule[]">
  The list of ContractSchedule records matching the query. See the [Get one ContractSchedule](/rest-api/billing/get-contractschedules-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractSchedule. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractSchedule](/rest-api/billing/get-contractschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "Price": null,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "ApplyOnLocal": null,
      "Applied": false,
      "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": "ContractSchedule Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ContractSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-contractschedules-batch

GET /api/billing/contractschedules/?id=[{id1},{id2},{id3}]
Retrieve multiple ContractSchedule records by their Ids in a single request.

Fetch several ContractSchedule records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ContractSchedule-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ContractSchedule Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractschedules/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractschedules/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ContractSchedule records. Each record has the same structure as the response from the [Get one ContractSchedule](/rest-api/billing/get-contractschedules-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ContractSchedule. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractSchedule](/rest-api/billing/get-contractschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerContractId": 0,
    "CoworkerContractQuantity": null,
    "CoworkerContractFloorPlanDeskIds": null,
    "CoworkerContractFloorPlanDeskNames": null,
    "CoworkerContractTariffName": null,
    "CoworkerContractCoworkerId": null,
    "CoworkerContractCoworkerFullName": null,
    "CoworkerContractCoworkerBillingName": null,
    "Price": null,
    "ApplyOn": "2025-01-15T10:30:00Z",
    "ApplyOnLocal": null,
    "Applied": false,
    "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": "ContractSchedule Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/get-contractschedules-by-id

GET /api/billing/contractschedules/{id}
Retrieve a single ContractSchedule record by its Id.

A **ContractSchedule** defines a future price change for a plan contract (`CoworkerContract`). On the date specified by `ApplyOn`, the system automatically updates the contract's price to the value in `Price`.

Schedules allow operators to pre-configure stepped pricing — for example, an introductory rate for the first few months that transitions to a full rate on a known date — without any manual intervention at the time of the change.

Once a schedule has been processed, `Applied` is set to `true` and the record becomes read-only.

## Authentication

<Note>
  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 **`ContractSchedule-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ContractSchedule record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  ID of the coworker contract linked to this record.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  The coworker contract quantity value for this contract schedule.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  The coworker contract floor plan desk ids value for this contract schedule.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  The coworker contract floor plan desk names value for this contract schedule.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Name of the tariff/plan associated with the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  ID of the coworker contract coworker associated with this record.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Full name of the member holding the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Billing name of the member holding the parent contract.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or internal comments about this scheduled price change.
</ResponseField>

<ResponseField name="Price" type="number">
  The new contract price to apply on the scheduled date.
</ResponseField>

<ResponseField name="ApplyOn" type="string">
  Date on which the system will automatically update the contract price to the value in Price.
</ResponseField>

<ResponseField name="ApplyOnLocal" type="string">
  Date/time value for apply on local.
</ResponseField>

<ResponseField name="Applied" type="boolean">
  True once the price change has been applied to the contract. The record becomes read-only after this point.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "Notes": null,
  "Price": null,
  "ApplyOn": "2025-01-15T10:30:00Z",
  "ApplyOnLocal": null,
  "Applied": false,
  "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": "ContractSchedule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcredits

GET /api/billing/coworkerbookingcredits
Search and list CoworkerBookingCredit records with filtering, sorting, and pagination.

A **CoworkerBookingCredit** is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer's contract on a plan that includes a `TariffBookingCredit` renews, but can also be created manually.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ValidFrom` and `ExpireDate` to control the validity window of the credit.

## Authentication

<Note>
  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 **`CoworkerBookingCredit-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the customer this credit is assigned to.
</ParamField>

<ParamField type="integer">
  Filter by iD of the location issuing the credit.
</ParamField>

<ParamField type="string">
  Filter by location name.
</ParamField>

<ParamField type="string">
  Filter by currency code of the location.
</ParamField>

<ParamField type="string">
  Filter by optional description or label for this credit.
</ParamField>

<ParamField type="integer">
  Filter by iD of the plan credit template (TariffBookingCredit) that originated this credit, if any.
</ParamField>

<ParamField type="string">
  Filter by name of the plan credit template that originated this credit.
</ParamField>

<ParamField type="number">
  Filter by remaining credit balance.
</ParamField>

<ParamField type="number">
  Filter by total credit amount originally assigned.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit is valid.
</ParamField>

<ParamField type="string">
  Filter by date on which this credit expires.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the product purchase that created this credit.
</ParamField>

<ParamField type="boolean">
  Filter by whether to use the credit price instead of the standard booking price when this credit is applied.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the contract that originated this credit.
</ParamField>

<ParamField type="boolean">
  Filter by whether this universal credit applies to other charges.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by remaining credit balance greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by remaining credit balance less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total credit amount originally assigned greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total credit amount originally assigned less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit is valid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit is valid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which this credit expires greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which this credit expires less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?CoworkerBookingCredit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits?' + new URLSearchParams({
      CoworkerBookingCredit_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
      params={
          'CoworkerBookingCredit_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?from_CoworkerBookingCredit_UpdatedOn=2025-01-01T00:00&to_CoworkerBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits?' + new URLSearchParams({
      from_CoworkerBookingCredit_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerBookingCredit_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
      params={
          'from_CoworkerBookingCredit_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerBookingCredit_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerBookingCredit[]">
  The list of CoworkerBookingCredit records matching the query. See the [Get one CoworkerBookingCredit](/rest-api/billing/get-coworkerbookingcredits-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerBookingCredit. The following fields are **not populated** in the `Records[]` response: `Description`, `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one CoworkerBookingCredit](/rest-api/billing/get-coworkerbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "TariffBookingCreditId": null,
      "TariffBookingCreditName": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "RemainingCredit": 0,
      "TotalCredit": 0,
      "ValidFrom": null,
      "ExpireDate": null,
      "EventCategories": [],
      "CoworkerProductUniqueId": null,
      "UseCreditPrice": false,
      "CoworkerContractUniqueId": null,
      "ElegiblePasses": [],
      "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": "CoworkerBookingCredit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcredits-batch

GET /api/billing/coworkerbookingcredits/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerBookingCredit records by their Ids in a single request.

Fetch several CoworkerBookingCredit records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerBookingCredit-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerBookingCredit Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcredits/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerBookingCredit records. Each record has the same structure as the response from the [Get one CoworkerBookingCredit](/rest-api/billing/get-coworkerbookingcredits-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerBookingCredit. The following fields are **not populated** in the response: `Description`, `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one CoworkerBookingCredit](/rest-api/billing/get-coworkerbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessCurrencyCode": null,
    "TariffBookingCreditId": null,
    "TariffBookingCreditName": null,
    "ElegibleResourceTypes": [],
    "ElegibleProducts": [],
    "ElegibleTariffs": [],
    "RemainingCredit": 0,
    "TotalCredit": 0,
    "ValidFrom": null,
    "ExpireDate": null,
    "EventCategories": [],
    "CoworkerProductUniqueId": null,
    "UseCreditPrice": false,
    "CoworkerContractUniqueId": null,
    "ElegiblePasses": [],
    "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": "CoworkerBookingCredit Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcredits-by-id

GET /api/billing/coworkerbookingcredits/{id}
Retrieve a single CoworkerBookingCredit record by its Id.

A **CoworkerBookingCredit** is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer's contract on a plan that includes a `TariffBookingCredit` renews, but can also be created manually.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ValidFrom` and `ExpireDate` to control the validity window of the credit.

## Authentication

<Note>
  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 **`CoworkerBookingCredit-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerBookingCredit record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the customer this credit is assigned to.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the location issuing the credit.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Currency code of the location.
</ResponseField>

<ResponseField name="Description" type="string">
  Optional description or label for this credit.
</ResponseField>

<ResponseField name="TariffBookingCreditId" type="integer">
  ID of the plan credit template (TariffBookingCredit) that originated this credit, if any.
</ResponseField>

<ResponseField name="TariffBookingCreditName" type="string">
  Name of the plan credit template that originated this credit.
</ResponseField>

<ResponseField name="ElegibleResourceTypes" type="integer[]">
  Resource types this credit can be used for. If empty, the credit is valid for all resource types.
</ResponseField>

<ResponseField name="ElegibleProducts" type="integer[]">
  Products this credit can be used for. If empty, applies to all products.
</ResponseField>

<ResponseField name="ElegibleTariffs" type="integer[]">
  Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.
</ResponseField>

<ResponseField name="RemainingCredit" type="number">
  Remaining credit balance.
</ResponseField>

<ResponseField name="TotalCredit" type="number">
  Total credit amount originally assigned.
</ResponseField>

<ResponseField name="ValidFrom" type="string">
  Date from which this credit is valid.
</ResponseField>

<ResponseField name="ExpireDate" type="string">
  Date on which this credit expires.
</ResponseField>

<ResponseField name="CaneBeUsedForBookings" type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ResponseField>

<ResponseField name="CaneBeUsedForEvents" type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ResponseField>

<ResponseField name="EventCategories" type="integer[]">
  Event categories this credit can be used for. If empty, applies to all event categories.
</ResponseField>

<ResponseField name="IsUniversalCredit" type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  Unique ID of the product purchase that created this credit.
</ResponseField>

<ResponseField name="UseCreditPrice" type="boolean">
  Whether to use the credit price instead of the standard booking price when this credit is applied.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  Unique ID of the contract that originated this credit.
</ResponseField>

<ResponseField name="ElegiblePasses" type="integer[]">
  Time passes this credit can be used for. If empty, applies to all passes.
</ResponseField>

<ResponseField name="AppliesToCharges" type="boolean">
  Whether this universal credit applies to other charges.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "Description": null,
  "TariffBookingCreditId": null,
  "TariffBookingCreditName": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "RemainingCredit": 0,
  "TotalCredit": 0,
  "ValidFrom": null,
  "ExpireDate": null,
  "CaneBeUsedForBookings": false,
  "CaneBeUsedForEvents": false,
  "EventCategories": [],
  "IsUniversalCredit": false,
  "CoworkerProductUniqueId": null,
  "UseCreditPrice": false,
  "CoworkerContractUniqueId": null,
  "ElegiblePasses": [],
  "AppliesToCharges": false,
  "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": "CoworkerBookingCredit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerBookingCreditUseHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcreditusehistories

GET /api/billing/coworkerbookingcreditusehistories
Search and list CoworkerBookingCreditUseHistory records with filtering, sorting, and pagination.

A **CoworkerBookingCreditUseHistory** records each time a `CoworkerBookingCredit` was consumed. Each entry captures the amount of credit deducted and links back to the booking, event attendance, or invoice line that triggered the use.

Use the read-only denormalised fields (`BookingFromTime`, `BookingResourceName`, `EventAttendeeCalendarEventName`, etc.) to inspect what the credit was spent on without needing to fetch the related records separately.

## Authentication

<Note>
  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 **`CoworkerBookingCreditUseHistory-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="string">
  Filter by optional description or note for this credit use entry.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking credit that was consumed.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking this credit was applied to, if the credit was used for a booking.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking.
</ParamField>

<ParamField type="string">
  Filter by name of the resource that was booked.
</ParamField>

<ParamField type="integer">
  Filter by iD of the invoice line this credit was applied to, if the credit was used against an invoice.
</ParamField>

<ParamField type="integer">
  Filter by iD of the invoice containing the linked invoice line.
</ParamField>

<ParamField type="string">
  Filter by invoice number of the invoice containing the linked invoice line.
</ParamField>

<ParamField type="integer">
  Filter by iD of the event attendance record this credit was applied to, if the credit was used for an event.
</ParamField>

<ParamField type="string">
  Filter by name of the calendar event the credit was used for.
</ParamField>

<ParamField type="string">
  Filter by name of the event ticket product purchased by the attendee.
</ParamField>

<ParamField type="string">
  Filter by full name of the event attendee.
</ParamField>

<ParamField type="string">
  Filter by email address of the event attendee.
</ParamField>

<ParamField type="number">
  Filter by amount of credit consumed by this entry.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by start time of the booking greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by iD of the invoice containing the linked invoice line greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the invoice containing the linked invoice line less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount of credit consumed by this entry greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount of credit consumed by this entry less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?CoworkerBookingCreditUseHistory_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?' + new URLSearchParams({
      CoworkerBookingCreditUseHistory_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
      params={
          'CoworkerBookingCreditUseHistory_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?from_CoworkerBookingCreditUseHistory_UpdatedOn=2025-01-01T00:00&to_CoworkerBookingCreditUseHistory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?' + new URLSearchParams({
      from_CoworkerBookingCreditUseHistory_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerBookingCreditUseHistory_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
      params={
          'from_CoworkerBookingCreditUseHistory_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerBookingCreditUseHistory_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerBookingCreditUseHistory[]">
  The list of CoworkerBookingCreditUseHistory records matching the query. See the [Get one CoworkerBookingCreditUseHistory](/rest-api/billing/get-coworkerbookingcreditusehistories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "Description": null,
      "CoworkerBookingCreditId": 0,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerInvoiceLineId": null,
      "CoworkerInvoiceLineCoworkerInvoiceId": null,
      "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": null,
      "EventAttendeeId": null,
      "EventAttendeeCalendarEventName": null,
      "EventAttendeeEventProductName": null,
      "EventAttendeeFullName": null,
      "EventAttendeeEmail": null,
      "CreditUsed": 0,
      "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": "CoworkerBookingCreditUseHistory Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerBookingCreditUseHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcreditusehistories-batch

GET /api/billing/coworkerbookingcreditusehistories/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerBookingCreditUseHistory records by their Ids in a single request.

Fetch several CoworkerBookingCreditUseHistory records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerBookingCreditUseHistory-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerBookingCreditUseHistory Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerBookingCreditUseHistory records. Each record has the same structure as the response from the [Get one CoworkerBookingCreditUseHistory](/rest-api/billing/get-coworkerbookingcreditusehistories-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "Description": null,
    "CoworkerBookingCreditId": 0,
    "BookingId": null,
    "BookingFromTime": null,
    "BookingToTime": null,
    "BookingResourceName": null,
    "CoworkerInvoiceLineId": null,
    "CoworkerInvoiceLineCoworkerInvoiceId": null,
    "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": null,
    "EventAttendeeId": null,
    "EventAttendeeCalendarEventName": null,
    "EventAttendeeEventProductName": null,
    "EventAttendeeFullName": null,
    "EventAttendeeEmail": null,
    "CreditUsed": 0,
    "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": "CoworkerBookingCreditUseHistory Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerBookingCreditUseHistory
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerbookingcreditusehistories-by-id

GET /api/billing/coworkerbookingcreditusehistories/{id}
Retrieve a single CoworkerBookingCreditUseHistory record by its Id.

A **CoworkerBookingCreditUseHistory** records each time a `CoworkerBookingCredit` was consumed. Each entry captures the amount of credit deducted and links back to the booking, event attendance, or invoice line that triggered the use.

Use the read-only denormalised fields (`BookingFromTime`, `BookingResourceName`, `EventAttendeeCalendarEventName`, etc.) to inspect what the credit was spent on without needing to fetch the related records separately.

## Authentication

<Note>
  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 **`CoworkerBookingCreditUseHistory-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerBookingCreditUseHistory record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Description" type="string">
  Optional description or note for this credit use entry.
</ResponseField>

<ResponseField name="CoworkerBookingCreditId" type="integer">
  ID of the booking credit that was consumed.
</ResponseField>

<ResponseField name="BookingId" type="integer">
  ID of the booking this credit was applied to, if the credit was used for a booking.
</ResponseField>

<ResponseField name="BookingFromTime" type="string">
  Start time of the booking.
</ResponseField>

<ResponseField name="BookingToTime" type="string">
  End time of the booking.
</ResponseField>

<ResponseField name="BookingResourceName" type="string">
  Name of the resource that was booked.
</ResponseField>

<ResponseField name="CoworkerInvoiceLineId" type="integer">
  ID of the invoice line this credit was applied to, if the credit was used against an invoice.
</ResponseField>

<ResponseField name="CoworkerInvoiceLineCoworkerInvoiceId" type="integer">
  ID of the invoice containing the linked invoice line.
</ResponseField>

<ResponseField name="CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber" type="string">
  Invoice number of the invoice containing the linked invoice line.
</ResponseField>

<ResponseField name="EventAttendeeId" type="integer">
  ID of the event attendance record this credit was applied to, if the credit was used for an event.
</ResponseField>

<ResponseField name="EventAttendeeCalendarEventName" type="string">
  Name of the calendar event the credit was used for.
</ResponseField>

<ResponseField name="EventAttendeeEventProductName" type="string">
  Name of the event ticket product purchased by the attendee.
</ResponseField>

<ResponseField name="EventAttendeeFullName" type="string">
  Full name of the event attendee.
</ResponseField>

<ResponseField name="EventAttendeeEmail" type="string">
  Email address of the event attendee.
</ResponseField>

<ResponseField name="CreditUsed" type="number">
  Amount of credit consumed by this entry.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "Description": null,
  "CoworkerBookingCreditId": 0,
  "BookingId": null,
  "BookingFromTime": null,
  "BookingToTime": null,
  "BookingResourceName": null,
  "CoworkerInvoiceLineId": null,
  "CoworkerInvoiceLineCoworkerInvoiceId": null,
  "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": null,
  "EventAttendeeId": null,
  "EventAttendeeCalendarEventName": null,
  "EventAttendeeEventProductName": null,
  "EventAttendeeFullName": null,
  "EventAttendeeEmail": null,
  "CreditUsed": 0,
  "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": "CoworkerBookingCreditUseHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerContracts
Source: https://learn.nexudus.com/rest-api/billing/get-coworkercontracts

GET /api/billing/coworkercontracts
Search and list CoworkerContract records with filtering, sorting, and pagination.

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

<Note>
  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-List`** role.
</Note>

## Enums

<Accordion title="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                    |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the issued by linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the business issuing this contract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the coworker coworker type value for this coworker contract.
</ParamField>

<ParamField type="string">
  Filter by full name of the customer holding this contract.
</ParamField>

<ParamField type="string">
  Filter by company name of the customer holding this contract.
</ParamField>

<ParamField type="string">
  Filter by billing name of the customer holding this contract.
</ParamField>

<ParamField type="string">
  Filter by email address of the customer holding this contract.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker active is enabled.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the plan this contract is for.
</ParamField>

<ParamField type="integer">
  Filter by the tariff invoice every value for this coworker contract.
</ParamField>

<ParamField type="integer">
  Filter by the tariff invoice every weeks value for this coworker contract.
</ParamField>

<ParamField type="number">
  Filter by default price of the plan. Used when the contract has no fixed Price override.
</ParamField>

<ParamField type="string">
  Filter by currency code of the plan.
</ParamField>

<ParamField type="integer">
  Filter by iD of the next tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the next plan the contract will switch to.
</ParamField>

<ParamField type="string">
  Filter by free-text notes for this contract.
</ParamField>

<ParamField type="string">
  Filter by contract start date.
</ParamField>

<ParamField type="integer">
  Filter by day of month on which billing occurs.
</ParamField>

<ParamField type="string">
  Filter by 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.
</ParamField>

<ParamField type="string">
  Filter by 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.
</ParamField>

<ParamField type="string">
  Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.
</ParamField>

<ParamField type="number">
  Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice).
</ParamField>

<ParamField type="number">
  Filter by contract value used in reporting to compare against the actual invoiced price.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="boolean">
  Filter by whether the contract is active. Active contracts make the customer a Member; inactive contracts make them a Contact.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is the customer's main contract. The main contract drives the customer's primary plan assignment.
</ParamField>

<ParamField type="boolean">
  Filter by whether this contract has been cancelled.
</ParamField>

<ParamField type="string">
  Filter by purchase order.
</ParamField>

<ParamField type="boolean">
  Filter by whether to include the plan's signup fee when creating this contract.
</ParamField>

<ParamField type="boolean">
  Filter by whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.
</ParamField>

<ParamField type="boolean">
  Filter by whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.
</ParamField>

<ParamField type="string">
  Filter by date of the next automatic invoice generation for this contract.
</ParamField>

<ParamField type="boolean">
  Filter by whether the customer has accepted the plan's terms and conditions.
</ParamField>

<ParamField type="string">
  Filter by date on which the customer accepted the plan's terms and conditions.
</ParamField>

<ParamField type="string">
  Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days' notice required before cancellation takes effect.
</ParamField>

<ParamField type="boolean">
  Filter by whether to pro-rate the final invoice when the contract is cancelled mid-cycle.
</ParamField>

<ParamField type="boolean">
  Filter by whether to cascade cancellation to contracts of team members under this customer.
</ParamField>

<ParamField type="integer">
  Filter by reason for cancellation.
</ParamField>

<ParamField type="string">
  Filter by free-text notes about the cancellation.
</ParamField>

<ParamField type="integer">
  Filter by delivery handling preference for checks.
</ParamField>

<ParamField type="integer">
  Filter by delivery handling preference for mail.
</ParamField>

<ParamField type="integer">
  Filter by delivery handling preference for parcels.
</ParamField>

<ParamField type="integer">
  Filter by delivery handling preference for publicity.
</ParamField>

<ParamField type="string">
  Filter by free-text delivery instructions for this contract's mail handling.
</ParamField>

<ParamField type="string">
  Filter by date by which identity verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Filter by date by which address verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for renewal date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for next auto invoice local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for price plan terms accepted on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for cancellation date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for contract term local.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the proposal that originated this contract.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the proposal contract line that originated this contract.
</ParamField>

<ParamField type="string">
  Filter by iD of the course member unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoiced period local.
</ParamField>

<ParamField type="string">
  Filter by comma-separated IDs of floor-plan items assigned to this contract.
</ParamField>

<ParamField type="string">
  Filter by comma-separated names of floor-plan items assigned to this contract.
</ParamField>

<ParamField type="string">
  Filter by comma-separated IDs of floor-plan item variants assigned to this contract.
</ParamField>

<ParamField type="string">
  Filter by comma-separated names of floor-plan item variants assigned to this contract.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) and security deposits.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits.
</ParamField>

<ParamField type="string">
  Filter by pO box number.
</ParamField>

<ParamField type="boolean">
  Filter by whether the contract is currently in a paused period. Paused contracts are not invoiced.
</ParamField>

<ParamField type="string">
  Filter by start date of the current pause period.
</ParamField>

<ParamField type="string">
  Filter by end date of the current pause period. The contract resumes billing after this date.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by the tariff invoice every value for this coworker contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the tariff invoice every value for this coworker contract less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the tariff invoice every weeks value for this coworker contract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the tariff invoice every weeks value for this coworker contract less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by default price of the plan. Used when the contract has no fixed Price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by default price of the plan. Used when the contract has no fixed Price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by contract start date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by contract start date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by day of month on which billing occurs greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of month on which billing occurs less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by 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 greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by 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 less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by 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 greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by 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 less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice) greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by contract value used in reporting to compare against the actual invoiced price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by contract value used in reporting to compare against the actual invoiced price less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date of the next automatic invoice generation for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date of the next automatic invoice generation for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which the customer accepted the plan's terms and conditions greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which the customer accepted the plan's terms and conditions less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days' notice required before cancellation takes effect greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days' notice required before cancellation takes effect less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date by which identity verification checks must be completed for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which identity verification checks must be completed for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which address verification checks must be completed for this contract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which address verification checks must be completed for this contract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for renewal date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for renewal date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for next auto invoice local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for next auto invoice local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for price plan terms accepted on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for price plan terms accepted on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for cancellation date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for cancellation date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for contract term local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for contract term local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoiced period local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoiced period local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) and security deposits greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) and security deposits less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total contract price including linked products (CoworkerProducts) but excluding security deposits less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by start date of the current pause period greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the current pause period less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the current pause period. The contract resumes billing after this date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the current pause period. The contract resumes billing after this date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkercontracts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkercontracts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkercontracts?CoworkerContract_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts?' + new URLSearchParams({
      CoworkerContract_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkercontracts',
      params={
          'CoworkerContract_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkercontracts?from_CoworkerContract_UpdatedOn=2025-01-01T00:00&to_CoworkerContract_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts?' + new URLSearchParams({
      from_CoworkerContract_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerContract_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkercontracts',
      params={
          'from_CoworkerContract_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerContract_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerContract[]">
  The list of CoworkerContract records matching the query. See the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerContract. The following fields are **not populated** in the `Records[]` response: `Notes`, `PurchaseOrder`, `CancellationNotes`, `DeliveryInstructions`, `PoBoxNumber`.

  To get all fields, fetch the full record using the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "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,
      "StartDate": null,
      "BillingDay": 0,
      "RenewalDate": null,
      "InvoicedPeriod": null,
      "ContractTerm": null,
      "Price": null,
      "Value": null,
      "Desks": [],
      "Variants": [],
      "Quantity": 0,
      "Active": false,
      "MainContract": false,
      "Cancelled": false,
      "IncludeSignupFee": false,
      "InvoiceAdvancedCycles": false,
      "ApplyProRating": false,
      "NextAutoInvoice": null,
      "PricePlanTermsAccepted": false,
      "PricePlanTermsAcceptedOn": null,
      "CancellationDate": null,
      "CancellationLimitDays": null,
      "ProRateCancellation": false,
      "CancelTeamContracts": false,
      "CancellationReason": 0,
      "DeliveryHandlingPreferenceChecks": 0,
      "DeliveryHandlingPreferenceMail": 0,
      "DeliveryHandlingPreferenceParcels": 0,
      "DeliveryHandlingPreferencePublicity": 0,
      "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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerContracts
Source: https://learn.nexudus.com/rest-api/billing/get-coworkercontracts-batch

GET /api/billing/coworkercontracts/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerContract records by their Ids in a single request.

Fetch several CoworkerContract records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

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

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerContract Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkercontracts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerContract records. Each record has the same structure as the response from the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerContract. The following fields are **not populated** in the response: `Notes`, `PurchaseOrder`, `CancellationNotes`, `DeliveryInstructions`, `PoBoxNumber`.

  To get all fields, fetch the full record using the [Get one CoworkerContract](/rest-api/billing/get-coworkercontracts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "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,
    "StartDate": null,
    "BillingDay": 0,
    "RenewalDate": null,
    "InvoicedPeriod": null,
    "ContractTerm": null,
    "Price": null,
    "Value": null,
    "Desks": [],
    "Variants": [],
    "Quantity": 0,
    "Active": false,
    "MainContract": false,
    "Cancelled": false,
    "IncludeSignupFee": false,
    "InvoiceAdvancedCycles": false,
    "ApplyProRating": false,
    "NextAutoInvoice": null,
    "PricePlanTermsAccepted": false,
    "PricePlanTermsAcceptedOn": null,
    "CancellationDate": null,
    "CancellationLimitDays": null,
    "ProRateCancellation": false,
    "CancelTeamContracts": false,
    "CancellationReason": 0,
    "DeliveryHandlingPreferenceChecks": 0,
    "DeliveryHandlingPreferenceMail": 0,
    "DeliveryHandlingPreferenceParcels": 0,
    "DeliveryHandlingPreferencePublicity": 0,
    "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,
    "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
Source: https://learn.nexudus.com/rest-api/billing/get-coworkercontracts-by-id

GET /api/billing/coworkercontracts/{id}
Retrieve a single CoworkerContract record by its Id.

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

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

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerContract record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkercontracts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="IssuedById" type="integer">
  ID of the issued by linked to this record.
</ResponseField>

<ResponseField name="IssuedByName" type="string">
  Name of the business issuing this contract.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  The coworker coworker type value for this coworker contract.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the customer holding this contract.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the customer holding this contract.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the customer holding this contract.
</ResponseField>

<ResponseField name="CoworkerEmail" type="string">
  Email address of the customer holding this contract.
</ResponseField>

<ResponseField name="CoworkerActive" type="boolean">
  Whether coworker active is enabled.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Name of the plan this contract is for.
</ResponseField>

<ResponseField name="TariffInvoiceEvery" type="integer">
  The tariff invoice every value for this coworker contract.
</ResponseField>

<ResponseField name="TariffInvoiceEveryWeeks" type="integer">
  The tariff invoice every weeks value for this coworker contract.
</ResponseField>

<ResponseField name="TariffPrice" type="number">
  Default price of the plan. Used when the contract has no fixed Price override.
</ResponseField>

<ResponseField name="TariffCurrencyCode" type="string">
  Currency code of the plan.
</ResponseField>

<ResponseField name="NextTariffId" type="integer">
  ID of the next tariff linked to this record.
</ResponseField>

<ResponseField name="NextTariffName" type="string">
  Name of the next plan the contract will switch to.
</ResponseField>

<ResponseField name="Notes" type="string">
  Free-text notes for this contract.
</ResponseField>

<ResponseField name="StartDate" type="string">
  Contract start date.
</ResponseField>

<ResponseField name="BillingDay" type="integer">
  Day of month on which billing occurs.
</ResponseField>

<ResponseField name="RenewalDate" type="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.
</ResponseField>

<ResponseField name="InvoicedPeriod" type="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.
</ResponseField>

<ResponseField name="ContractTerm" type="string">
  Minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.
</ResponseField>

<ResponseField name="Price" type="number">
  Fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice).
</ResponseField>

<ResponseField name="Value" type="number">
  Contract value used in reporting to compare against the actual invoiced price.
</ResponseField>

<ResponseField name="Desks" type="integer[]">
  List of desks linked to this record.
</ResponseField>

<ResponseField name="Variants" type="integer[]">
  List of variants linked to this record.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the contract is active. Active contracts make the customer a Member; inactive contracts make them a Contact.
</ResponseField>

<ResponseField name="MainContract" type="boolean">
  Whether this is the customer's main contract. The main contract drives the customer's primary plan assignment.
</ResponseField>

<ResponseField name="Cancelled" type="boolean">
  Whether this contract has been cancelled.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order.
</ResponseField>

<ResponseField name="IncludeSignupFee" type="boolean">
  Whether to include the plan's signup fee when creating this contract.
</ResponseField>

<ResponseField name="InvoiceAdvancedCycles" type="boolean">
  Whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.
</ResponseField>

<ResponseField name="NextAutoInvoice" type="string">
  Date of the next automatic invoice generation for this contract.
</ResponseField>

<ResponseField name="PricePlanTermsAccepted" type="boolean">
  Whether the customer has accepted the plan's terms and conditions.
</ResponseField>

<ResponseField name="PricePlanTermsAcceptedOn" type="string">
  Date on which the customer accepted the plan's terms and conditions.
</ResponseField>

<ResponseField name="CancellationDate" type="string">
  Date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.
</ResponseField>

<ResponseField name="CancellationLimitDays" type="integer">
  Minimum number of days' notice required before cancellation takes effect.
</ResponseField>

<ResponseField name="ProRateCancellation" type="boolean">
  Whether to pro-rate the final invoice when the contract is cancelled mid-cycle.
</ResponseField>

<ResponseField name="CancelTeamContracts" type="boolean">
  Whether to cascade cancellation to contracts of team members under this customer.
</ResponseField>

<ResponseField name="CancellationReason" type="integer">
  Reason for cancellation.
</ResponseField>

<ResponseField name="CancellationNotes" type="string">
  Free-text notes about the cancellation.
</ResponseField>

<ResponseField name="DeliveryHandlingPreferenceChecks" type="integer">
  Delivery handling preference for checks.
</ResponseField>

<ResponseField name="DeliveryHandlingPreferenceMail" type="integer">
  Delivery handling preference for mail.
</ResponseField>

<ResponseField name="DeliveryHandlingPreferenceParcels" type="integer">
  Delivery handling preference for parcels.
</ResponseField>

<ResponseField name="DeliveryHandlingPreferencePublicity" type="integer">
  Delivery handling preference for publicity.
</ResponseField>

<ResponseField name="DeliveryInstructions" type="string">
  Free-text delivery instructions for this contract's mail handling.
</ResponseField>

<ResponseField name="IdentityChecksDueOn" type="string">
  Date by which identity verification checks must be completed for this contract.
</ResponseField>

<ResponseField name="AddressChecksDueOn" type="string">
  Date by which address verification checks must be completed for this contract.
</ResponseField>

<ResponseField name="StartDateLocal" type="string">
  Date/time value for start date local.
</ResponseField>

<ResponseField name="RenewalDateLocal" type="string">
  Date/time value for renewal date local.
</ResponseField>

<ResponseField name="NextAutoInvoiceLocal" type="string">
  Date/time value for next auto invoice local.
</ResponseField>

<ResponseField name="PricePlanTermsAcceptedOnLocal" type="string">
  Date/time value for price plan terms accepted on local.
</ResponseField>

<ResponseField name="CancellationDateLocal" type="string">
  Date/time value for cancellation date local.
</ResponseField>

<ResponseField name="ContractTermLocal" type="string">
  Date/time value for contract term local.
</ResponseField>

<ResponseField name="ProposalUniqueId" type="string">
  Unique ID of the proposal that originated this contract.
</ResponseField>

<ResponseField name="ProposalContractUniqueId" type="string">
  Unique ID of the proposal contract line that originated this contract.
</ResponseField>

<ResponseField name="CourseMemberUniqueId" type="string">
  ID of the course member unique associated with this record.
</ResponseField>

<ResponseField name="InvoicedPeriodLocal" type="string">
  Date/time value for invoiced period local.
</ResponseField>

<ResponseField name="FloorPlanDeskIds" type="string">
  Comma-separated IDs of floor-plan items assigned to this contract.
</ResponseField>

<ResponseField name="FloorPlanDeskNames" type="string">
  Comma-separated names of floor-plan items assigned to this contract.
</ResponseField>

<ResponseField name="FloorPlanDeskVariantIds" type="string">
  Comma-separated IDs of floor-plan item variants assigned to this contract.
</ResponseField>

<ResponseField name="FloorPlanDeskVariantNames" type="string">
  Comma-separated names of floor-plan item variants assigned to this contract.
</ResponseField>

<ResponseField name="PriceWithProductsAndDeposits" type="number">
  Total contract price including linked products (CoworkerProducts) and security deposits.
</ResponseField>

<ResponseField name="PriceWithProducts" type="number">
  Total contract price including linked products (CoworkerProducts) but excluding security deposits.
</ResponseField>

<ResponseField name="PoBoxNumber" type="string">
  PO box number.
</ResponseField>

<ResponseField name="InPausedPeriod" type="boolean">
  Whether the contract is currently in a paused period. Paused contracts are not invoiced.
</ResponseField>

<ResponseField name="InPausedPeriodFrom" type="string">
  Start date of the current pause period.
</ResponseField>

<ResponseField name="InPausedPeriodUntil" type="string">
  End date of the current pause period. The contract resumes billing after this date.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```


# Search CoworkerDiscountCodes
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerdiscountcodes

GET /api/billing/coworkerdiscountcodes
Search and list CoworkerDiscountCode records with filtering, sorting, and pagination.

A **CoworkerDiscountCode** assigns a `DiscountCode` to a specific customer, allowing the system to track per-customer redemption history and enforce individual validity windows.

Use `ValidFrom` and `ExpiresOn` to set customer-specific validity dates. These are distinct from the discount code's own `ValidFrom`/`ValidTo` and `ExpirationType`/`ExpiresIn` fields — the system enforces whichever constraint is more restrictive.

When the discount is part of the referral programme, `RefererGuid` identifies the referring customer. `BookingUniqueId` links the assignment to the specific booking where the code was originally applied.

## Authentication

<Note>
  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 **`CoworkerDiscountCode-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the customer this discount code is assigned to.
</ParamField>

<ParamField type="string">
  Filter by whether the customer is an individual or a company.
</ParamField>

<ParamField type="string">
  Filter by full name of the customer this discount code is assigned to.
</ParamField>

<ParamField type="string">
  Filter by billing name of the customer.
</ParamField>

<ParamField type="string">
  Filter by company name of the customer.
</ParamField>

<ParamField type="integer">
  Filter by iD of the location this assignment belongs to.
</ParamField>

<ParamField type="string">
  Filter by name of the location this assignment belongs to.
</ParamField>

<ParamField type="integer">
  Filter by iD of the discount code assigned to this customer.
</ParamField>

<ParamField type="string">
  Filter by the alphanumeric code customers enter to apply the discount.
</ParamField>

<ParamField type="boolean">
  Filter by whether the discount code is currently active and can be redeemed.
</ParamField>

<ParamField type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code).
</ParamField>

<ParamField type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code).
</ParamField>

<ParamField type="string">
  Filter by optional notes about this discount code assignment.
</ParamField>

<ParamField type="integer">
  Filter by number of times this customer has redeemed the discount code.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date after which this discount code assignment expires.
</ParamField>

<ParamField type="string">
  Filter by unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
</ParamField>

<ParamField type="string">
  Filter by unique identifier of the booking to which this discount code was applied.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of times this customer has redeemed the discount code greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of times this customer has redeemed the discount code less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date after which this discount code assignment expires greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by customer-specific date after which this discount code assignment expires less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?CoworkerDiscountCode_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?' + new URLSearchParams({
      CoworkerDiscountCode_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
      params={
          'CoworkerDiscountCode_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?from_CoworkerDiscountCode_UpdatedOn=2025-01-01T00:00&to_CoworkerDiscountCode_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes?' + new URLSearchParams({
      from_CoworkerDiscountCode_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerDiscountCode_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
      params={
          'from_CoworkerDiscountCode_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerDiscountCode_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerDiscountCode[]">
  The list of CoworkerDiscountCode records matching the query. See the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerDiscountCode. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerBillingName": null,
      "CoworkerCompanyName": null,
      "BusinessId": 0,
      "BusinessName": null,
      "DiscountCodeId": 0,
      "DiscountCodeCode": null,
      "DiscountCodeActive": null,
      "DiscountCodeValidFrom": null,
      "DiscountCodeValidTo": null,
      "TimesUsed": 0,
      "ValidFrom": null,
      "ExpiresOn": null,
      "RefererGuid": null,
      "BookingUniqueId": 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": "CoworkerDiscountCode Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerDiscountCodes
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerdiscountcodes-batch

GET /api/billing/coworkerdiscountcodes/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerDiscountCode records by their Ids in a single request.

Fetch several CoworkerDiscountCode records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerDiscountCode-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerDiscountCode Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerDiscountCode records. Each record has the same structure as the response from the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerDiscountCode. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "CoworkerCoworkerType": null,
    "CoworkerFullName": null,
    "CoworkerBillingName": null,
    "CoworkerCompanyName": null,
    "BusinessId": 0,
    "BusinessName": null,
    "DiscountCodeId": 0,
    "DiscountCodeCode": null,
    "DiscountCodeActive": null,
    "DiscountCodeValidFrom": null,
    "DiscountCodeValidTo": null,
    "TimesUsed": 0,
    "ValidFrom": null,
    "ExpiresOn": null,
    "RefererGuid": null,
    "BookingUniqueId": 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": "CoworkerDiscountCode Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerDiscountCode
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerdiscountcodes-by-id

GET /api/billing/coworkerdiscountcodes/{id}
Retrieve a single CoworkerDiscountCode record by its Id.

A **CoworkerDiscountCode** assigns a `DiscountCode` to a specific customer, allowing the system to track per-customer redemption history and enforce individual validity windows.

Use `ValidFrom` and `ExpiresOn` to set customer-specific validity dates. These are distinct from the discount code's own `ValidFrom`/`ValidTo` and `ExpirationType`/`ExpiresIn` fields — the system enforces whichever constraint is more restrictive.

When the discount is part of the referral programme, `RefererGuid` identifies the referring customer. `BookingUniqueId` links the assignment to the specific booking where the code was originally applied.

## Authentication

<Note>
  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 **`CoworkerDiscountCode-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerDiscountCode record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the customer this discount code is assigned to.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Whether the customer is an individual or a company.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the customer this discount code is assigned to.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the customer.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the customer.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the location this assignment belongs to.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Name of the location this assignment belongs to.
</ResponseField>

<ResponseField name="DiscountCodeId" type="integer">
  ID of the discount code assigned to this customer.
</ResponseField>

<ResponseField name="DiscountCodeCode" type="string">
  The alphanumeric code customers enter to apply the discount.
</ResponseField>

<ResponseField name="DiscountCodeActive" type="boolean">
  Whether the discount code is currently active and can be redeemed.
</ResponseField>

<ResponseField name="DiscountCodeValidFrom" type="string">
  Start date from which the discount code itself can be redeemed (set on the discount code).
</ResponseField>

<ResponseField name="DiscountCodeValidTo" type="string">
  End date after which the discount code itself can no longer be redeemed (set on the discount code).
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes about this discount code assignment.
</ResponseField>

<ResponseField name="TimesUsed" type="integer">
  Number of times this customer has redeemed the discount code.
</ResponseField>

<ResponseField name="ValidFrom" type="string">
  Customer-specific date from which this discount code assignment becomes valid.
</ResponseField>

<ResponseField name="ExpiresOn" type="string">
  Customer-specific date after which this discount code assignment expires.
</ResponseField>

<ResponseField name="RefererGuid" type="string">
  Unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  Unique identifier of the booking to which this discount code was applied.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerBillingName": null,
  "CoworkerCompanyName": null,
  "BusinessId": 0,
  "BusinessName": null,
  "DiscountCodeId": 0,
  "DiscountCodeCode": null,
  "DiscountCodeActive": null,
  "DiscountCodeValidFrom": null,
  "DiscountCodeValidTo": null,
  "Notes": null,
  "TimesUsed": 0,
  "ValidFrom": null,
  "ExpiresOn": null,
  "RefererGuid": null,
  "BookingUniqueId": 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": "CoworkerDiscountCode Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraservices

GET /api/billing/coworkerextraservices
Search and list CoworkerExtraService records with filtering, sorting, and pagination.

A **CoworkerExtraService** records a charge or credit assigned to a customer. It covers three use cases:

* **Booking charges** — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via `BookingId` and track the resource, time range, and price.
* **Time credit** — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the `ChargePeriod` of the linked extra service (minutes, days, uses, etc.). `TotalUses` and `RemainingUses` track the allowance.
* **Printing credit** — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has `IsPrintingCredit = true`. `TotalUses` and `RemainingUses` track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When `IsFromTariff` is `true`, the record was provisioned by a customer's contract (CoworkerContract) and is linked via `CoworkerContractUniqueId`.

## Authentication

<Note>
  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 **`CoworkerExtraService-List`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the linked extra service.
</ParamField>

<ParamField type="string">
  Filter by currency code of the linked extra service (e.g., USD, EUR).
</ParamField>

<ParamField type="boolean">
  Filter by true if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this charge or credit.
</ParamField>

<ParamField type="string">
  Filter by internal notes.
</ParamField>

<ParamField type="integer">
  Filter by remaining credit (time or printing) the customer can still use.
</ParamField>

<ParamField type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
</ParamField>

<ParamField type="boolean">
  Filter by whether this charge or credit is free (no cost to the customer).
</ParamField>

<ParamField type="number">
  Filter by price charged for this extra service.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied for last-minute bookings.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied by demand-based dynamic pricing.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for last-minute booking pricing.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for demand-based pricing.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit becomes usable.
</ParamField>

<ParamField type="string">
  Filter by date when this credit expires and can no longer be used.
</ParamField>

<ParamField type="string">
  Filter by payment due date for the charge.
</ParamField>

<ParamField type="string">
  Filter by purchase order.
</ParamField>

<ParamField type="integer">
  Filter by unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).
</ParamField>

<ParamField type="boolean">
  Filter by whether this charge has already been invoiced.
</ParamField>

<ParamField type="string">
  Filter by invoice date.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit was automatically provisioned from the customer's plan (tariff).
</ParamField>

<ParamField type="string">
  Filter by links this credit back to the time pass definition in the plan.
</ParamField>

<ParamField type="string">
  Filter by links this credit back to the customer product that provisioned it.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the booking that generated this charge.
</ParamField>

<ParamField type="boolean">
  Filter by whether this record was automatically created (e.g., from a booking or plan renewal).
</ParamField>

<ParamField type="boolean">
  Filter by invoice the customer directly instead of the team or company paying member.
</ParamField>

<ParamField type="string">
  Filter by discount code.
</ParamField>

<ParamField type="string">
  Filter by unique ID of the discount applied to this charge.
</ParamField>

<ParamField type="number">
  Filter by amount discounted from the price.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Filter by name of the resource booked (e.g., meeting room name).
</ParamField>

<ParamField type="string">
  Filter by links this credit back to the customer contract that provisioned it.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by remaining credit (time or printing) the customer can still use greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by remaining credit (time or printing) the customer can still use less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price charged for this extra service greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price charged for this extra service less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied for last-minute bookings greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied for last-minute bookings less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied by demand-based dynamic pricing greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price adjustment applied by demand-based dynamic pricing less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for last-minute booking pricing greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for last-minute booking pricing less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for demand-based pricing greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by multiplier applied for demand-based pricing less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit becomes usable greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date from which this credit becomes usable less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date when this credit expires and can no longer be used greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date when this credit expires and can no longer be used less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by payment due date for the charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by payment due date for the charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by amount discounted from the price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount discounted from the price less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking that generated this charge greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking that generated this charge less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking that generated this charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking that generated this charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking that generated this charge greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking that generated this charge less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices?CoworkerExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
      CoworkerExtraService_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraservices',
      params={
          'CoworkerExtraService_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices?from_CoworkerExtraService_UpdatedOn=2025-01-01T00:00&to_CoworkerExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
      from_CoworkerExtraService_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerExtraService_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraservices',
      params={
          'from_CoworkerExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerExtraService_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerExtraService[]">
  The list of CoworkerExtraService records matching the query. See the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerExtraService. The following fields are **not populated** in the `Records[]` response: `Notes`, `InvoiceThisCoworker`.

  To get all fields, fetch the full record using the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceCurrencyCode": null,
      "ExtraServiceIsPrintingCredit": false,
      "Description": null,
      "RemainingUses": 0,
      "TotalUses": 0,
      "Free": false,
      "Price": null,
      "LastMinutePriceAdjustment": null,
      "DynamicPriceAdjustment": null,
      "PriceFactorLastMinute": null,
      "PriceFactorDemand": null,
      "ValidFrom": null,
      "ExpireDate": null,
      "DueDate": null,
      "PurchaseOrder": null,
      "ChargePeriod": 0,
      "Invoiced": false,
      "InvoiceDate": null,
      "IsFromTariff": false,
      "TariffTimePassUniqueId": null,
      "CoworkerProductUniqueId": null,
      "BookingUniqueId": null,
      "AutomaticallyAdded": false,
      "DiscountCode": null,
      "CoworkerDiscountUniqueId": null,
      "DiscountAmount": null,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerContractUniqueId": 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": "CoworkerExtraService Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraservices-batch

GET /api/billing/coworkerextraservices/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerExtraService records by their Ids in a single request.

Fetch several CoworkerExtraService records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerExtraService-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerExtraService Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraservices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerExtraService records. Each record has the same structure as the response from the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerExtraService. The following fields are **not populated** in the response: `Notes`, `InvoiceThisCoworker`.

  To get all fields, fetch the full record using the [Get one CoworkerExtraService](/rest-api/billing/get-coworkerextraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "BusinessId": 0,
    "ExtraServiceId": 0,
    "ExtraServiceName": null,
    "ExtraServiceCurrencyCode": null,
    "ExtraServiceIsPrintingCredit": false,
    "Description": null,
    "RemainingUses": 0,
    "TotalUses": 0,
    "Free": false,
    "Price": null,
    "LastMinutePriceAdjustment": null,
    "DynamicPriceAdjustment": null,
    "PriceFactorLastMinute": null,
    "PriceFactorDemand": null,
    "ValidFrom": null,
    "ExpireDate": null,
    "DueDate": null,
    "PurchaseOrder": null,
    "ChargePeriod": 0,
    "Invoiced": false,
    "InvoiceDate": null,
    "IsFromTariff": false,
    "TariffTimePassUniqueId": null,
    "CoworkerProductUniqueId": null,
    "BookingUniqueId": null,
    "AutomaticallyAdded": false,
    "DiscountCode": null,
    "CoworkerDiscountUniqueId": null,
    "DiscountAmount": null,
    "BookingId": null,
    "BookingFromTime": null,
    "BookingToTime": null,
    "BookingResourceName": null,
    "CoworkerContractUniqueId": 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": "CoworkerExtraService Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerExtraService
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraservices-by-id

GET /api/billing/coworkerextraservices/{id}
Retrieve a single CoworkerExtraService record by its Id.

A **CoworkerExtraService** records a charge or credit assigned to a customer. It covers three use cases:

* **Booking charges** — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via `BookingId` and track the resource, time range, and price.
* **Time credit** — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the `ChargePeriod` of the linked extra service (minutes, days, uses, etc.). `TotalUses` and `RemainingUses` track the allowance.
* **Printing credit** — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has `IsPrintingCredit = true`. `TotalUses` and `RemainingUses` track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When `IsFromTariff` is `true`, the record was provisioned by a customer's contract (CoworkerContract) and is linked via `CoworkerContractUniqueId`.

## Authentication

<Note>
  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 **`CoworkerExtraService-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerExtraService record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="ExtraServiceId" type="integer">
  ID of the extra service linked to this record.
</ResponseField>

<ResponseField name="ExtraServiceName" type="string">
  Name of the linked extra service.
</ResponseField>

<ResponseField name="ExtraServiceCurrencyCode" type="string">
  Currency code of the linked extra service (e.g., USD, EUR).
</ResponseField>

<ResponseField name="ExtraServiceIsPrintingCredit" type="boolean">
  True if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this charge or credit.
</ResponseField>

<ResponseField name="Notes" type="string">
  Internal notes.
</ResponseField>

<ResponseField name="RemainingUses" type="integer">
  Remaining credit (time or printing) the customer can still use.
</ResponseField>

<ResponseField name="TotalUses" type="integer">
  Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
</ResponseField>

<ResponseField name="Free" type="boolean">
  Whether this charge or credit is free (no cost to the customer).
</ResponseField>

<ResponseField name="Price" type="number">
  Price charged for this extra service.
</ResponseField>

<ResponseField name="LastMinutePriceAdjustment" type="number">
  Price adjustment applied for last-minute bookings.
</ResponseField>

<ResponseField name="DynamicPriceAdjustment" type="number">
  Price adjustment applied by demand-based dynamic pricing.
</ResponseField>

<ResponseField name="PriceFactorLastMinute" type="number">
  Multiplier applied for last-minute booking pricing.
</ResponseField>

<ResponseField name="PriceFactorDemand" type="number">
  Multiplier applied for demand-based pricing.
</ResponseField>

<ResponseField name="ValidFrom" type="string">
  Date from which this credit becomes usable.
</ResponseField>

<ResponseField name="ExpireDate" type="string">
  Date when this credit expires and can no longer be used.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Payment due date for the charge.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order.
</ResponseField>

<ResponseField name="ChargePeriod" type="integer">
  Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths). See `eChargePeriod` enum values: `1` = Minutes, `2` = Days, `3` = Weeks, `4` = Months, `5` = Uses, `6` = FourWeekMonths.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  Whether this charge has already been invoiced.
</ResponseField>

<ResponseField name="InvoiceDate" type="string">
  Invoice date.
</ResponseField>

<ResponseField name="IsFromTariff" type="boolean">
  Whether this credit was automatically provisioned from the customer's plan (tariff).
</ResponseField>

<ResponseField name="TariffTimePassUniqueId" type="string">
  Links this credit back to the time pass definition in the plan.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  Links this credit back to the customer product that provisioned it.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  Unique ID of the booking that generated this charge.
</ResponseField>

<ResponseField name="AutomaticallyAdded" type="boolean">
  Whether this record was automatically created (e.g., from a booking or plan renewal).
</ResponseField>

<ResponseField name="InvoiceThisCoworker" type="boolean">
  Invoice the customer directly instead of the team or company paying member.
</ResponseField>

<ResponseField name="DiscountCode" type="string">
  Discount code.
</ResponseField>

<ResponseField name="CoworkerDiscountUniqueId" type="string">
  Unique ID of the discount applied to this charge.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Amount discounted from the price.
</ResponseField>

<ResponseField name="BookingId" type="integer">
  ID of the booking that generated this charge.
</ResponseField>

<ResponseField name="BookingFromTime" type="string">
  Start time of the booking that generated this charge.
</ResponseField>

<ResponseField name="BookingToTime" type="string">
  End time of the booking that generated this charge.
</ResponseField>

<ResponseField name="BookingResourceName" type="string">
  Name of the resource booked (e.g., meeting room name).
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  Links this credit back to the customer contract that provisioned it.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceCurrencyCode": null,
  "ExtraServiceIsPrintingCredit": false,
  "Description": null,
  "Notes": null,
  "RemainingUses": 0,
  "TotalUses": 0,
  "Free": false,
  "Price": null,
  "LastMinutePriceAdjustment": null,
  "DynamicPriceAdjustment": null,
  "PriceFactorLastMinute": null,
  "PriceFactorDemand": null,
  "ValidFrom": null,
  "ExpireDate": null,
  "DueDate": null,
  "PurchaseOrder": null,
  "ChargePeriod": 0,
  "Invoiced": false,
  "InvoiceDate": null,
  "IsFromTariff": false,
  "TariffTimePassUniqueId": null,
  "CoworkerProductUniqueId": null,
  "BookingUniqueId": null,
  "AutomaticallyAdded": false,
  "InvoiceThisCoworker": false,
  "DiscountCode": null,
  "CoworkerDiscountUniqueId": null,
  "DiscountAmount": null,
  "BookingId": null,
  "BookingFromTime": null,
  "BookingToTime": null,
  "BookingResourceName": null,
  "CoworkerContractUniqueId": 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": "CoworkerExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerExtraServiceUseHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraserviceusehistories

GET /api/billing/coworkerextraserviceusehistories
Search and list CoworkerExtraServiceUseHistory records with filtering, sorting, and pagination.

A **CoworkerExtraServiceUseHistory** is an audit record of how a customer's extra service credits have been consumed. Each record links a `CoworkerExtraService` allowance to the booking that spent it.

Use this entity to review extra service credit consumption across bookings — for example, to verify how many credits a customer used for a specific meeting room reservation or resource booking.

All fields are read-only; this entity is a ledger view and cannot be modified directly.

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the booking linked to this record.
</ParamField>

<ParamField type="string">
  Filter by start time of the booking that consumed the credit.
</ParamField>

<ParamField type="string">
  Filter by end time of the booking that consumed the credit.
</ParamField>

<ParamField type="string">
  Filter by name of the resource (e.g. meeting room) booked against this credit.
</ParamField>

<ParamField type="integer">
  Filter by amount of extra service credit consumed by this usage record.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by amount of extra service credit consumed by this usage record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by amount of extra service credit consumed by this usage record less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?CoworkerExtraServiceUseHistory_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?' + new URLSearchParams({
      CoworkerExtraServiceUseHistory_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
      params={
          'CoworkerExtraServiceUseHistory_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?from_CoworkerExtraServiceUseHistory_UpdatedOn=2025-01-01T00:00&to_CoworkerExtraServiceUseHistory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories?' + new URLSearchParams({
      from_CoworkerExtraServiceUseHistory_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerExtraServiceUseHistory_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
      params={
          'from_CoworkerExtraServiceUseHistory_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerExtraServiceUseHistory_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerExtraServiceUseHistory[]">
  The list of CoworkerExtraServiceUseHistory records matching the query. See the [Get one CoworkerExtraServiceUseHistory](/rest-api/billing/get-coworkerextraserviceusehistories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerExtraServiceId": 0,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CreditUsed": 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": "CoworkerExtraServiceUseHistory Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerExtraServiceUseHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraserviceusehistories-batch

GET /api/billing/coworkerextraserviceusehistories/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerExtraServiceUseHistory records by their Ids in a single request.

Fetch several CoworkerExtraServiceUseHistory records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerExtraServiceUseHistory Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerExtraServiceUseHistory records. Each record has the same structure as the response from the [Get one CoworkerExtraServiceUseHistory](/rest-api/billing/get-coworkerextraserviceusehistories-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CoworkerExtraServiceId": 0,
    "BookingId": null,
    "BookingFromTime": null,
    "BookingToTime": null,
    "BookingResourceName": null,
    "CreditUsed": 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": "CoworkerExtraServiceUseHistory Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerExtraServiceUseHistory
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerextraserviceusehistories-by-id

GET /api/billing/coworkerextraserviceusehistories/{id}
Retrieve a single CoworkerExtraServiceUseHistory record by its Id.

A **CoworkerExtraServiceUseHistory** is an audit record of how a customer's extra service credits have been consumed. Each record links a `CoworkerExtraService` allowance to the booking that spent it.

Use this entity to review extra service credit consumption across bookings — for example, to verify how many credits a customer used for a specific meeting room reservation or resource booking.

All fields are read-only; this entity is a ledger view and cannot be modified directly.

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerExtraServiceUseHistory record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerExtraServiceId" type="integer">
  ID of the coworker extra service linked to this record.
</ResponseField>

<ResponseField name="BookingId" type="integer">
  ID of the booking linked to this record.
</ResponseField>

<ResponseField name="BookingFromTime" type="string">
  Start time of the booking that consumed the credit.
</ResponseField>

<ResponseField name="BookingToTime" type="string">
  End time of the booking that consumed the credit.
</ResponseField>

<ResponseField name="BookingResourceName" type="string">
  Name of the resource (e.g. meeting room) booked against this credit.
</ResponseField>

<ResponseField name="CreditUsed" type="integer">
  Amount of extra service credit consumed by this usage record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerExtraServiceId": 0,
  "BookingId": null,
  "BookingFromTime": null,
  "BookingToTime": null,
  "BookingResourceName": null,
  "CreditUsed": 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": "CoworkerExtraServiceUseHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerInvoiceHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicehistories

GET /api/billing/coworkerinvoicehistories
Search and list CoworkerInvoiceHistory records with filtering, sorting, and pagination.

A **CoworkerInvoiceHistory** records a history entry for a customer invoice. Each entry captures an activity or event that occurred on that invoice, such as the invoice being sent, an e-invoicing action, a payment receipt, or a payment error.

Use `IsProblem` to flag entries that represent errors or issues (e.g. a failed payment attempt). Set `Notify` to trigger a notification when the history entry is created.

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker invoice linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice coworker associated with this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice business associated with this record.
</ParamField>

<ParamField type="string">
  Filter by the coworker invoice business currency code value for this coworker invoice history.
</ParamField>

<ParamField type="string">
  Filter by full name of the customer who owns the invoice.
</ParamField>

<ParamField type="string">
  Filter by total amount of the related customer invoice.
</ParamField>

<ParamField type="string">
  Filter by invoice number of the related customer invoice.
</ParamField>

<ParamField type="string">
  Filter by display name of the linked coworker invoice bill to (read-only).
</ParamField>

<ParamField type="string">
  Filter by whether the related customer invoice has been fully paid.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker invoice refunded is enabled.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice refunded on.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date.
</ParamField>

<ParamField type="string">
  Filter by whether the related customer invoice is still in draft.
</ParamField>

<ParamField type="string">
  Filter by short title of the history entry (e.g. 'Invoice sent', 'Payment received').
</ParamField>

<ParamField type="string">
  Filter by detailed description of the activity or event recorded by this history entry.
</ParamField>

<ParamField type="boolean">
  Filter by flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).
</ParamField>

<ParamField type="boolean">
  Filter by whether to send a notification when this history entry is created.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by iD of the coworker invoice coworker associated with this record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice coworker associated with this record less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice business associated with this record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice business associated with this record less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice refunded on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice refunded on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?CoworkerInvoiceHistory_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
      CoworkerInvoiceHistory_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
      params={
          'CoworkerInvoiceHistory_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?from_CoworkerInvoiceHistory_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoiceHistory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
      from_CoworkerInvoiceHistory_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerInvoiceHistory_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
      params={
          'from_CoworkerInvoiceHistory_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerInvoiceHistory_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerInvoiceHistory[]">
  The list of CoworkerInvoiceHistory records matching the query. See the [Get one CoworkerInvoiceHistory](/rest-api/billing/get-coworkerinvoicehistories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerInvoiceId": 0,
      "CoworkerInvoiceCoworkerId": null,
      "CoworkerInvoiceBusinessId": null,
      "CoworkerInvoiceBusinessCurrencyCode": null,
      "CoworkerInvoiceCoworkerFullName": null,
      "CoworkerInvoiceTotalAmount": null,
      "CoworkerInvoiceInvoiceNumber": null,
      "CoworkerInvoiceBillToName": null,
      "CoworkerInvoicePaid": null,
      "CoworkerInvoicePaidOn": null,
      "CoworkerInvoiceRefunded": null,
      "CoworkerInvoiceRefundedOn": null,
      "CoworkerInvoiceDueDate": null,
      "CoworkerInvoiceDraft": null,
      "Name": "",
      "Description": "",
      "IsProblem": false,
      "Notify": false,
      "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": "CoworkerInvoiceHistory Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerInvoiceHistories
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicehistories-batch

GET /api/billing/coworkerinvoicehistories/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerInvoiceHistory records by their Ids in a single request.

Fetch several CoworkerInvoiceHistory records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerInvoiceHistory Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerInvoiceHistory records. Each record has the same structure as the response from the [Get one CoworkerInvoiceHistory](/rest-api/billing/get-coworkerinvoicehistories-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CoworkerInvoiceId": 0,
    "CoworkerInvoiceCoworkerId": null,
    "CoworkerInvoiceBusinessId": null,
    "CoworkerInvoiceBusinessCurrencyCode": null,
    "CoworkerInvoiceCoworkerFullName": null,
    "CoworkerInvoiceTotalAmount": null,
    "CoworkerInvoiceInvoiceNumber": null,
    "CoworkerInvoiceBillToName": null,
    "CoworkerInvoicePaid": null,
    "CoworkerInvoicePaidOn": null,
    "CoworkerInvoiceRefunded": null,
    "CoworkerInvoiceRefundedOn": null,
    "CoworkerInvoiceDueDate": null,
    "CoworkerInvoiceDraft": null,
    "Name": "",
    "Description": "",
    "IsProblem": false,
    "Notify": false,
    "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": "CoworkerInvoiceHistory Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerInvoiceHistory
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicehistories-by-id

GET /api/billing/coworkerinvoicehistories/{id}
Retrieve a single CoworkerInvoiceHistory record by its Id.

A **CoworkerInvoiceHistory** records a history entry for a customer invoice. Each entry captures an activity or event that occurred on that invoice, such as the invoice being sent, an e-invoicing action, a payment receipt, or a payment error.

Use `IsProblem` to flag entries that represent errors or issues (e.g. a failed payment attempt). Set `Notify` to trigger a notification when the history entry is created.

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoiceHistory record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerInvoiceId" type="integer">
  ID of the coworker invoice linked to this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceCoworkerId" type="integer">
  ID of the coworker invoice coworker associated with this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceBusinessId" type="integer">
  ID of the coworker invoice business associated with this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceBusinessCurrencyCode" type="string">
  The coworker invoice business currency code value for this coworker invoice history.
</ResponseField>

<ResponseField name="CoworkerInvoiceCoworkerFullName" type="string">
  Full name of the customer who owns the invoice.
</ResponseField>

<ResponseField name="CoworkerInvoiceTotalAmount" type="string">
  Total amount of the related customer invoice.
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Invoice number of the related customer invoice.
</ResponseField>

<ResponseField name="CoworkerInvoiceBillToName" type="string">
  Display name of the linked coworker invoice bill to (read-only).
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="string">
  Whether the related customer invoice has been fully paid.
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Date/time value for coworker invoice paid on.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefunded" type="boolean">
  Whether coworker invoice refunded is enabled.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefundedOn" type="string">
  Date/time value for coworker invoice refunded on.
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Date/time value for coworker invoice due date.
</ResponseField>

<ResponseField name="CoworkerInvoiceDraft" type="string">
  Whether the related customer invoice is still in draft.
</ResponseField>

<ResponseField name="Name" type="string">
  Short title of the history entry (e.g. 'Invoice sent', 'Payment received').
</ResponseField>

<ResponseField name="Description" type="string">
  Detailed description of the activity or event recorded by this history entry.
</ResponseField>

<ResponseField name="IsProblem" type="boolean">
  Flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).
</ResponseField>

<ResponseField name="Notify" type="boolean">
  Whether to send a notification when this history entry is created.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerInvoiceId": 0,
  "CoworkerInvoiceCoworkerId": null,
  "CoworkerInvoiceBusinessId": null,
  "CoworkerInvoiceBusinessCurrencyCode": null,
  "CoworkerInvoiceCoworkerFullName": null,
  "CoworkerInvoiceTotalAmount": null,
  "CoworkerInvoiceInvoiceNumber": null,
  "CoworkerInvoiceBillToName": null,
  "CoworkerInvoicePaid": null,
  "CoworkerInvoicePaidOn": null,
  "CoworkerInvoiceRefunded": null,
  "CoworkerInvoiceRefundedOn": null,
  "CoworkerInvoiceDueDate": null,
  "CoworkerInvoiceDraft": null,
  "Name": "",
  "Description": "",
  "IsProblem": false,
  "Notify": false,
  "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": "CoworkerInvoiceHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerInvoiceLines
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicelines

GET /api/billing/coworkerinvoicelines
Search and list CoworkerInvoiceLine records with filtering, sorting, and pagination.

A **CoworkerInvoiceLine** represents an individual line item on a customer invoice. Each line captures the description, quantity, amounts, tax, and an optional link to the sale item that generated it.

Properties ending in `UniqueId` link the line to the originating sale record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per line:

| UniqueId property              | Source entity        |
| ------------------------------ | -------------------- |
| `CoworkerContractUniqueId`     | CoworkerContract     |
| `ContractDepositUniqueId`      | ContractDeposit      |
| `BookingUniqueId`              | Booking              |
| `CoworkerExtraServiceUniqueId` | CoworkerExtraService |
| `CoworkerTimePassUniqueId`     | CoworkerTimePass     |
| `CoworkerChargeUniqueId`       | Charge               |
| `CoworkerProductUniqueId`      | CoworkerProduct      |
| `EventAttendeeUniqueId`        | EventAttendee        |

## Authentication

<Note>
  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 **`CoworkerInvoiceLine-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker invoice linked to this record.
</ParamField>

<ParamField type="string">
  Filter by invoice number of the parent invoice.
</ParamField>

<ParamField type="string">
  Filter by whether the parent invoice has been fully paid.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on.
</ParamField>

<ParamField type="string">
  Filter by whether the parent invoice is a credit note.
</ParamField>

<ParamField type="string">
  Filter by currency code of the parent invoice (e.g. USD, EUR).
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date.
</ParamField>

<ParamField type="string">
  Filter by line item description shown internally.
</ParamField>

<ParamField type="string">
  Filter by override text displayed on the printed/emailed invoice instead of the description.
</ParamField>

<ParamField type="string">
  Filter by name of the tax category applied to this line.
</ParamField>

<ParamField type="integer">
  Filter by number of units for this line item.
</ParamField>

<ParamField type="number">
  Filter by line subtotal before tax (unit price x quantity).
</ParamField>

<ParamField type="number">
  Filter by tax amount calculated for this line.
</ParamField>

<ParamField type="number">
  Filter by tax rate percentage applied to this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the CoworkerContract that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the ContractDeposit that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the Booking that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the CoworkerExtraService that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the base ExtraService linked to this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the CoworkerTimePass that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the Charge that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the CoworkerProduct that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) of the EventAttendee that generated this line.
</ParamField>

<ParamField type="string">
  Filter by uniqueId (GUID) linking this line to a group of related invoice lines.
</ParamField>

<ParamField type="number">
  Filter by amount that has been refunded for this line.
</ParamField>

<ParamField type="boolean">
  Filter by whether this line has been fully or partially refunded.
</ParamField>

<ParamField type="string">
  Filter by date and time when this line was refunded.
</ParamField>

<ParamField type="string">
  Filter by date the sale occurred for this line item.
</ParamField>

<ParamField type="string">
  Filter by discount code applied to this line.
</ParamField>

<ParamField type="number">
  Filter by discount amount deducted from this line.
</ParamField>

<ParamField type="string">
  Filter by name of the linked CoworkerExtraService.
</ParamField>

<ParamField type="string">
  Filter by name of the linked CoworkerTimePass.
</ParamField>

<ParamField type="string">
  Filter by name of the linked CoworkerProduct.
</ParamField>

<ParamField type="string">
  Filter by display name of the linked event attendee product (read-only).
</ParamField>

<ParamField type="string">
  Filter by name of the plan (tariff) associated with this line.
</ParamField>

<ParamField type="string">
  Filter by code of the financial account (revenue category) for this line.
</ParamField>

<ParamField type="string">
  Filter by name of the financial account (revenue category) for this line.
</ParamField>

<ParamField type="string">
  Filter by iD of the issued by unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by iD of the cancelled coworker invoice line unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sale date local.
</ParamField>

<ParamField type="integer">
  Filter by display order of this line on the invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether this line is hidden from the customer-facing invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether this line represents a universal credit applied to the invoice.
</ParamField>

<ParamField type="string">
  Filter by purchase order reference for this line.
</ParamField>

<ParamField type="number">
  Filter by credit amount applied to this line.
</ParamField>

<ParamField type="boolean">
  Filter by whether this line is a prorated charge from a mid-cycle contract change.
</ParamField>

<ParamField type="string">
  Filter by iD of the coworker discount code unique associated with this record.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice paid on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for coworker invoice due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of units for this line item greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units for this line item less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by line subtotal before tax (unit price x quantity) greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by line subtotal before tax (unit price x quantity) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax amount calculated for this line greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax amount calculated for this line less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax rate percentage applied to this line greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tax rate percentage applied to this line less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount that has been refunded for this line greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount that has been refunded for this line less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date and time when this line was refunded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when this line was refunded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the sale occurred for this line item greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the sale occurred for this line item less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by discount amount deducted from this line greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount deducted from this line less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sale date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sale date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by display order of this line on the invoice greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order of this line on the invoice less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount applied to this line greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount applied to this line less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines?page=1&size=15&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Description',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Description

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines?CoworkerInvoiceLine_Description=example-value&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines?' + new URLSearchParams({
      CoworkerInvoiceLine_Description: 'example-value',
      orderBy: 'Description',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
      params={
          'CoworkerInvoiceLine_Description': 'example-value',
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines?from_CoworkerInvoiceLine_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoiceLine_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines?' + new URLSearchParams({
      from_CoworkerInvoiceLine_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerInvoiceLine_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
      params={
          'from_CoworkerInvoiceLine_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerInvoiceLine_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerInvoiceLine[]">
  The list of CoworkerInvoiceLine records matching the query. See the [Get one CoworkerInvoiceLine](/rest-api/billing/get-coworkerinvoicelines-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerInvoiceLine. The following fields are **not populated** in the `Records[]` response: `TaxAmount`, `TaxRate`, `PurchaseOrder`, `CreditAmount`.

  To get all fields, fetch the full record using the [Get one CoworkerInvoiceLine](/rest-api/billing/get-coworkerinvoicelines-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerInvoiceId": 0,
      "CoworkerInvoiceInvoiceNumber": null,
      "CoworkerInvoicePaid": null,
      "CoworkerInvoicePaidOn": null,
      "CoworkerInvoiceCreditNote": null,
      "CoworkerInvoiceCurrencyCode": null,
      "CoworkerInvoiceDueDate": null,
      "Description": "",
      "DisplayAs": null,
      "TaxCategoryName": null,
      "Quantity": 0,
      "SubTotal": 0,
      "CoworkerContractUniqueId": null,
      "ContractDepositUniqueId": null,
      "BookingUniqueId": null,
      "CoworkerExtraServiceUniqueId": null,
      "ExtraServiceUniqueId": null,
      "CoworkerTimePassUniqueId": null,
      "CoworkerChargeUniqueId": null,
      "CoworkerProductUniqueId": null,
      "EventAttendeeUniqueId": null,
      "GroupedLineUniqueId": null,
      "RefundedAmount": null,
      "Refunded": false,
      "RefundedOn": null,
      "SaleDate": null,
      "DiscountCode": null,
      "DiscountAmount": null,
      "CoworkerExtraServiceName": null,
      "CoworkerTimePassName": null,
      "CoworkerProductName": null,
      "EventAttendeeProductName": null,
      "TariffName": null,
      "FinancialAccountCode": null,
      "FinancialAccountName": null,
      "IssuedByUniqueId": null,
      "CancelledCoworkerInvoiceLineUniqueId": null,
      "CreatedOnLocal": null,
      "RefundedOnLocal": null,
      "SaleDateLocal": null,
      "Position": 0,
      "IsHidden": false,
      "IsUniversalCredit": false,
      "IsProratedContract": false,
      "CoworkerDiscountCodeUniqueId": 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": "CoworkerInvoiceLine Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerInvoiceLines
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicelines-batch

GET /api/billing/coworkerinvoicelines/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerInvoiceLine records by their Ids in a single request.

Fetch several CoworkerInvoiceLine records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerInvoiceLine-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerInvoiceLine Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerInvoiceLine records. Each record has the same structure as the response from the [Get one CoworkerInvoiceLine](/rest-api/billing/get-coworkerinvoicelines-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerInvoiceLine. The following fields are **not populated** in the response: `TaxAmount`, `TaxRate`, `PurchaseOrder`, `CreditAmount`.

  To get all fields, fetch the full record using the [Get one CoworkerInvoiceLine](/rest-api/billing/get-coworkerinvoicelines-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerInvoiceId": 0,
    "CoworkerInvoiceInvoiceNumber": null,
    "CoworkerInvoicePaid": null,
    "CoworkerInvoicePaidOn": null,
    "CoworkerInvoiceCreditNote": null,
    "CoworkerInvoiceCurrencyCode": null,
    "CoworkerInvoiceDueDate": null,
    "Description": "",
    "DisplayAs": null,
    "TaxCategoryName": null,
    "Quantity": 0,
    "SubTotal": 0,
    "CoworkerContractUniqueId": null,
    "ContractDepositUniqueId": null,
    "BookingUniqueId": null,
    "CoworkerExtraServiceUniqueId": null,
    "ExtraServiceUniqueId": null,
    "CoworkerTimePassUniqueId": null,
    "CoworkerChargeUniqueId": null,
    "CoworkerProductUniqueId": null,
    "EventAttendeeUniqueId": null,
    "GroupedLineUniqueId": null,
    "RefundedAmount": null,
    "Refunded": false,
    "RefundedOn": null,
    "SaleDate": null,
    "DiscountCode": null,
    "DiscountAmount": null,
    "CoworkerExtraServiceName": null,
    "CoworkerTimePassName": null,
    "CoworkerProductName": null,
    "EventAttendeeProductName": null,
    "TariffName": null,
    "FinancialAccountCode": null,
    "FinancialAccountName": null,
    "IssuedByUniqueId": null,
    "CancelledCoworkerInvoiceLineUniqueId": null,
    "CreatedOnLocal": null,
    "RefundedOnLocal": null,
    "SaleDateLocal": null,
    "Position": 0,
    "IsHidden": false,
    "IsUniversalCredit": false,
    "IsProratedContract": false,
    "CoworkerDiscountCodeUniqueId": 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": "CoworkerInvoiceLine Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerInvoiceLine
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicelines-by-id

GET /api/billing/coworkerinvoicelines/{id}
Retrieve a single CoworkerInvoiceLine record by its Id.

A **CoworkerInvoiceLine** represents an individual line item on a customer invoice. Each line captures the description, quantity, amounts, tax, and an optional link to the sale item that generated it.

Properties ending in `UniqueId` link the line to the originating sale record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per line:

| UniqueId property              | Source entity        |
| ------------------------------ | -------------------- |
| `CoworkerContractUniqueId`     | CoworkerContract     |
| `ContractDepositUniqueId`      | ContractDeposit      |
| `BookingUniqueId`              | Booking              |
| `CoworkerExtraServiceUniqueId` | CoworkerExtraService |
| `CoworkerTimePassUniqueId`     | CoworkerTimePass     |
| `CoworkerChargeUniqueId`       | Charge               |
| `CoworkerProductUniqueId`      | CoworkerProduct      |
| `EventAttendeeUniqueId`        | EventAttendee        |

## Authentication

<Note>
  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 **`CoworkerInvoiceLine-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoiceLine record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerInvoiceId" type="integer">
  ID of the coworker invoice linked to this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Invoice number of the parent invoice.
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="string">
  Whether the parent invoice has been fully paid.
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Date/time value for coworker invoice paid on.
</ResponseField>

<ResponseField name="CoworkerInvoiceCreditNote" type="string">
  Whether the parent invoice is a credit note.
</ResponseField>

<ResponseField name="CoworkerInvoiceCurrencyCode" type="string">
  Currency code of the parent invoice (e.g. USD, EUR).
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Date/time value for coworker invoice due date.
</ResponseField>

<ResponseField name="Description" type="string">
  Line item description shown internally.
</ResponseField>

<ResponseField name="DisplayAs" type="string">
  Override text displayed on the printed/emailed invoice instead of the description.
</ResponseField>

<ResponseField name="TaxCategoryName" type="string">
  Name of the tax category applied to this line.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units for this line item.
</ResponseField>

<ResponseField name="SubTotal" type="number">
  Line subtotal before tax (unit price x quantity).
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Tax amount calculated for this line.
</ResponseField>

<ResponseField name="TaxRate" type="number">
  Tax rate percentage applied to this line.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  UniqueId (GUID) of the CoworkerContract that generated this line.
</ResponseField>

<ResponseField name="ContractDepositUniqueId" type="string">
  UniqueId (GUID) of the ContractDeposit that generated this line.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  UniqueId (GUID) of the Booking that generated this line.
</ResponseField>

<ResponseField name="CoworkerExtraServiceUniqueId" type="string">
  UniqueId (GUID) of the CoworkerExtraService that generated this line.
</ResponseField>

<ResponseField name="ExtraServiceUniqueId" type="string">
  UniqueId (GUID) of the base ExtraService linked to this line.
</ResponseField>

<ResponseField name="CoworkerTimePassUniqueId" type="string">
  UniqueId (GUID) of the CoworkerTimePass that generated this line.
</ResponseField>

<ResponseField name="CoworkerChargeUniqueId" type="string">
  UniqueId (GUID) of the Charge that generated this line.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  UniqueId (GUID) of the CoworkerProduct that generated this line.
</ResponseField>

<ResponseField name="EventAttendeeUniqueId" type="string">
  UniqueId (GUID) of the EventAttendee that generated this line.
</ResponseField>

<ResponseField name="GroupedLineUniqueId" type="string">
  UniqueId (GUID) linking this line to a group of related invoice lines.
</ResponseField>

<ResponseField name="RefundedAmount" type="number">
  Amount that has been refunded for this line.
</ResponseField>

<ResponseField name="Refunded" type="boolean">
  Whether this line has been fully or partially refunded.
</ResponseField>

<ResponseField name="RefundedOn" type="string">
  Date and time when this line was refunded.
</ResponseField>

<ResponseField name="SaleDate" type="string">
  Date the sale occurred for this line item.
</ResponseField>

<ResponseField name="DiscountCode" type="string">
  Discount code applied to this line.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount deducted from this line.
</ResponseField>

<ResponseField name="CoworkerExtraServiceName" type="string">
  Name of the linked CoworkerExtraService.
</ResponseField>

<ResponseField name="CoworkerTimePassName" type="string">
  Name of the linked CoworkerTimePass.
</ResponseField>

<ResponseField name="CoworkerProductName" type="string">
  Name of the linked CoworkerProduct.
</ResponseField>

<ResponseField name="EventAttendeeProductName" type="string">
  Display name of the linked event attendee product (read-only).
</ResponseField>

<ResponseField name="TariffName" type="string">
  Name of the plan (tariff) associated with this line.
</ResponseField>

<ResponseField name="FinancialAccountCode" type="string">
  Code of the financial account (revenue category) for this line.
</ResponseField>

<ResponseField name="FinancialAccountName" type="string">
  Name of the financial account (revenue category) for this line.
</ResponseField>

<ResponseField name="IssuedByUniqueId" type="string">
  ID of the issued by unique associated with this record.
</ResponseField>

<ResponseField name="CancelledCoworkerInvoiceLineUniqueId" type="string">
  ID of the cancelled coworker invoice line unique associated with this record.
</ResponseField>

<ResponseField name="CreatedOnLocal" type="string">
  Date/time value for created on local.
</ResponseField>

<ResponseField name="RefundedOnLocal" type="string">
  Date/time value for refunded on local.
</ResponseField>

<ResponseField name="SaleDateLocal" type="string">
  Date/time value for sale date local.
</ResponseField>

<ResponseField name="Position" type="integer">
  Display order of this line on the invoice.
</ResponseField>

<ResponseField name="IsHidden" type="boolean">
  Whether this line is hidden from the customer-facing invoice.
</ResponseField>

<ResponseField name="IsUniversalCredit" type="boolean">
  Whether this line represents a universal credit applied to the invoice.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order reference for this line.
</ResponseField>

<ResponseField name="CreditAmount" type="number">
  Credit amount applied to this line.
</ResponseField>

<ResponseField name="IsProratedContract" type="boolean">
  Whether this line is a prorated charge from a mid-cycle contract change.
</ResponseField>

<ResponseField name="CoworkerDiscountCodeUniqueId" type="string">
  ID of the coworker discount code unique associated with this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerInvoiceId": 0,
  "CoworkerInvoiceInvoiceNumber": null,
  "CoworkerInvoicePaid": null,
  "CoworkerInvoicePaidOn": null,
  "CoworkerInvoiceCreditNote": null,
  "CoworkerInvoiceCurrencyCode": null,
  "CoworkerInvoiceDueDate": null,
  "Description": "",
  "DisplayAs": null,
  "TaxCategoryName": null,
  "Quantity": 0,
  "SubTotal": 0,
  "TaxAmount": 0,
  "TaxRate": 0,
  "CoworkerContractUniqueId": null,
  "ContractDepositUniqueId": null,
  "BookingUniqueId": null,
  "CoworkerExtraServiceUniqueId": null,
  "ExtraServiceUniqueId": null,
  "CoworkerTimePassUniqueId": null,
  "CoworkerChargeUniqueId": null,
  "CoworkerProductUniqueId": null,
  "EventAttendeeUniqueId": null,
  "GroupedLineUniqueId": null,
  "RefundedAmount": null,
  "Refunded": false,
  "RefundedOn": null,
  "SaleDate": null,
  "DiscountCode": null,
  "DiscountAmount": null,
  "CoworkerExtraServiceName": null,
  "CoworkerTimePassName": null,
  "CoworkerProductName": null,
  "EventAttendeeProductName": null,
  "TariffName": null,
  "FinancialAccountCode": null,
  "FinancialAccountName": null,
  "IssuedByUniqueId": null,
  "CancelledCoworkerInvoiceLineUniqueId": null,
  "CreatedOnLocal": null,
  "RefundedOnLocal": null,
  "SaleDateLocal": null,
  "Position": 0,
  "IsHidden": false,
  "IsUniversalCredit": false,
  "PurchaseOrder": null,
  "CreditAmount": 0,
  "IsProratedContract": false,
  "CoworkerDiscountCodeUniqueId": 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": "CoworkerInvoiceLine Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerInvoicePaymentTokens
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicepaymenttokens

GET /api/billing/coworkerinvoicepaymenttokens
Search and list CoworkerInvoicePaymentToken records with filtering, sorting, and pagination.

A **CoworkerInvoicePaymentToken** is an internal record of the token used to process the payment for a customer invoice.

Each token links a `CoworkerInvoice` to the payment provider and the provider-specific token string used to authorise or capture the payment. Use the `Notes` field to store any additional context about the token.

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-List`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker invoice linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by payment provider used to process the invoice.
</ParamField>

<ParamField type="string">
  Filter by provider-specific token used to authorise or capture the payment.
</ParamField>

<ParamField type="string">
  Filter by additional notes about the payment token.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?CoworkerInvoicePaymentToken_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?' + new URLSearchParams({
      CoworkerInvoicePaymentToken_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
      params={
          'CoworkerInvoicePaymentToken_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?from_CoworkerInvoicePaymentToken_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoicePaymentToken_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens?' + new URLSearchParams({
      from_CoworkerInvoicePaymentToken_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerInvoicePaymentToken_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
      params={
          'from_CoworkerInvoicePaymentToken_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerInvoicePaymentToken_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerInvoicePaymentToken[]">
  The list of CoworkerInvoicePaymentToken records matching the query. See the [Get one CoworkerInvoicePaymentToken](/rest-api/billing/get-coworkerinvoicepaymenttokens-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerInvoicePaymentToken. The following fields are **not populated** in the `Records[]` response: `RegularPaymentProvider`.

  To get all fields, fetch the full record using the [Get one CoworkerInvoicePaymentToken](/rest-api/billing/get-coworkerinvoicepaymenttokens-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerInvoiceId": 0,
      "Token": null,
      "Notes": 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": "CoworkerInvoicePaymentToken Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerInvoicePaymentTokens
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicepaymenttokens-batch

GET /api/billing/coworkerinvoicepaymenttokens/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerInvoicePaymentToken records by their Ids in a single request.

Fetch several CoworkerInvoicePaymentToken records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerInvoicePaymentToken Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerInvoicePaymentToken records. Each record has the same structure as the response from the [Get one CoworkerInvoicePaymentToken](/rest-api/billing/get-coworkerinvoicepaymenttokens-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerInvoicePaymentToken. The following fields are **not populated** in the response: `RegularPaymentProvider`.

  To get all fields, fetch the full record using the [Get one CoworkerInvoicePaymentToken](/rest-api/billing/get-coworkerinvoicepaymenttokens-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerInvoiceId": 0,
    "Token": null,
    "Notes": 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": "CoworkerInvoicePaymentToken Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerInvoicePaymentToken
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoicepaymenttokens-by-id

GET /api/billing/coworkerinvoicepaymenttokens/{id}
Retrieve a single CoworkerInvoicePaymentToken record by its Id.

A **CoworkerInvoicePaymentToken** is an internal record of the token used to process the payment for a customer invoice.

Each token links a `CoworkerInvoice` to the payment provider and the provider-specific token string used to authorise or capture the payment. Use the `Notes` field to store any additional context about the token.

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoicePaymentToken record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerInvoiceId" type="integer">
  ID of the coworker invoice linked to this record.
</ResponseField>

<ResponseField name="RegularPaymentProvider" type="integer">
  Payment provider used to process the invoice.
</ResponseField>

<ResponseField name="Token" type="string">
  Provider-specific token used to authorise or capture the payment.
</ResponseField>

<ResponseField name="Notes" type="string">
  Additional notes about the payment token.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerInvoiceId": 0,
  "RegularPaymentProvider": 0,
  "Token": null,
  "Notes": 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": "CoworkerInvoicePaymentToken Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerInvoices
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoices

GET /api/billing/coworkerinvoices
Search and list CoworkerInvoice records with filtering, sorting, and pagination.

A **CoworkerInvoice** represents an invoice document issued to a customer. Invoices track amounts owed, payment status, billing details, and integration state with external accounting systems.

Invoices can be in draft or final state. A draft invoice (\`\`Draft` true`) can still be modified before being finalised. Once finalised, an invoice number is assigned and the invoice can be sent to the customer.

An invoice may also be a **credit note** (``CreditNote` true`), which references the original invoice via ``OriginalInvoiceGuid\`\` and represents a reversal or adjustment.

Payment status is tracked via `Paid`, `PaidAmount`, and `PaidOn`. Partial payments are possible — compare `PaidAmount` against `TotalAmount` to determine outstanding balance. Refunds are tracked separately via `Refunded`, `RefundedOn`, and `RefundedAmount`.

## Authentication

<Note>
  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 **`CoworkerInvoice-List`** role.
</Note>

## Enums

<Accordion title="eStorecoveInvoiceStatus — StorecoveInvoiceStatus values">
  | Value | Name             |
  | ----- | ---------------- |
  | 1     | None             |
  | 2     | TransferFailed   |
  | 3     | Processing       |
  | 4     | ProcessingFailed |
  | 5     | Processed        |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the invoiced customer.
</ParamField>

<ParamField type="string">
  Filter by the coworker regular payment contract number value for this coworker invoice.
</ParamField>

<ParamField type="string">
  Filter by the coworker regular payment provider value for this coworker invoice.
</ParamField>

<ParamField type="string">
  Filter by the coworker card number value for this coworker invoice.
</ParamField>

<ParamField type="string">
  Filter by the coworker go cardless contract number value for this coworker invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker enable go cardless payments is enabled.
</ParamField>

<ParamField type="string">
  Filter by billing email address of the customer.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker notify on new invoice is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker notify on new payment is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker notify on failed payment is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker do not process invoices automatically is enabled.
</ParamField>

<ParamField type="string">
  Filter by company name of the invoiced customer.
</ParamField>

<ParamField type="string">
  Filter by team names the invoiced customer belongs to.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the location that issued the invoice.
</ParamField>

<ParamField type="string">
  Filter by unique invoice number assigned when the invoice is finalised.
</ParamField>

<ParamField type="string">
  Filter by reference code used to match payments to this invoice.
</ParamField>

<ParamField type="string">
  Filter by name of the person or company being billed.
</ParamField>

<ParamField type="string">
  Filter by billing address on the invoice.
</ParamField>

<ParamField type="string">
  Filter by billing city on the invoice.
</ParamField>

<ParamField type="string">
  Filter by billing post code on the invoice.
</ParamField>

<ParamField type="string">
  Filter by billing phone number on the invoice.
</ParamField>

<ParamField type="string">
  Filter by billing fax number on the invoice.
</ParamField>

<ParamField type="string">
  Filter by billing state or region on the invoice.
</ParamField>

<ParamField type="integer">
  Filter by iD of the bill to country linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the billing country on the invoice.
</ParamField>

<ParamField type="string">
  Filter by the bill to country two digits code value for this coworker invoice.
</ParamField>

<ParamField type="string">
  Filter by bank account number on the invoice for payment.
</ParamField>

<ParamField type="string">
  Filter by tax identification number of the billed party.
</ParamField>

<ParamField type="string">
  Filter by customer purchase order number for this invoice.
</ParamField>

<ParamField type="string">
  Filter by free-text description or notes for the invoice.
</ParamField>

<ParamField type="number">
  Filter by discount amount applied to the invoice total.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is due.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice.
</ParamField>

<ParamField type="number">
  Filter by total invoice amount including tax.
</ParamField>

<ParamField type="number">
  Filter by total amount paid against this invoice so far.
</ParamField>

<ParamField type="number">
  Filter by the transaction total amount value for this coworker invoice.
</ParamField>

<ParamField type="integer">
  Filter by iD of the transaction currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the transaction currency code value for this coworker invoice.
</ParamField>

<ParamField type="number">
  Filter by the transaction exchange rate value for this coworker invoice.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by iSO currency code (e.g. USD, EUR, GBP).
</ParamField>

<ParamField type="number">
  Filter by total tax amount on the invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is still a draft. Draft invoices can be modified before finalisation.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been voided (cancelled without a credit note).
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is queued for invoice number assignment.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been fully paid.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been emailed to the customer.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was emailed to the customer.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was marked as fully paid.
</ParamField>

<ParamField type="boolean">
  Filter by whether a refund has been issued for this invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been transferred to Xero.
</ParamField>

<ParamField type="boolean">
  Filter by whether the payment has been transferred to Xero.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been transferred to QuickBooks.
</ParamField>

<ParamField type="boolean">
  Filter by whether the payment has been transferred to QuickBooks.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been transferred to Moloni.
</ParamField>

<ParamField type="boolean">
  Filter by whether the payment has been transferred to Moloni.
</ParamField>

<ParamField type="integer">
  Filter by status of e-invoicing transfer via Storecove.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is automatically sent to Storecove for e-invoicing.
</ParamField>

<ParamField type="string">
  Filter by iD of the storecove unique associated with this record.
</ParamField>

<ParamField type="string">
  Filter by date the refund was issued.
</ParamField>

<ParamField type="boolean">
  Filter by whether this document is a credit note rather than an invoice.
</ParamField>

<ParamField type="string">
  Filter by gUID of the original invoice this credit note reverses.
</ParamField>

<ParamField type="string">
  Filter by gUID of the contract that generated this invoice.
</ParamField>

<ParamField type="string">
  Filter by arbitrary custom data stored with the invoice.
</ParamField>

<ParamField type="string">
  Filter by goCardless payment reference for direct debit collection.
</ParamField>

<ParamField type="string">
  Filter by the spreedly token value for this coworker invoice.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt.
</ParamField>

<ParamField type="boolean">
  Filter by whether billed is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether to skip automatic application of available credit to this invoice.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice from date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice to date local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for paid on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt local.
</ParamField>

<ParamField type="number">
  Filter by total amount received via direct payments.
</ParamField>

<ParamField type="number">
  Filter by amount paid via credit notes or account credit.
</ParamField>

<ParamField type="number">
  Filter by total amount refunded on this invoice.
</ParamField>

<ParamField type="string">
  Filter by transaction ID from NexKiosk point-of-sale payment.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is automatically transferred to Xero or QuickBooks.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by discount amount applied to the invoice total greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount applied to the invoice total less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is due greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is due less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by total invoice amount including tax greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total invoice amount including tax less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount paid against this invoice so far greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount paid against this invoice so far less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the transaction total amount value for this coworker invoice greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the transaction total amount value for this coworker invoice less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the transaction exchange rate value for this coworker invoice greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the transaction exchange rate value for this coworker invoice less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total tax amount on the invoice greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total tax amount on the invoice less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was emailed to the customer greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was emailed to the customer less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was marked as fully paid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was marked as fully paid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the refund was issued greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the refund was issued less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice from date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice from date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice to date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for invoice to date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for paid on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for paid on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for refunded on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for last payment attempt local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by total amount received via direct payments greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount received via direct payments less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount paid via credit notes or account credit greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by amount paid via credit notes or account credit less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount refunded on this invoice greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total amount refunded on this invoice less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices?page=1&size=15&orderBy=InvoiceNumber&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'InvoiceNumber',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'InvoiceNumber',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by InvoiceNumber

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices?CoworkerInvoice_InvoiceNumber=example-value&orderBy=InvoiceNumber&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
      CoworkerInvoice_InvoiceNumber: 'example-value',
      orderBy: 'InvoiceNumber',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoices',
      params={
          'CoworkerInvoice_InvoiceNumber': 'example-value',
          'orderBy': 'InvoiceNumber',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices?from_CoworkerInvoice_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
      from_CoworkerInvoice_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerInvoice_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoices',
      params={
          'from_CoworkerInvoice_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerInvoice_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerInvoice[]">
  The list of CoworkerInvoice records matching the query. See the [Get one CoworkerInvoice](/rest-api/billing/get-coworkerinvoices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerRegularPaymentContractNumber": null,
      "CoworkerRegularPaymentProvider": null,
      "CoworkerCardNumber": null,
      "CoworkerGoCardlessContractNumber": null,
      "CoworkerEnableGoCardlessPayments": null,
      "CoworkerBillingEmail": null,
      "CoworkerNotifyOnNewInvoice": null,
      "CoworkerNotifyOnNewPayment": null,
      "CoworkerNotifyOnFailedPayment": null,
      "CoworkerDoNotProcessInvoicesAutomatically": null,
      "CoworkerCompanyName": null,
      "CoworkerTeamNames": null,
      "BusinessId": 0,
      "BusinessName": null,
      "InvoiceNumber": "",
      "PaymentReference": null,
      "BillToName": "",
      "BillToAddress": "",
      "BillToCity": "",
      "BillToPostCode": "",
      "BillToPhone": null,
      "BillToFax": null,
      "BillToState": null,
      "BillToCountryId": 0,
      "BillToCountryName": null,
      "BillToCountryTwoDigitsCode": null,
      "BillToBankAccount": null,
      "BillToTaxIDNumber": null,
      "PurchaseOrder": null,
      "Description": null,
      "DiscountAmount": 0,
      "DueDate": null,
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "TotalAmount": 0,
      "PaidAmount": null,
      "TransactionTotalAmount": null,
      "TransactionCurrencyId": null,
      "TransactionCurrencyCode": null,
      "TransactionExchangeRate": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxAmount": 0,
      "Draft": false,
      "Void": false,
      "WaitingForInvoiceNumber": false,
      "Paid": false,
      "Sent": false,
      "SentOn": null,
      "PaidOn": null,
      "Refunded": false,
      "XeroInvoiceTransfered": false,
      "XeroPaymentTransfered": false,
      "QuickbooksInvoiceTransfered": false,
      "QuickbooksPaymentTransfered": false,
      "MoloniInvoiceTransferred": false,
      "MoloniPaymentTransferred": false,
      "StorecoveInvoiceStatus": 0,
      "AutoTransferToStorecove": false,
      "StorecoveUniqueId": null,
      "RefundedOn": null,
      "CreditNote": false,
      "OriginalInvoiceGuid": null,
      "ContractGuid": null,
      "CustomData": null,
      "GoCardlessReference": null,
      "SpreedlyToken": null,
      "LastPaymentAttempt": null,
      "Billed": false,
      "DoNotApplyCreditAutomatically": false,
      "CreatedOnLocal": null,
      "DueDateLocal": null,
      "InvoiceFromDateLocal": null,
      "InvoiceToDateLocal": null,
      "PaidOnLocal": null,
      "RefundedOnLocal": null,
      "LastPaymentAttemptLocal": null,
      "ReceivedAmount": null,
      "CreditedAmount": null,
      "RefundedAmount": null,
      "NexKioskTransactionId": null,
      "AutoTransferToXeroOrQuickBooks": false,
      "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": "CoworkerInvoice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "InvoiceNumber",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerInvoices
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoices-batch

GET /api/billing/coworkerinvoices/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerInvoice records by their Ids in a single request.

Fetch several CoworkerInvoice records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerInvoice-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerInvoice Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerInvoice records. Each record has the same structure as the response from the [Get one CoworkerInvoice](/rest-api/billing/get-coworkerinvoices-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "CoworkerFullName": null,
    "CoworkerRegularPaymentContractNumber": null,
    "CoworkerRegularPaymentProvider": null,
    "CoworkerCardNumber": null,
    "CoworkerGoCardlessContractNumber": null,
    "CoworkerEnableGoCardlessPayments": null,
    "CoworkerBillingEmail": null,
    "CoworkerNotifyOnNewInvoice": null,
    "CoworkerNotifyOnNewPayment": null,
    "CoworkerNotifyOnFailedPayment": null,
    "CoworkerDoNotProcessInvoicesAutomatically": null,
    "CoworkerCompanyName": null,
    "CoworkerTeamNames": null,
    "BusinessId": 0,
    "BusinessName": null,
    "InvoiceNumber": "",
    "PaymentReference": null,
    "BillToName": "",
    "BillToAddress": "",
    "BillToCity": "",
    "BillToPostCode": "",
    "BillToPhone": null,
    "BillToFax": null,
    "BillToState": null,
    "BillToCountryId": 0,
    "BillToCountryName": null,
    "BillToCountryTwoDigitsCode": null,
    "BillToBankAccount": null,
    "BillToTaxIDNumber": null,
    "PurchaseOrder": null,
    "Description": null,
    "DiscountAmount": 0,
    "DueDate": null,
    "InvoiceFromDate": null,
    "InvoiceToDate": null,
    "TotalAmount": 0,
    "PaidAmount": null,
    "TransactionTotalAmount": null,
    "TransactionCurrencyId": null,
    "TransactionCurrencyCode": null,
    "TransactionExchangeRate": null,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxAmount": 0,
    "Draft": false,
    "Void": false,
    "WaitingForInvoiceNumber": false,
    "Paid": false,
    "Sent": false,
    "SentOn": null,
    "PaidOn": null,
    "Refunded": false,
    "XeroInvoiceTransfered": false,
    "XeroPaymentTransfered": false,
    "QuickbooksInvoiceTransfered": false,
    "QuickbooksPaymentTransfered": false,
    "MoloniInvoiceTransferred": false,
    "MoloniPaymentTransferred": false,
    "StorecoveInvoiceStatus": 0,
    "AutoTransferToStorecove": false,
    "StorecoveUniqueId": null,
    "RefundedOn": null,
    "CreditNote": false,
    "OriginalInvoiceGuid": null,
    "ContractGuid": null,
    "CustomData": null,
    "GoCardlessReference": null,
    "SpreedlyToken": null,
    "LastPaymentAttempt": null,
    "Billed": false,
    "DoNotApplyCreditAutomatically": false,
    "CreatedOnLocal": null,
    "DueDateLocal": null,
    "InvoiceFromDateLocal": null,
    "InvoiceToDateLocal": null,
    "PaidOnLocal": null,
    "RefundedOnLocal": null,
    "LastPaymentAttemptLocal": null,
    "ReceivedAmount": null,
    "CreditedAmount": null,
    "RefundedAmount": null,
    "NexKioskTransactionId": null,
    "AutoTransferToXeroOrQuickBooks": false,
    "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": "CoworkerInvoice Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerInvoice
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerinvoices-by-id

GET /api/billing/coworkerinvoices/{id}
Retrieve a single CoworkerInvoice record by its Id.

A **CoworkerInvoice** represents an invoice document issued to a customer. Invoices track amounts owed, payment status, billing details, and integration state with external accounting systems.

Invoices can be in draft or final state. A draft invoice (\`\`Draft` true`) can still be modified before being finalised. Once finalised, an invoice number is assigned and the invoice can be sent to the customer.

An invoice may also be a **credit note** (``CreditNote` true`), which references the original invoice via ``OriginalInvoiceGuid\`\` and represents a reversal or adjustment.

Payment status is tracked via `Paid`, `PaidAmount`, and `PaidOn`. Partial payments are possible — compare `PaidAmount` against `TotalAmount` to determine outstanding balance. Refunds are tracked separately via `Refunded`, `RefundedOn`, and `RefundedAmount`.

## Authentication

<Note>
  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 **`CoworkerInvoice-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerInvoice record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the invoiced customer.
</ResponseField>

<ResponseField name="CoworkerRegularPaymentContractNumber" type="string">
  The coworker regular payment contract number value for this coworker invoice.
</ResponseField>

<ResponseField name="CoworkerRegularPaymentProvider" type="string">
  The coworker regular payment provider value for this coworker invoice.
</ResponseField>

<ResponseField name="CoworkerCardNumber" type="string">
  The coworker card number value for this coworker invoice.
</ResponseField>

<ResponseField name="CoworkerGoCardlessContractNumber" type="string">
  The coworker go cardless contract number value for this coworker invoice.
</ResponseField>

<ResponseField name="CoworkerEnableGoCardlessPayments" type="boolean">
  Whether coworker enable go cardless payments is enabled.
</ResponseField>

<ResponseField name="CoworkerBillingEmail" type="string">
  Billing email address of the customer.
</ResponseField>

<ResponseField name="CoworkerNotifyOnNewInvoice" type="boolean">
  Whether coworker notify on new invoice is enabled.
</ResponseField>

<ResponseField name="CoworkerNotifyOnNewPayment" type="boolean">
  Whether coworker notify on new payment is enabled.
</ResponseField>

<ResponseField name="CoworkerNotifyOnFailedPayment" type="boolean">
  Whether coworker notify on failed payment is enabled.
</ResponseField>

<ResponseField name="CoworkerDoNotProcessInvoicesAutomatically" type="boolean">
  Whether coworker do not process invoices automatically is enabled.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the invoiced customer.
</ResponseField>

<ResponseField name="CoworkerTeamNames" type="string">
  Team names the invoiced customer belongs to.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Name of the location that issued the invoice.
</ResponseField>

<ResponseField name="InvoiceNumber" type="string">
  Unique invoice number assigned when the invoice is finalised.
</ResponseField>

<ResponseField name="PaymentReference" type="string">
  Reference code used to match payments to this invoice.
</ResponseField>

<ResponseField name="BillToName" type="string">
  Name of the person or company being billed.
</ResponseField>

<ResponseField name="BillToAddress" type="string">
  Billing address on the invoice.
</ResponseField>

<ResponseField name="BillToCity" type="string">
  Billing city on the invoice.
</ResponseField>

<ResponseField name="BillToPostCode" type="string">
  Billing post code on the invoice.
</ResponseField>

<ResponseField name="BillToPhone" type="string">
  Billing phone number on the invoice.
</ResponseField>

<ResponseField name="BillToFax" type="string">
  Billing fax number on the invoice.
</ResponseField>

<ResponseField name="BillToState" type="string">
  Billing state or region on the invoice.
</ResponseField>

<ResponseField name="BillToCountryId" type="integer">
  ID of the bill to country linked to this record.
</ResponseField>

<ResponseField name="BillToCountryName" type="string">
  Name of the billing country on the invoice.
</ResponseField>

<ResponseField name="BillToCountryTwoDigitsCode" type="string">
  The bill to country two digits code value for this coworker invoice.
</ResponseField>

<ResponseField name="BillToBankAccount" type="string">
  Bank account number on the invoice for payment.
</ResponseField>

<ResponseField name="BillToTaxIDNumber" type="string">
  Tax identification number of the billed party.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Customer purchase order number for this invoice.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description or notes for the invoice.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount applied to the invoice total.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Date by which payment is due.
</ResponseField>

<ResponseField name="InvoiceFromDate" type="string">
  Start date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="InvoiceToDate" type="string">
  End date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Total invoice amount including tax.
</ResponseField>

<ResponseField name="PaidAmount" type="number">
  Total amount paid against this invoice so far.
</ResponseField>

<ResponseField name="TransactionTotalAmount" type="number">
  The transaction total amount value for this coworker invoice.
</ResponseField>

<ResponseField name="TransactionCurrencyId" type="integer">
  ID of the transaction currency linked to this record.
</ResponseField>

<ResponseField name="TransactionCurrencyCode" type="string">
  The transaction currency code value for this coworker invoice.
</ResponseField>

<ResponseField name="TransactionExchangeRate" type="number">
  The transaction exchange rate value for this coworker invoice.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  ISO currency code (e.g. USD, EUR, GBP).
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Total tax amount on the invoice.
</ResponseField>

<ResponseField name="Draft" type="boolean">
  Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
</ResponseField>

<ResponseField name="Void" type="boolean">
  Whether the invoice has been voided (cancelled without a credit note).
</ResponseField>

<ResponseField name="WaitingForInvoiceNumber" type="boolean">
  Whether the invoice is queued for invoice number assignment.
</ResponseField>

<ResponseField name="Paid" type="boolean">
  Whether the invoice has been fully paid.
</ResponseField>

<ResponseField name="Sent" type="boolean">
  Whether the invoice has been emailed to the customer.
</ResponseField>

<ResponseField name="SentOn" type="string">
  Date the invoice was emailed to the customer.
</ResponseField>

<ResponseField name="PaidOn" type="string">
  Date the invoice was marked as fully paid.
</ResponseField>

<ResponseField name="Refunded" type="boolean">
  Whether a refund has been issued for this invoice.
</ResponseField>

<ResponseField name="XeroInvoiceTransfered" type="boolean">
  Whether the invoice has been transferred to Xero.
</ResponseField>

<ResponseField name="XeroPaymentTransfered" type="boolean">
  Whether the payment has been transferred to Xero.
</ResponseField>

<ResponseField name="QuickbooksInvoiceTransfered" type="boolean">
  Whether the invoice has been transferred to QuickBooks.
</ResponseField>

<ResponseField name="QuickbooksPaymentTransfered" type="boolean">
  Whether the payment has been transferred to QuickBooks.
</ResponseField>

<ResponseField name="MoloniInvoiceTransferred" type="boolean">
  Whether the invoice has been transferred to Moloni.
</ResponseField>

<ResponseField name="MoloniPaymentTransferred" type="boolean">
  Whether the payment has been transferred to Moloni.
</ResponseField>

<ResponseField name="StorecoveInvoiceStatus" type="integer">
  Status of e-invoicing transfer via Storecove. See `eStorecoveInvoiceStatus` enum values: `1` = None, `2` = TransferFailed, `3` = Processing, `4` = ProcessingFailed, `5` = Processed.
</ResponseField>

<ResponseField name="AutoTransferToStorecove" type="boolean">
  Whether the invoice is automatically sent to Storecove for e-invoicing.
</ResponseField>

<ResponseField name="StorecoveUniqueId" type="string">
  ID of the storecove unique associated with this record.
</ResponseField>

<ResponseField name="RefundedOn" type="string">
  Date the refund was issued.
</ResponseField>

<ResponseField name="CreditNote" type="boolean">
  Whether this document is a credit note rather than an invoice.
</ResponseField>

<ResponseField name="OriginalInvoiceGuid" type="string">
  GUID of the original invoice this credit note reverses.
</ResponseField>

<ResponseField name="ContractGuid" type="string">
  GUID of the contract that generated this invoice.
</ResponseField>

<ResponseField name="CustomData" type="string">
  Arbitrary custom data stored with the invoice.
</ResponseField>

<ResponseField name="GoCardlessReference" type="string">
  GoCardless payment reference for direct debit collection.
</ResponseField>

<ResponseField name="SpreedlyToken" type="string">
  The spreedly token value for this coworker invoice.
</ResponseField>

<ResponseField name="LastPaymentAttempt" type="string">
  Date/time value for last payment attempt.
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Whether billed is enabled.
</ResponseField>

<ResponseField name="DoNotApplyCreditAutomatically" type="boolean">
  Whether to skip automatic application of available credit to this invoice.
</ResponseField>

<ResponseField name="CreatedOnLocal" type="string">
  Date/time value for created on local.
</ResponseField>

<ResponseField name="DueDateLocal" type="string">
  Date/time value for due date local.
</ResponseField>

<ResponseField name="InvoiceFromDateLocal" type="string">
  Date/time value for invoice from date local.
</ResponseField>

<ResponseField name="InvoiceToDateLocal" type="string">
  Date/time value for invoice to date local.
</ResponseField>

<ResponseField name="PaidOnLocal" type="string">
  Date/time value for paid on local.
</ResponseField>

<ResponseField name="RefundedOnLocal" type="string">
  Date/time value for refunded on local.
</ResponseField>

<ResponseField name="LastPaymentAttemptLocal" type="string">
  Date/time value for last payment attempt local.
</ResponseField>

<ResponseField name="ReceivedAmount" type="number">
  Total amount received via direct payments.
</ResponseField>

<ResponseField name="CreditedAmount" type="number">
  Amount paid via credit notes or account credit.
</ResponseField>

<ResponseField name="RefundedAmount" type="number">
  Total amount refunded on this invoice.
</ResponseField>

<ResponseField name="NexKioskTransactionId" type="string">
  Transaction ID from NexKiosk point-of-sale payment.
</ResponseField>

<ResponseField name="AutoTransferToXeroOrQuickBooks" type="boolean">
  Whether the invoice is automatically transferred to Xero or QuickBooks.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerRegularPaymentContractNumber": null,
  "CoworkerRegularPaymentProvider": null,
  "CoworkerCardNumber": null,
  "CoworkerGoCardlessContractNumber": null,
  "CoworkerEnableGoCardlessPayments": null,
  "CoworkerBillingEmail": null,
  "CoworkerNotifyOnNewInvoice": null,
  "CoworkerNotifyOnNewPayment": null,
  "CoworkerNotifyOnFailedPayment": null,
  "CoworkerDoNotProcessInvoicesAutomatically": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "BusinessId": 0,
  "BusinessName": null,
  "InvoiceNumber": "",
  "PaymentReference": null,
  "BillToName": "",
  "BillToAddress": "",
  "BillToCity": "",
  "BillToPostCode": "",
  "BillToPhone": null,
  "BillToFax": null,
  "BillToState": null,
  "BillToCountryId": 0,
  "BillToCountryName": null,
  "BillToCountryTwoDigitsCode": null,
  "BillToBankAccount": null,
  "BillToTaxIDNumber": null,
  "PurchaseOrder": null,
  "Description": null,
  "DiscountAmount": 0,
  "DueDate": null,
  "InvoiceFromDate": null,
  "InvoiceToDate": null,
  "TotalAmount": 0,
  "PaidAmount": null,
  "TransactionTotalAmount": null,
  "TransactionCurrencyId": null,
  "TransactionCurrencyCode": null,
  "TransactionExchangeRate": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxAmount": 0,
  "Draft": false,
  "Void": false,
  "WaitingForInvoiceNumber": false,
  "Paid": false,
  "Sent": false,
  "SentOn": null,
  "PaidOn": null,
  "Refunded": false,
  "XeroInvoiceTransfered": false,
  "XeroPaymentTransfered": false,
  "QuickbooksInvoiceTransfered": false,
  "QuickbooksPaymentTransfered": false,
  "MoloniInvoiceTransferred": false,
  "MoloniPaymentTransferred": false,
  "StorecoveInvoiceStatus": 0,
  "AutoTransferToStorecove": false,
  "StorecoveUniqueId": null,
  "RefundedOn": null,
  "CreditNote": false,
  "OriginalInvoiceGuid": null,
  "ContractGuid": null,
  "CustomData": null,
  "GoCardlessReference": null,
  "SpreedlyToken": null,
  "LastPaymentAttempt": null,
  "Billed": false,
  "DoNotApplyCreditAutomatically": false,
  "CreatedOnLocal": null,
  "DueDateLocal": null,
  "InvoiceFromDateLocal": null,
  "InvoiceToDateLocal": null,
  "PaidOnLocal": null,
  "RefundedOnLocal": null,
  "LastPaymentAttemptLocal": null,
  "ReceivedAmount": null,
  "CreditedAmount": null,
  "RefundedAmount": null,
  "NexKioskTransactionId": null,
  "AutoTransferToXeroOrQuickBooks": false,
  "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": "CoworkerInvoice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerLedgerEntries
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerledgerentries

GET /api/billing/coworkerledgerentries
Search and list CoworkerLedgerEntry records with filtering, sorting, and pagination.

A **CoworkerLedgerEntry** is an individual financial transaction line in a customer's ledger. Ledger entries record debits, credits, and the running balance between a location and a customer.

Each entry can be linked to a `CoworkerInvoice` and carries a `PaymentGatewayName` that identifies which payment provider processed the transaction.

The ledger balance reflects the net financial position between the location and the customer:

* A **positive** balance means the customer owes money (unpaid invoices).
* A **negative** balance means the customer has credited payments that will be applied to future invoices.
* A balance of **0** means the account is settled with no outstanding invoices or credits.

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-List`** role.
</Note>

## Enums

<Accordion title="ePaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | PayPalStandard             |
  | 2     | PaypalStandardSubscription |
  | 3     | GoCardless                 |
  | 4     | Stripe                     |
  | 5     | AuthorizeNetDirect         |
  | 6     | UsaEPay                    |
  | 7     | AuthorizeNetSubscription   |
  | 8     | Adyen                      |
  | 9     | MultiGateway               |
  | 11    | Manual                     |
  | 12    | Forte                      |
  | 13    | PayPalAdaptive             |
  | 14    | GoCardlessPro              |
  | 15    | CreditCard                 |
  | 16    | EPay                       |
  | 17    | Braintree                  |
  | 18    | MidTrans                   |
  | 19    | EziDebit                   |
  | 20    | LiqPay                     |
  | 21    | RazorPay                   |
  | 22    | SquareCash                 |
  | 23    | SquareCreditCard           |
  | 24    | StripeACH                  |
  | 25    | StripeDirectDebit          |
  | 26    | IZettleCreditCard          |
  | 27    | PeachPayments              |
  | 28    | Klarna                     |
  | 29    | StripeTerminal             |
  | 30    | PayPalStandardRest         |
  | 401   | HostedPaymentPage1         |
  | 402   | HostedPaymentPage2         |
  | 403   | HostedPaymentPage3         |
  | 500   | Xero                       |
  | 501   | Quickbooks                 |
  | 989   | ManualDirectDebit          |
  | 990   | BadDebt                    |
  | 991   | CreditCardManual1          |
  | 992   | CreditCardManual2          |
  | 993   | CreditCardManual3          |
  | 994   | Credit                     |
  | 995   | Gift                       |
  | 996   | Bank                       |
  | 997   | Cash                       |
  | 998   | Check                      |
  | 999   | Other                      |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by location name.
</ParamField>

<ParamField type="string">
  Filter by location currency code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by coworker full name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice linked to this record.
</ParamField>

<ParamField type="string">
  Filter by invoice number.
</ParamField>

<ParamField type="string">
  Filter by invoice total amount.
</ParamField>

<ParamField type="string">
  Filter by invoice bill-to name.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been paid.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was paid.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been refunded.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was refunded.
</ParamField>

<ParamField type="string">
  Filter by invoice due date.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is a draft.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice is waiting to be assigned an invoice number.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this coworker ledger entry.
</ParamField>

<ParamField type="string">
  Filter by ledger entry code.
</ParamField>

<ParamField type="number">
  Filter by debit amount.
</ParamField>

<ParamField type="number">
  Filter by credit amount.
</ParamField>

<ParamField type="integer">
  Filter by payment gateway name.
</ParamField>

<ParamField type="string">
  Filter by payment method number.
</ParamField>

<ParamField type="string">
  Filter by transaction date.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only.
</ParamField>

<ParamField type="boolean">
  Filter by whether this entry has been billed.
</ParamField>

<ParamField type="string">
  Filter by transaction date in the location's local time.
</ParamField>

<ParamField type="string">
  Filter by connected transaction GUID.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date the invoice was paid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was paid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was refunded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the invoice was refunded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by debit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by debit amount less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by transaction date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by transaction date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by transaction date in the location's local time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by transaction date in the location's local time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries?page=1&size=15&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Description',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Description

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries?CoworkerLedgerEntry_Description=example-value&orderBy=Description&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries?' + new URLSearchParams({
      CoworkerLedgerEntry_Description: 'example-value',
      orderBy: 'Description',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      params={
          'CoworkerLedgerEntry_Description': 'example-value',
          'orderBy': 'Description',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries?from_CoworkerLedgerEntry_UpdatedOn=2025-01-01T00:00&to_CoworkerLedgerEntry_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries?' + new URLSearchParams({
      from_CoworkerLedgerEntry_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerLedgerEntry_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      params={
          'from_CoworkerLedgerEntry_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerLedgerEntry_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerLedgerEntry[]">
  The list of CoworkerLedgerEntry records matching the query. See the [Get one CoworkerLedgerEntry](/rest-api/billing/get-coworkerledgerentries-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerLedgerEntry. The following fields are **not populated** in the `Records[]` response: `Description`, `PaymentMethodNumber`.

  To get all fields, fetch the full record using the [Get one CoworkerLedgerEntry](/rest-api/billing/get-coworkerledgerentries-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerInvoiceId": null,
      "CoworkerInvoiceInvoiceNumber": null,
      "CoworkerInvoiceTotalAmount": null,
      "CoworkerInvoiceBillToName": null,
      "CoworkerInvoicePaid": null,
      "CoworkerInvoicePaidOn": null,
      "CoworkerInvoiceRefunded": null,
      "CoworkerInvoiceRefundedOn": null,
      "CoworkerInvoiceDueDate": null,
      "CoworkerInvoiceDraft": null,
      "CoworkerInvoiceWaitingForInvoiceNumber": null,
      "Code": "",
      "Debit": 0,
      "Credit": 0,
      "PaymentGatewayName": 0,
      "TransactionDate": null,
      "Balance": 0,
      "Billed": false,
      "TransactionDateLocal": null,
      "ConnectedTransactionGuid": 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": "CoworkerLedgerEntry Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerLedgerEntries
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerledgerentries-batch

GET /api/billing/coworkerledgerentries/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerLedgerEntry records by their Ids in a single request.

Fetch several CoworkerLedgerEntry records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerLedgerEntry Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerLedgerEntry records. Each record has the same structure as the response from the [Get one CoworkerLedgerEntry](/rest-api/billing/get-coworkerledgerentries-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerLedgerEntry. The following fields are **not populated** in the response: `Description`, `PaymentMethodNumber`.

  To get all fields, fetch the full record using the [Get one CoworkerLedgerEntry](/rest-api/billing/get-coworkerledgerentries-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessCurrencyCode": null,
    "CoworkerId": 0,
    "CoworkerFullName": null,
    "CoworkerInvoiceId": null,
    "CoworkerInvoiceInvoiceNumber": null,
    "CoworkerInvoiceTotalAmount": null,
    "CoworkerInvoiceBillToName": null,
    "CoworkerInvoicePaid": null,
    "CoworkerInvoicePaidOn": null,
    "CoworkerInvoiceRefunded": null,
    "CoworkerInvoiceRefundedOn": null,
    "CoworkerInvoiceDueDate": null,
    "CoworkerInvoiceDraft": null,
    "CoworkerInvoiceWaitingForInvoiceNumber": null,
    "Code": "",
    "Debit": 0,
    "Credit": 0,
    "PaymentGatewayName": 0,
    "TransactionDate": null,
    "Balance": 0,
    "Billed": false,
    "TransactionDateLocal": null,
    "ConnectedTransactionGuid": 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": "CoworkerLedgerEntry Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerLedgerEntry
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerledgerentries-by-id

GET /api/billing/coworkerledgerentries/{id}
Retrieve a single CoworkerLedgerEntry record by its Id.

A **CoworkerLedgerEntry** is an individual financial transaction line in a customer's ledger. Ledger entries record debits, credits, and the running balance between a location and a customer.

Each entry can be linked to a `CoworkerInvoice` and carries a `PaymentGatewayName` that identifies which payment provider processed the transaction.

The ledger balance reflects the net financial position between the location and the customer:

* A **positive** balance means the customer owes money (unpaid invoices).
* A **negative** balance means the customer has credited payments that will be applied to future invoices.
* A balance of **0** means the account is settled with no outstanding invoices or credits.

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerLedgerEntry record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Location currency code.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Coworker full name.
</ResponseField>

<ResponseField name="CoworkerInvoiceId" type="integer">
  ID of the coworker invoice linked to this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Invoice number.
</ResponseField>

<ResponseField name="CoworkerInvoiceTotalAmount" type="string">
  Invoice total amount.
</ResponseField>

<ResponseField name="CoworkerInvoiceBillToName" type="string">
  Invoice bill-to name.
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="boolean">
  Whether the invoice has been paid.
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Date the invoice was paid.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefunded" type="boolean">
  Whether the invoice has been refunded.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefundedOn" type="string">
  Date the invoice was refunded.
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Invoice due date.
</ResponseField>

<ResponseField name="CoworkerInvoiceDraft" type="boolean">
  Whether the invoice is a draft.
</ResponseField>

<ResponseField name="CoworkerInvoiceWaitingForInvoiceNumber" type="boolean">
  Whether the invoice is waiting to be assigned an invoice number.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this coworker ledger entry.
</ResponseField>

<ResponseField name="Code" type="string">
  Ledger entry code.
</ResponseField>

<ResponseField name="Debit" type="number">
  Debit amount.
</ResponseField>

<ResponseField name="Credit" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="PaymentGatewayName" type="integer">
  Payment gateway name.
</ResponseField>

<ResponseField name="PaymentMethodNumber" type="string">
  Payment method number.
</ResponseField>

<ResponseField name="TransactionDate" type="string">
  Transaction date.
</ResponseField>

<ResponseField name="Balance" type="number">
  Account balance after this transaction. Read-only.
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Whether this entry has been billed.
</ResponseField>

<ResponseField name="TransactionDateLocal" type="string">
  Transaction date in the location's local time.
</ResponseField>

<ResponseField name="ConnectedTransactionGuid" type="string">
  Connected transaction GUID.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerInvoiceId": null,
  "CoworkerInvoiceInvoiceNumber": null,
  "CoworkerInvoiceTotalAmount": null,
  "CoworkerInvoiceBillToName": null,
  "CoworkerInvoicePaid": null,
  "CoworkerInvoicePaidOn": null,
  "CoworkerInvoiceRefunded": null,
  "CoworkerInvoiceRefundedOn": null,
  "CoworkerInvoiceDueDate": null,
  "CoworkerInvoiceDraft": null,
  "CoworkerInvoiceWaitingForInvoiceNumber": null,
  "Description": "",
  "Code": "",
  "Debit": 0,
  "Credit": 0,
  "PaymentGatewayName": 0,
  "PaymentMethodNumber": null,
  "TransactionDate": null,
  "Balance": 0,
  "Billed": false,
  "TransactionDateLocal": null,
  "ConnectedTransactionGuid": 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": "CoworkerLedgerEntry Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerPaymentMethods
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerpaymentmethods

GET /api/billing/coworkerpaymentmethods
Search and list CoworkerPaymentMethod records with filtering, sorting, and pagination.

A **CoworkerPaymentMethod** is a tokenised payment method stored against a customer and a location, used when charging invoices issued to that customer by that location.

Currently supported providers are **Stripe** (card and ACH/BACS) and **GoCardless** (direct debit mandates). The `RegularPaymentProvider` field identifies the provider; valid values for this entity are `Stripe` (2), `StripeACH` (11), `StripeBACS` (13), and `GoCardless` (12).

* For Stripe methods, `MethodId` holds the Stripe payment method ID and `CustomerId` holds the Stripe customer ID.
* For GoCardless mandates, `MandateId` holds the GoCardless mandate ID and `CustomerId` holds the GoCardless customer ID.
* `CardNumber` stores a masked card number for display purposes only.

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-List`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by customer this payment method belongs to.
</ParamField>

<ParamField type="integer">
  Filter by location that issued or will charge invoices using this payment method.
</ParamField>

<ParamField type="string">
  Filter by location name.
</ParamField>

<ParamField type="string">
  Filter by currency code of the location.
</ParamField>

<ParamField type="integer">
  Filter by payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
</ParamField>

<ParamField type="string">
  Filter by provider payment method ID (e.g. Stripe payment method ID).
</ParamField>

<ParamField type="string">
  Filter by provider customer ID (e.g. Stripe or GoCardless customer ID).
</ParamField>

<ParamField type="string">
  Filter by goCardless mandate ID. Only populated for GoCardless payment methods..
</ParamField>

<ParamField type="string">
  Filter by masked card number for display purposes only.
</ParamField>

<ParamField type="string">
  Filter by optional notes about this payment method.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?CoworkerPaymentMethod_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      CoworkerPaymentMethod_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'CoworkerPaymentMethod_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?from_CoworkerPaymentMethod_UpdatedOn=2025-01-01T00:00&to_CoworkerPaymentMethod_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods?' + new URLSearchParams({
      from_CoworkerPaymentMethod_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerPaymentMethod_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      params={
          'from_CoworkerPaymentMethod_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerPaymentMethod_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerPaymentMethod[]">
  The list of CoworkerPaymentMethod records matching the query. See the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerPaymentMethod. The following fields are **not populated** in the `Records[]` response: `RegularPaymentProvider`.

  To get all fields, fetch the full record using the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "MethodId": null,
      "CustomerId": null,
      "MandateId": null,
      "CardNumber": null,
      "Notes": 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": "CoworkerPaymentMethod Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerPaymentMethods
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerpaymentmethods-batch

GET /api/billing/coworkerpaymentmethods/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerPaymentMethod records by their Ids in a single request.

Fetch several CoworkerPaymentMethod records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerPaymentMethod Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerPaymentMethod records. Each record has the same structure as the response from the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerPaymentMethod. The following fields are **not populated** in the response: `RegularPaymentProvider`.

  To get all fields, fetch the full record using the [Get one CoworkerPaymentMethod](/rest-api/billing/get-coworkerpaymentmethods-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessCurrencyCode": null,
    "MethodId": null,
    "CustomerId": null,
    "MandateId": null,
    "CardNumber": null,
    "Notes": 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": "CoworkerPaymentMethod Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerPaymentMethod
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerpaymentmethods-by-id

GET /api/billing/coworkerpaymentmethods/{id}
Retrieve a single CoworkerPaymentMethod record by its Id.

A **CoworkerPaymentMethod** is a tokenised payment method stored against a customer and a location, used when charging invoices issued to that customer by that location.

Currently supported providers are **Stripe** (card and ACH/BACS) and **GoCardless** (direct debit mandates). The `RegularPaymentProvider` field identifies the provider; valid values for this entity are `Stripe` (2), `StripeACH` (11), `StripeBACS` (13), and `GoCardless` (12).

* For Stripe methods, `MethodId` holds the Stripe payment method ID and `CustomerId` holds the Stripe customer ID.
* For GoCardless mandates, `MandateId` holds the GoCardless mandate ID and `CustomerId` holds the GoCardless customer ID.
* `CardNumber` stores a masked card number for display purposes only.

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerPaymentMethod record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  Customer this payment method belongs to.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  Location that issued or will charge invoices using this payment method.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Currency code of the location.
</ResponseField>

<ResponseField name="RegularPaymentProvider" type="integer">
  Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12)..
</ResponseField>

<ResponseField name="MethodId" type="string">
  Provider payment method ID (e.g. Stripe payment method ID).
</ResponseField>

<ResponseField name="CustomerId" type="string">
  Provider customer ID (e.g. Stripe or GoCardless customer ID).
</ResponseField>

<ResponseField name="MandateId" type="string">
  GoCardless mandate ID. Only populated for GoCardless payment methods..
</ResponseField>

<ResponseField name="CardNumber" type="string">
  Masked card number for display purposes only.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes about this payment method.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "RegularPaymentProvider": 0,
  "MethodId": null,
  "CustomerId": null,
  "MandateId": null,
  "CardNumber": null,
  "Notes": 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": "CoworkerPaymentMethod Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerProducts
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerproducts

GET /api/billing/coworkerproducts
Search and list CoworkerProduct records with filtering, sorting, and pagination.

A **CoworkerProduct** is a record of a product sold to a customer as a one-off or on a recurrent basis.

`RepeatCycle` can only be set to `PricePlan` if the customer has a contract set as their main contract. In general, it is best to use `ContractProduct` instead of adding CoworkerProducts repeating based on `PricePlan`.

`InvoiceThisCoworker` indicates this customer should be invoiced for this product instead of the paying member of their team.

`ActivateNow` releases any benefits (credits or passes) even before the product is invoiced and paid.

`ProductApplyProRating` indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (`RenewalDate`) of the customer's main contract.

Properties ending in `UniqueId` link the sale to the originating record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per record:

| UniqueId property          | Source entity    |
| -------------------------- | ---------------- |
| `CoworkerContractUniqueId` | CoworkerContract |
| `ContractDepositUniqueId`  | ContractDeposit  |
| `ContractProductUniqueId`  | ContractProduct  |
| `BookingUniqueId`          | Booking          |
| `CoworkerDeliveryUniqueId` | CoworkerDelivery |

## Authentication

<Note>
  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 **`CoworkerProduct-List`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by coworker type.
</ParamField>

<ParamField type="string">
  Filter by coworker full name.
</ParamField>

<ParamField type="string">
  Filter by coworker company name.
</ParamField>

<ParamField type="string">
  Filter by coworker billing name.
</ParamField>

<ParamField type="string">
  Filter by coworker email.
</ParamField>

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="string">
  Filter by whether the sold product is configured to prorate the price of this sale based on the prorating rules of the customer's main contract, adjusting the price based on the number of days left until the next invoice date (RenewalDate).
</ParamField>

<ParamField type="string">
  Filter by product currency code.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this coworker product.
</ParamField>

<ParamField type="string">
  Filter by purchase order.
</ParamField>

<ParamField type="string">
  Filter by order number.
</ParamField>

<ParamField type="boolean">
  Filter by whether the product is activated.
</ParamField>

<ParamField type="boolean">
  Filter by activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
</ParamField>

<ParamField type="boolean">
  Filter by invoice this customer for this product instead of the paying member of their team.
</ParamField>

<ParamField type="number">
  Filter by price override.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a regular charge.
</ParamField>

<ParamField type="integer">
  Filter by repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units.
</ParamField>

<ParamField type="string">
  Filter by invoice on date.
</ParamField>

<ParamField type="string">
  Filter by repeat from date.
</ParamField>

<ParamField type="string">
  Filter by repeat until date.
</ParamField>

<ParamField type="string">
  Filter by sale date.
</ParamField>

<ParamField type="string">
  Filter by due date.
</ParamField>

<ParamField type="boolean">
  Filter by whether it has been invoiced.
</ParamField>

<ParamField type="string">
  Filter by date invoiced.
</ParamField>

<ParamField type="boolean">
  Filter by whether added from tariff.
</ParamField>

<ParamField type="string">
  Filter by links to the Booking that generated this sale (GUID UniqueId, not integer ID).
</ParamField>

<ParamField type="boolean">
  Filter by whether mrm reminded is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by apply pro-rating.
</ParamField>

<ParamField type="string">
  Filter by links to the CoworkerContract that generated this sale (GUID UniqueId, not integer ID).
</ParamField>

<ParamField type="string">
  Filter by links to the ContractDeposit that generated this sale (GUID UniqueId, not integer ID).
</ParamField>

<ParamField type="string">
  Filter by links to the ContractProduct that generated this sale (GUID UniqueId, not integer ID).
</ParamField>

<ParamField type="string">
  Filter by links to the CoworkerDelivery that generated this sale (GUID UniqueId, not integer ID).
</ParamField>

<ParamField type="string">
  Filter by iD of the proposal unique associated with this record.
</ParamField>

<ParamField type="integer">
  Filter by coworker invoice ID.
</ParamField>

<ParamField type="string">
  Filter by coworker invoice number.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker invoice is paid.
</ParamField>

<ParamField type="string">
  Filter by teams at the time of purchase.
</ParamField>

<ParamField type="number">
  Filter by credit amount.
</ParamField>

<ParamField type="number">
  Filter by discount amount.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by invoice on date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice on date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by sale date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by sale date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date invoiced greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date invoiced less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by coworker invoice ID greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by coworker invoice ID less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerproducts?CoworkerProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({
      CoworkerProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerproducts',
      params={
          'CoworkerProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerproducts?from_CoworkerProduct_UpdatedOn=2025-01-01T00:00&to_CoworkerProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts?' + new URLSearchParams({
      from_CoworkerProduct_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerproducts',
      params={
          'from_CoworkerProduct_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerProduct[]">
  The list of CoworkerProduct records matching the query. See the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerProduct. The following fields are **not populated** in the `Records[]` response: `Notes`, `PurchaseOrder`, `ActivateNow`, `InvoiceThisCoworker`, `CreditAmount`, `DiscountAmount`.

  To get all fields, fetch the full record using the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "CoworkerEmail": null,
      "BusinessId": 0,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductApplyProRating": null,
      "ProductCurrencyCode": null,
      "OrderNumber": null,
      "Activated": false,
      "Price": null,
      "Quantity": 0,
      "RegularCharge": false,
      "RepeatCycle": 0,
      "RepeatUnit": null,
      "InvoiceOn": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "SaleDate": null,
      "DueDate": null,
      "Invoiced": false,
      "InvoicedOn": null,
      "FromTariff": false,
      "BookingUniqueId": null,
      "MrmReminded": false,
      "ApplyProRating": false,
      "CoworkerContractUniqueId": null,
      "ContractDepositUniqueId": null,
      "ContractProductUniqueId": null,
      "CoworkerDeliveryUniqueId": null,
      "ProposalUniqueId": null,
      "CoworkerInvoiceId": null,
      "CoworkerInvoiceNumber": null,
      "CoworkerInvoicePaid": false,
      "TeamsAtTheTimeOfPurchase": 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": "CoworkerProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerProducts
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerproducts-batch

GET /api/billing/coworkerproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerProduct records by their Ids in a single request.

Fetch several CoworkerProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CoworkerProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerProduct records. Each record has the same structure as the response from the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerProduct. The following fields are **not populated** in the response: `Notes`, `PurchaseOrder`, `ActivateNow`, `InvoiceThisCoworker`, `CreditAmount`, `DiscountAmount`.

  To get all fields, fetch the full record using the [Get one CoworkerProduct](/rest-api/billing/get-coworkerproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "CoworkerCoworkerType": null,
    "CoworkerFullName": null,
    "CoworkerCompanyName": null,
    "CoworkerBillingName": null,
    "CoworkerEmail": null,
    "BusinessId": 0,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductApplyProRating": null,
    "ProductCurrencyCode": null,
    "OrderNumber": null,
    "Activated": false,
    "Price": null,
    "Quantity": 0,
    "RegularCharge": false,
    "RepeatCycle": 0,
    "RepeatUnit": null,
    "InvoiceOn": null,
    "RepeatFrom": null,
    "RepeatUntil": null,
    "SaleDate": null,
    "DueDate": null,
    "Invoiced": false,
    "InvoicedOn": null,
    "FromTariff": false,
    "BookingUniqueId": null,
    "MrmReminded": false,
    "ApplyProRating": false,
    "CoworkerContractUniqueId": null,
    "ContractDepositUniqueId": null,
    "ContractProductUniqueId": null,
    "CoworkerDeliveryUniqueId": null,
    "ProposalUniqueId": null,
    "CoworkerInvoiceId": null,
    "CoworkerInvoiceNumber": null,
    "CoworkerInvoicePaid": false,
    "TeamsAtTheTimeOfPurchase": 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": "CoworkerProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerProduct
Source: https://learn.nexudus.com/rest-api/billing/get-coworkerproducts-by-id

GET /api/billing/coworkerproducts/{id}
Retrieve a single CoworkerProduct record by its Id.

A **CoworkerProduct** is a record of a product sold to a customer as a one-off or on a recurrent basis.

`RepeatCycle` can only be set to `PricePlan` if the customer has a contract set as their main contract. In general, it is best to use `ContractProduct` instead of adding CoworkerProducts repeating based on `PricePlan`.

`InvoiceThisCoworker` indicates this customer should be invoiced for this product instead of the paying member of their team.

`ActivateNow` releases any benefits (credits or passes) even before the product is invoiced and paid.

`ProductApplyProRating` indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (`RenewalDate`) of the customer's main contract.

Properties ending in `UniqueId` link the sale to the originating record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per record:

| UniqueId property          | Source entity    |
| -------------------------- | ---------------- |
| `CoworkerContractUniqueId` | CoworkerContract |
| `ContractDepositUniqueId`  | ContractDeposit  |
| `ContractProductUniqueId`  | ContractProduct  |
| `BookingUniqueId`          | Booking          |
| `CoworkerDeliveryUniqueId` | CoworkerDelivery |

## Authentication

<Note>
  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 **`CoworkerProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Coworker type.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Coworker full name.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Coworker company name.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Coworker billing name.
</ResponseField>

<ResponseField name="CoworkerEmail" type="string">
  Coworker email.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductApplyProRating" type="string">
  Whether the sold product is configured to prorate the price of this sale based on the prorating rules of the customer's main contract, adjusting the price based on the number of days left until the next invoice date (RenewalDate).
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  Product currency code.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this coworker product.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order.
</ResponseField>

<ResponseField name="OrderNumber" type="string">
  Order number.
</ResponseField>

<ResponseField name="Activated" type="boolean">
  Whether the product is activated.
</ResponseField>

<ResponseField name="ActivateNow" type="boolean">
  Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
</ResponseField>

<ResponseField name="InvoiceThisCoworker" type="boolean">
  Invoice this customer for this product instead of the paying member of their team.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="RegularCharge" type="boolean">
  Whether this is a regular charge.
</ResponseField>

<ResponseField name="RepeatCycle" type="integer">
  Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. See `eRecurrentChargePattern` enum values: `1` = PricePlan, `2` = Day, `3` = Week, `4` = Month, `5` = Year, `6` = LastDayOfMonth.
</ResponseField>

<ResponseField name="RepeatUnit" type="integer">
  Number of repeat units.
</ResponseField>

<ResponseField name="InvoiceOn" type="string">
  Invoice on date.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Repeat from date.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Repeat until date.
</ResponseField>

<ResponseField name="SaleDate" type="string">
  Sale date.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Due date.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  Whether it has been invoiced.
</ResponseField>

<ResponseField name="InvoicedOn" type="string">
  Date invoiced.
</ResponseField>

<ResponseField name="FromTariff" type="boolean">
  Whether added from tariff.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  Links to the Booking that generated this sale (GUID UniqueId, not integer ID).
</ResponseField>

<ResponseField name="MrmReminded" type="boolean">
  Whether mrm reminded is enabled.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Apply pro-rating.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  Links to the CoworkerContract that generated this sale (GUID UniqueId, not integer ID).
</ResponseField>

<ResponseField name="ContractDepositUniqueId" type="string">
  Links to the ContractDeposit that generated this sale (GUID UniqueId, not integer ID).
</ResponseField>

<ResponseField name="ContractProductUniqueId" type="string">
  Links to the ContractProduct that generated this sale (GUID UniqueId, not integer ID).
</ResponseField>

<ResponseField name="CoworkerDeliveryUniqueId" type="string">
  Links to the CoworkerDelivery that generated this sale (GUID UniqueId, not integer ID).
</ResponseField>

<ResponseField name="ProposalUniqueId" type="string">
  ID of the proposal unique associated with this record.
</ResponseField>

<ResponseField name="CoworkerInvoiceId" type="integer">
  Coworker invoice ID.
</ResponseField>

<ResponseField name="CoworkerInvoiceNumber" type="string">
  Coworker invoice number.
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="boolean">
  Whether coworker invoice is paid.
</ResponseField>

<ResponseField name="TeamsAtTheTimeOfPurchase" type="string">
  Teams at the time of purchase.
</ResponseField>

<ResponseField name="CreditAmount" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "BusinessId": 0,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductApplyProRating": null,
  "ProductCurrencyCode": null,
  "Notes": null,
  "PurchaseOrder": null,
  "OrderNumber": null,
  "Activated": false,
  "ActivateNow": false,
  "InvoiceThisCoworker": false,
  "Price": null,
  "Quantity": 0,
  "RegularCharge": false,
  "RepeatCycle": 0,
  "RepeatUnit": null,
  "InvoiceOn": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "SaleDate": null,
  "DueDate": null,
  "Invoiced": false,
  "InvoicedOn": null,
  "FromTariff": false,
  "BookingUniqueId": null,
  "MrmReminded": false,
  "ApplyProRating": false,
  "CoworkerContractUniqueId": null,
  "ContractDepositUniqueId": null,
  "ContractProductUniqueId": null,
  "CoworkerDeliveryUniqueId": null,
  "ProposalUniqueId": null,
  "CoworkerInvoiceId": null,
  "CoworkerInvoiceNumber": null,
  "CoworkerInvoicePaid": false,
  "TeamsAtTheTimeOfPurchase": null,
  "CreditAmount": 0,
  "DiscountAmount": 0,
  "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": "CoworkerProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CoworkerTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-coworkertimepasses

GET /api/billing/coworkertimepasses
Search and list CoworkerTimePass records with filtering, sorting, and pagination.

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

<Note>
  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-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by the customer who owns this time pass.
</ParamField>

<ParamField type="integer">
  Filter by the business (location) this time pass belongs to.
</ParamField>

<ParamField type="integer">
  Filter by the time pass definition this is an instance of.
</ParamField>

<ParamField type="string">
  Filter by name of the linked time pass.
</ParamField>

<ParamField type="string">
  Filter by currency code of the linked time pass.
</ParamField>

<ParamField type="string">
  Filter by optional notes for this time pass.
</ParamField>

<ParamField type="string">
  Filter by purchase order reference.
</ParamField>

<ParamField type="boolean">
  Filter by whether this time pass has been used.
</ParamField>

<ParamField type="boolean">
  Filter by whether the customer is currently checked in with this time pass.
</ParamField>

<ParamField type="string">
  Filter by date when this time pass was used.
</ParamField>

<ParamField type="integer">
  Filter by number of remaining uses on this time pass.
</ParamField>

<ParamField type="integer">
  Filter by total number of uses allowed on this time pass.
</ParamField>

<ParamField type="boolean">
  Filter by whether this time pass is free of charge.
</ParamField>

<ParamField type="number">
  Filter by custom price for this time pass.
</ParamField>

<ParamField type="integer">
  Filter by number of time passes to create at once.
</ParamField>

<ParamField type="string">
  Filter by expiration date for this time pass.
</ParamField>

<ParamField type="boolean">
  Filter by whether this time pass has been invoiced.
</ParamField>

<ParamField type="string">
  Filter by date when this time pass was invoiced.
</ParamField>

<ParamField type="boolean">
  Filter by whether this time pass was granted by a pricing plan (tariff).
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a pay-as-you-go time pass.
</ParamField>

<ParamField type="string">
  Filter by unique identifier linking this time pass to a tariff time pass allocation.
</ParamField>

<ParamField type="string">
  Filter by unique identifier linking this time pass to a customer product purchase.
</ParamField>

<ParamField type="string">
  Filter by unique identifier linking this time pass to a customer contract.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date when this time pass was used greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date when this time pass was used less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of remaining uses on this time pass greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of remaining uses on this time pass less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by total number of uses allowed on this time pass greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by total number of uses allowed on this time pass less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by custom price for this time pass greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by custom price for this time pass less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of time passes to create at once greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of time passes to create at once less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by expiration date for this time pass greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by expiration date for this time pass less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date when this time pass was invoiced greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date when this time pass was invoiced less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkertimepasses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses?CoworkerTimePass_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses?' + new URLSearchParams({
      CoworkerTimePass_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkertimepasses',
      params={
          'CoworkerTimePass_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses?from_CoworkerTimePass_UpdatedOn=2025-01-01T00:00&to_CoworkerTimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses?' + new URLSearchParams({
      from_CoworkerTimePass_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerTimePass_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkertimepasses',
      params={
          'from_CoworkerTimePass_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerTimePass_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerTimePass[]">
  The list of CoworkerTimePass records matching the query. See the [Get one CoworkerTimePass](/rest-api/billing/get-coworkertimepasses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerTimePass. The following fields are **not populated** in the `Records[]` response: `Notes`, `PurchaseOrder`, `Free`, `Price`, `CreateMultiple`.

  To get all fields, fetch the full record using the [Get one CoworkerTimePass](/rest-api/billing/get-coworkertimepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "TimePassId": 0,
      "TimePassName": null,
      "TimePassCurrencyCode": null,
      "Used": false,
      "CheckedIn": false,
      "UsedDate": null,
      "RemainingUses": null,
      "TotalUses": null,
      "ExpireDate": null,
      "Invoiced": false,
      "InvoiceDate": null,
      "IsFromTariff": false,
      "IsPayAsYouGo": false,
      "TariffTimePassUniqueId": null,
      "CoworkerProductUniqueId": null,
      "CoworkerContractUniqueId": 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": "CoworkerTimePass Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CoworkerTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-coworkertimepasses-batch

GET /api/billing/coworkertimepasses/?id=[{id1},{id2},{id3}]
Retrieve multiple CoworkerTimePass records by their Ids in a single request.

Fetch several CoworkerTimePass records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CoworkerTimePass Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkertimepasses/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CoworkerTimePass records. Each record has the same structure as the response from the [Get one CoworkerTimePass](/rest-api/billing/get-coworkertimepasses-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CoworkerTimePass. The following fields are **not populated** in the response: `Notes`, `PurchaseOrder`, `Free`, `Price`, `CreateMultiple`.

  To get all fields, fetch the full record using the [Get one CoworkerTimePass](/rest-api/billing/get-coworkertimepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CoworkerId": 0,
    "BusinessId": 0,
    "TimePassId": 0,
    "TimePassName": null,
    "TimePassCurrencyCode": null,
    "Used": false,
    "CheckedIn": false,
    "UsedDate": null,
    "RemainingUses": null,
    "TotalUses": null,
    "ExpireDate": null,
    "Invoiced": false,
    "InvoiceDate": null,
    "IsFromTariff": false,
    "IsPayAsYouGo": false,
    "TariffTimePassUniqueId": null,
    "CoworkerProductUniqueId": null,
    "CoworkerContractUniqueId": 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": "CoworkerTimePass Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CoworkerTimePass
Source: https://learn.nexudus.com/rest-api/billing/get-coworkertimepasses-by-id

GET /api/billing/coworkertimepasses/{id}
Retrieve a single CoworkerTimePass record by its Id.

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

<Note>
  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-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CoworkerTimePass record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  The customer who owns this time pass.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  The business (location) this time pass belongs to.
</ResponseField>

<ResponseField name="TimePassId" type="integer">
  The time pass definition this is an instance of.
</ResponseField>

<ResponseField name="TimePassName" type="string">
  Name of the linked time pass.
</ResponseField>

<ResponseField name="TimePassCurrencyCode" type="string">
  Currency code of the linked time pass.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes for this time pass.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order reference.
</ResponseField>

<ResponseField name="Used" type="boolean">
  Whether this time pass has been used.
</ResponseField>

<ResponseField name="CheckedIn" type="boolean">
  Whether the customer is currently checked in with this time pass.
</ResponseField>

<ResponseField name="UsedDate" type="string">
  Date when this time pass was used.
</ResponseField>

<ResponseField name="RemainingUses" type="integer">
  Number of remaining uses on this time pass.
</ResponseField>

<ResponseField name="TotalUses" type="integer">
  Total number of uses allowed on this time pass.
</ResponseField>

<ResponseField name="Free" type="boolean">
  Whether this time pass is free of charge.
</ResponseField>

<ResponseField name="Price" type="number">
  Custom price for this time pass.
</ResponseField>

<ResponseField name="CreateMultiple" type="integer">
  Number of time passes to create at once.
</ResponseField>

<ResponseField name="ExpireDate" type="string">
  Expiration date for this time pass.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  Whether this time pass has been invoiced.
</ResponseField>

<ResponseField name="InvoiceDate" type="string">
  Date when this time pass was invoiced.
</ResponseField>

<ResponseField name="IsFromTariff" type="boolean">
  Whether this time pass was granted by a pricing plan (tariff).
</ResponseField>

<ResponseField name="IsPayAsYouGo" type="boolean">
  Whether this is a pay-as-you-go time pass.
</ResponseField>

<ResponseField name="TariffTimePassUniqueId" type="string">
  Unique identifier linking this time pass to a tariff time pass allocation.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  Unique identifier linking this time pass to a customer product purchase.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  Unique identifier linking this time pass to a customer contract.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "TimePassId": 0,
  "TimePassName": null,
  "TimePassCurrencyCode": null,
  "Notes": null,
  "PurchaseOrder": null,
  "Used": false,
  "CheckedIn": false,
  "UsedDate": null,
  "RemainingUses": null,
  "TotalUses": null,
  "Free": false,
  "Price": null,
  "CreateMultiple": 0,
  "ExpireDate": null,
  "Invoiced": false,
  "InvoiceDate": null,
  "IsFromTariff": false,
  "IsPayAsYouGo": false,
  "TariffTimePassUniqueId": null,
  "CoworkerProductUniqueId": null,
  "CoworkerContractUniqueId": 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": "CoworkerTimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search DiscountCodes
Source: https://learn.nexudus.com/rest-api/billing/get-discountcodes

GET /api/billing/discountcodes
Search and list DiscountCode records with filtering, sorting, and pagination.

A **DiscountCode** represents a discount registered in the system. Each discount code belongs to a `Business` (location) and defines a percentage or fixed-amount discount that can be applied to different item types: price plans (tariffs), bookings, products, and/or events.

Use the boolean flags (`DiscountPricePlans`, `DiscountBookings`, `DiscountProducts`, `DiscountEvents`) to control which item categories the discount applies to. For each enabled category, associate the specific eligible items via the corresponding ID list (e.g. `Tariffs`, `ResourceTypes`, `Products`, `EventCategories`). Use the `Added*` and `Removed*` list variants for incremental updates without replacing the full list.

A discount can specify either `DiscountPercentage` (e.g. 10 for 10% off) or `DiscountAmount` (a fixed monetary amount off), but not both.

Discount codes can be assigned to individual customers via `CoworkerDiscountCode`. Availability can be further restricted by validity dates (`ValidFrom`/`ValidTo`), publish window (`PublishFrom`/`PublishTo`), usage caps (`MaxUses`, `MaxUsesPerUser`), audience (`OnlyForContacts`, `OnlyForMembers`), and expiration rules (`ExpirationType`, `ExpiresIn`).

## Authentication

<Note>
  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 **`DiscountCode-List`** role.
</Note>

## Enums

<Accordion title="eDiscountExpirePeriod">
  | Value | Name  |
  | ----- | ----- |
  | 1     | Day   |
  | 2     | Week  |
  | 3     | Month |
  | 4     | Year  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the business (location) this discount code belongs to.
</ParamField>

<ParamField type="string">
  Filter by currency code of the business (e.g. USD, EUR).
</ParamField>

<ParamField type="string">
  Filter by the unique alphanumeric code customers enter to apply the discount.
</ParamField>

<ParamField type="string">
  Filter by human-readable description of what this discount code is for.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount code is currently active and can be redeemed.
</ParamField>

<ParamField type="string">
  Filter by date from which this discount code is visible/published to customers.
</ParamField>

<ParamField type="string">
  Filter by date until which this discount code is visible/published to customers.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.
</ParamField>

<ParamField type="number">
  Filter by fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount code is used as part of the referral program.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount can be applied to products. When true, use Products to restrict to specific products.
</ParamField>

<ParamField type="boolean">
  Filter by whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a single customer can redeem this discount code.
</ParamField>

<ParamField type="integer">
  Filter by maximum total number of times this discount code can be redeemed across all customers.
</ParamField>

<ParamField type="boolean">
  Filter by when true, only contacts (non-member customers) can use this discount code.
</ParamField>

<ParamField type="boolean">
  Filter by when true, only members (customers with an active plan) can use this discount code.
</ParamField>

<ParamField type="string">
  Filter by start date from which this discount code can be redeemed.
</ParamField>

<ParamField type="string">
  Filter by end date after which this discount code can no longer be redeemed.
</ParamField>

<ParamField type="integer">
  Filter by unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer.
</ParamField>

<ParamField type="integer">
  Filter by number of ExpirationType periods after assignment until the discount expires for a customer.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date from which this discount code is visible/published to customers greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date from which this discount code is visible/published to customers less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which this discount code is visible/published to customers greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which this discount code is visible/published to customers less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fixed monetary amount to discount. Mutually exclusive with DiscountPercentage greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fixed monetary amount to discount. Mutually exclusive with DiscountPercentage less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a single customer can redeem this discount code greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a single customer can redeem this discount code less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum total number of times this discount code can be redeemed across all customers greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum total number of times this discount code can be redeemed across all customers less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by start date from which this discount code can be redeemed greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date from which this discount code can be redeemed less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date after which this discount code can no longer be redeemed greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date after which this discount code can no longer be redeemed less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of ExpirationType periods after assignment until the discount expires for a customer greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of ExpirationType periods after assignment until the discount expires for a customer less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/discountcodes?page=1&size=15&orderBy=Code&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Code',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/discountcodes',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Code',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Code

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/discountcodes?DiscountCode_Code=example-value&orderBy=Code&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes?' + new URLSearchParams({
      DiscountCode_Code: 'example-value',
      orderBy: 'Code',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/discountcodes',
      params={
          'DiscountCode_Code': 'example-value',
          'orderBy': 'Code',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/discountcodes?from_DiscountCode_UpdatedOn=2025-01-01T00:00&to_DiscountCode_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes?' + new URLSearchParams({
      from_DiscountCode_UpdatedOn: '2025-01-01T00:00',
      to_DiscountCode_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/discountcodes',
      params={
          'from_DiscountCode_UpdatedOn': '2025-01-01T00:00',
          'to_DiscountCode_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="DiscountCode[]">
  The list of DiscountCode records matching the query. See the [Get one DiscountCode](/rest-api/billing/get-discountcodes-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each DiscountCode. The following fields are **not populated** in the `Records[]` response: `PublishFrom`, `PublishTo`, `ReferralDiscount`, `DiscountPricePlans`, `DiscountBookings`, `DiscountProducts`, `DiscountEvents`, `MaxUsesPerUser`, `MaxUses`, `OnlyForContacts`, `OnlyForMembers`, `ValidTo`, `ExpirationType`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one DiscountCode](/rest-api/billing/get-discountcodes-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "Code": "",
      "Description": "",
      "Active": false,
      "DiscountPercentage": null,
      "DiscountAmount": null,
      "Tariffs": [],
      "ResourceTypes": [],
      "Products": [],
      "EventCategories": [],
      "ValidFrom": 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": "DiscountCode Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Code",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple DiscountCodes
Source: https://learn.nexudus.com/rest-api/billing/get-discountcodes-batch

GET /api/billing/discountcodes/?id=[{id1},{id2},{id3}]
Retrieve multiple DiscountCode records by their Ids in a single request.

Fetch several DiscountCode records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`DiscountCode-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of DiscountCode Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/discountcodes/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/discountcodes/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of DiscountCode records. Each record has the same structure as the response from the [Get one DiscountCode](/rest-api/billing/get-discountcodes-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each DiscountCode. The following fields are **not populated** in the response: `PublishFrom`, `PublishTo`, `ReferralDiscount`, `DiscountPricePlans`, `DiscountBookings`, `DiscountProducts`, `DiscountEvents`, `MaxUsesPerUser`, `MaxUses`, `OnlyForContacts`, `OnlyForMembers`, `ValidTo`, `ExpirationType`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one DiscountCode](/rest-api/billing/get-discountcodes-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessCurrencyCode": null,
    "Code": "",
    "Description": "",
    "Active": false,
    "DiscountPercentage": null,
    "DiscountAmount": null,
    "Tariffs": [],
    "ResourceTypes": [],
    "Products": [],
    "EventCategories": [],
    "ValidFrom": 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": "DiscountCode Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one DiscountCode
Source: https://learn.nexudus.com/rest-api/billing/get-discountcodes-by-id

GET /api/billing/discountcodes/{id}
Retrieve a single DiscountCode record by its Id.

A **DiscountCode** represents a discount registered in the system. Each discount code belongs to a `Business` (location) and defines a percentage or fixed-amount discount that can be applied to different item types: price plans (tariffs), bookings, products, and/or events.

Use the boolean flags (`DiscountPricePlans`, `DiscountBookings`, `DiscountProducts`, `DiscountEvents`) to control which item categories the discount applies to. For each enabled category, associate the specific eligible items via the corresponding ID list (e.g. `Tariffs`, `ResourceTypes`, `Products`, `EventCategories`). Use the `Added*` and `Removed*` list variants for incremental updates without replacing the full list.

A discount can specify either `DiscountPercentage` (e.g. 10 for 10% off) or `DiscountAmount` (a fixed monetary amount off), but not both.

Discount codes can be assigned to individual customers via `CoworkerDiscountCode`. Availability can be further restricted by validity dates (`ValidFrom`/`ValidTo`), publish window (`PublishFrom`/`PublishTo`), usage caps (`MaxUses`, `MaxUsesPerUser`), audience (`OnlyForContacts`, `OnlyForMembers`), and expiration rules (`ExpirationType`, `ExpiresIn`).

## Authentication

<Note>
  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 **`DiscountCode-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the DiscountCode record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/discountcodes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Name of the business (location) this discount code belongs to.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Currency code of the business (e.g. USD, EUR).
</ResponseField>

<ResponseField name="Code" type="string">
  The unique alphanumeric code customers enter to apply the discount.
</ResponseField>

<ResponseField name="Description" type="string">
  Human-readable description of what this discount code is for.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether this discount code is currently active and can be redeemed.
</ResponseField>

<ResponseField name="PublishFrom" type="string">
  Date from which this discount code is visible/published to customers.
</ResponseField>

<ResponseField name="PublishTo" type="string">
  Date until which this discount code is visible/published to customers.
</ResponseField>

<ResponseField name="DiscountPercentage" type="number">
  Percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.
</ResponseField>

<ResponseField name="ReferralDiscount" type="boolean">
  Whether this discount code is used as part of the referral program.
</ResponseField>

<ResponseField name="DiscountPricePlans" type="boolean">
  Whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="DiscountBookings" type="boolean">
  Whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.
</ResponseField>

<ResponseField name="ResourceTypes" type="integer[]">
  List of resource types linked to this record.
</ResponseField>

<ResponseField name="DiscountProducts" type="boolean">
  Whether this discount can be applied to products. When true, use Products to restrict to specific products.
</ResponseField>

<ResponseField name="Products" type="integer[]">
  List of products linked to this record.
</ResponseField>

<ResponseField name="DiscountEvents" type="boolean">
  Whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.
</ResponseField>

<ResponseField name="EventCategories" type="integer[]">
  List of event categories linked to this record.
</ResponseField>

<ResponseField name="MaxUsesPerUser" type="integer">
  Maximum number of times a single customer can redeem this discount code.
</ResponseField>

<ResponseField name="MaxUses" type="integer">
  Maximum total number of times this discount code can be redeemed across all customers.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  When true, only contacts (non-member customers) can use this discount code.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  When true, only members (customers with an active plan) can use this discount code.
</ResponseField>

<ResponseField name="ValidFrom" type="string">
  Start date from which this discount code can be redeemed.
</ResponseField>

<ResponseField name="ValidTo" type="string">
  End date after which this discount code can no longer be redeemed.
</ResponseField>

<ResponseField name="ExpirationType" type="integer">
  Unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer.
</ResponseField>

<ResponseField name="ExpiresIn" type="integer">
  Number of ExpirationType periods after assignment until the discount expires for a customer.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "Code": "",
  "Description": "",
  "Active": false,
  "PublishFrom": null,
  "PublishTo": null,
  "DiscountPercentage": null,
  "DiscountAmount": null,
  "ReferralDiscount": false,
  "DiscountPricePlans": false,
  "Tariffs": [],
  "DiscountBookings": false,
  "ResourceTypes": [],
  "DiscountProducts": false,
  "Products": [],
  "DiscountEvents": false,
  "EventCategories": [],
  "MaxUsesPerUser": null,
  "MaxUses": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "ValidFrom": null,
  "ValidTo": null,
  "ExpirationType": 0,
  "ExpiresIn": 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": "DiscountCode Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ExtraServicePrices
Source: https://learn.nexudus.com/rest-api/billing/get-extraserviceprices

GET /api/billing/extraserviceprices
Search and list ExtraServicePrice records with filtering, sorting, and pagination.

An **ExtraServicePrice** provides an overriding price for an `ExtraService` (resource price) for members on a specific `Tariff` (plan).

When a member whose active plan matches `TariffId` books a resource priced by the linked extra service, the `Price` (and optional `MaximumPrice`) from this record are used instead of the default extra service price.

In most cases it is preferred to create additional `ExtraService` records connected to the same `ResourceTypes` and restricted to specific plans via `ExtraService.Tariffs`, rather than using ExtraServicePrice overrides. Use ExtraServicePrice only when you need a simple price override without duplicating the full extra service configuration.

## Authentication

<Note>
  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 **`ExtraServicePrice-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the linked extra service.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the linked tariff.
</ParamField>

<ParamField type="number">
  Filter by overriding price charged to members on the specified tariff.
</ParamField>

<ParamField type="number">
  Filter by optional maximum price cap for time-based extra services on the specified tariff.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by overriding price charged to members on the specified tariff greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by overriding price charged to members on the specified tariff less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by optional maximum price cap for time-based extra services on the specified tariff greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by optional maximum price cap for time-based extra services on the specified tariff less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraserviceprices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraserviceprices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraserviceprices?ExtraServicePrice_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices?' + new URLSearchParams({
      ExtraServicePrice_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraserviceprices',
      params={
          'ExtraServicePrice_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraserviceprices?from_ExtraServicePrice_UpdatedOn=2025-01-01T00:00&to_ExtraServicePrice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices?' + new URLSearchParams({
      from_ExtraServicePrice_UpdatedOn: '2025-01-01T00:00',
      to_ExtraServicePrice_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraserviceprices',
      params={
          'from_ExtraServicePrice_UpdatedOn': '2025-01-01T00:00',
          'to_ExtraServicePrice_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ExtraServicePrice[]">
  The list of ExtraServicePrice records matching the query. See the [Get one ExtraServicePrice](/rest-api/billing/get-extraserviceprices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "TariffId": 0,
      "TariffName": null,
      "Price": 0,
      "MaximumPrice": 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": "ExtraServicePrice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ExtraServicePrices
Source: https://learn.nexudus.com/rest-api/billing/get-extraserviceprices-batch

GET /api/billing/extraserviceprices/?id=[{id1},{id2},{id3}]
Retrieve multiple ExtraServicePrice records by their Ids in a single request.

Fetch several ExtraServicePrice records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ExtraServicePrice-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ExtraServicePrice Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraserviceprices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraserviceprices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ExtraServicePrice records. Each record has the same structure as the response from the [Get one ExtraServicePrice](/rest-api/billing/get-extraserviceprices-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ExtraServiceId": 0,
    "ExtraServiceName": null,
    "TariffId": 0,
    "TariffName": null,
    "Price": 0,
    "MaximumPrice": 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": "ExtraServicePrice Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ExtraServicePrice
Source: https://learn.nexudus.com/rest-api/billing/get-extraserviceprices-by-id

GET /api/billing/extraserviceprices/{id}
Retrieve a single ExtraServicePrice record by its Id.

An **ExtraServicePrice** provides an overriding price for an `ExtraService` (resource price) for members on a specific `Tariff` (plan).

When a member whose active plan matches `TariffId` books a resource priced by the linked extra service, the `Price` (and optional `MaximumPrice`) from this record are used instead of the default extra service price.

In most cases it is preferred to create additional `ExtraService` records connected to the same `ResourceTypes` and restricted to specific plans via `ExtraService.Tariffs`, rather than using ExtraServicePrice overrides. Use ExtraServicePrice only when you need a simple price override without duplicating the full extra service configuration.

## Authentication

<Note>
  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 **`ExtraServicePrice-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraServicePrice record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraserviceprices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ExtraServiceId" type="integer">
  ID of the extra service linked to this record.
</ResponseField>

<ResponseField name="ExtraServiceName" type="string">
  Name of the linked extra service.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Name of the linked tariff.
</ResponseField>

<ResponseField name="Price" type="number">
  Overriding price charged to members on the specified tariff.
</ResponseField>

<ResponseField name="MaximumPrice" type="number">
  Optional maximum price cap for time-based extra services on the specified tariff.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "TariffId": 0,
  "TariffName": null,
  "Price": 0,
  "MaximumPrice": 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": "ExtraServicePrice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-extraservices

GET /api/billing/extraservices
Search and list ExtraService records with filtering, sorting, and pagination.

An **ExtraService** serves two distinct purposes:

1. **Resource-type pricing rule** — defines how one or more resource types are billed. A single resource type can have multiple extra services — for example, one per charge period (hourly, half-day, full-day) or one per customer segment.
2. **Printing credit** — when `IsPrintingCredit` is `true`, the extra service represents a printing allowance rather than booking time. In this case `ChargePeriod` must always be `5` (Uses) and `Price` should be set to `1`.

CRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates)

Restrictions available on each extra service include:

* **Charge period** — hourly, daily, etc. (`ChargePeriod`). For printing credit, always use `5` (Uses).
* **Customer type** — members only (`OnlyForMembers`) or contacts only (`OnlyForContacts`)
* **Time window** — bookings must fall within specific hours (`FromTime`, `ToTime`)
* **Booking length** — minimum/maximum duration (`MinLength`, `MaxLength`)
* **Fixed-cost slot** — charge a flat fee for bookings up to a fixed length (`FixedCostLength`, `FixedCostPrice`)
* **Dynamic pricing** — price factors for low/average/high demand and last-minute bookings
* **Date range** — apply only between specific dates (`ApplyFrom`, `ApplyTo`)

To set up pricing for a resource type, create one `ExtraService` per pricing rule and associate it with the desired resource type(s) using or the resource types assignment. The `ResourceTypeNames` field on an extra service shows which resource types it currently applies to.

To create a **printing credit** extra service, set ``IsPrintingCredit` true`, ``ChargePeriod` 5`, and \`\`Price` 1`. Resource type assignment is not required for printing credit extra services.

### Setting up hourly pricing

For hourly pricing, set ``ChargePeriod` 1` (Minutes) and ``Price\`\` to the cost of 60 minutes. The system interprets a charge period of 1 minute as hourly billing when the price represents a full hour.

Example — create a \$50/hour meeting room pricing rule:

## Authentication

<Note>
  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 **`ExtraService-List`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eLastMinuteDiscountType — LastMinuteAdjustmentType values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Disabled |
  | 2     | Fixed    |
  | 3     | Gradual  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by extra service name.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this extra service.
</ParamField>

<ParamField type="string">
  Filter by invoice line display text.
</ParamField>

<ParamField type="boolean">
  Filter by whether the price is visible on the portal and app.
</ParamField>

<ParamField type="integer">
  Filter by display order.
</ParamField>

<ParamField type="number">
  Filter by unit price amount.
</ParamField>

<ParamField type="number">
  Filter by credit price.
</ParamField>

<ParamField type="integer">
  Filter by charge period.
</ParamField>

<ParamField type="number">
  Filter by maximum price cap.
</ParamField>

<ParamField type="boolean">
  Filter by use as the default price for matched resource types if more than one price applies.
</ParamField>

<ParamField type="boolean">
  Filter by use per-night pricing.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by currency code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by start time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  Filter by end time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  Filter by minimum booking length (minutes).
</ParamField>

<ParamField type="integer">
  Filter by maximum booking length (minutes).
</ParamField>

<ParamField type="boolean">
  Filter by only apply within the resource's available times.
</ParamField>

<ParamField type="integer">
  Filter by fixed cost booking length threshold (minutes).
</ParamField>

<ParamField type="number">
  Filter by fixed cost price applied once the threshold is reached.
</ParamField>

<ParamField type="boolean">
  Filter by only available for contacts.
</ParamField>

<ParamField type="boolean">
  Filter by only available for members.
</ParamField>

<ParamField type="boolean">
  Filter by price uses booking credits.
</ParamField>

<ParamField type="boolean">
  Filter by price uses printing credits.
</ParamField>

<ParamField type="boolean">
  Filter by apply charge to visitors.
</ParamField>

<ParamField type="number">
  Filter by price factor for low demand periods.
</ParamField>

<ParamField type="number">
  Filter by price factor for average demand periods.
</ParamField>

<ParamField type="number">
  Filter by price factor for high demand periods.
</ParamField>

<ParamField type="number">
  Filter by price factor for last-minute bookings.
</ParamField>

<ParamField type="integer">
  Filter by last-minute period threshold (minutes before booking).
</ParamField>

<ParamField type="integer">
  Filter by last-minute discount type.
</ParamField>

<ParamField type="string">
  Filter by date from which this price applies.
</ParamField>

<ParamField type="string">
  Filter by date until which this price applies.
</ParamField>

<ParamField type="string">
  Filter by comma-separated names of associated resource types.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by display order greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by unit price amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by unit price amount less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by maximum price cap greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by maximum price cap less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by start time restriction (minutes from midnight) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by start time restriction (minutes from midnight) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by end time restriction (minutes from midnight) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by end time restriction (minutes from midnight) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minimum booking length (minutes) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minimum booking length (minutes) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking length (minutes) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking length (minutes) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by fixed cost booking length threshold (minutes) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by fixed cost booking length threshold (minutes) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fixed cost price applied once the threshold is reached greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fixed cost price applied once the threshold is reached less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for low demand periods greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for low demand periods less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for average demand periods greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for average demand periods less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for high demand periods greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for high demand periods less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for last-minute bookings greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price factor for last-minute bookings less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by last-minute period threshold (minutes before booking) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by last-minute period threshold (minutes before booking) less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date from which this price applies greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date from which this price applies less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which this price applies greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which this price applies less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?ExtraService_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      ExtraService_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'ExtraService_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices?from_ExtraService_UpdatedOn=2025-01-01T00:00&to_ExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices?' + new URLSearchParams({
      from_ExtraService_UpdatedOn: '2025-01-01T00:00',
      to_ExtraService_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices',
      params={
          'from_ExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_ExtraService_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ExtraService[]">
  The list of ExtraService records matching the query. See the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ExtraService. The following fields are **not populated** in the `Records[]` response: `Description`, `Visible`, `DisplayOrder`, `CreditPrice`, `FromTime`, `ToTime`, `MinLength`, `MaxLength`, `OnlyWithinAvailableTimes`, `FixedCostLength`, `FixedCostPrice`, `IsBookingCredit`, `IsPrintingCredit`, `ApplyChargeToVisitors`.

  To get all fields, fetch the full record using the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "InvoiceLineDisplayAs": null,
      "ResourceTypes": [],
      "Price": 0,
      "ChargePeriod": 0,
      "MaximumPrice": null,
      "IsDefaultPrice": false,
      "UsePerNightPricing": false,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "Tariffs": [],
      "OnlyForContacts": false,
      "OnlyForMembers": false,
      "PriceFactorLowDemand": null,
      "PriceFactorAverageDemand": null,
      "PriceFactorHighDemand": null,
      "PriceFactorLastMinute": null,
      "LastMinutePeriodMinutes": null,
      "LastMinuteAdjustmentType": 0,
      "ApplyFrom": null,
      "ApplyTo": null,
      "ResourceTypeNames": null,
      "Teams": [],
      "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": "ExtraService Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-extraservices-batch

GET /api/billing/extraservices/?id=[{id1},{id2},{id3}]
Retrieve multiple ExtraService records by their Ids in a single request.

Fetch several ExtraService records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ExtraService-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ExtraService Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ExtraService records. Each record has the same structure as the response from the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ExtraService. The following fields are **not populated** in the response: `Description`, `Visible`, `DisplayOrder`, `CreditPrice`, `FromTime`, `ToTime`, `MinLength`, `MaxLength`, `OnlyWithinAvailableTimes`, `FixedCostLength`, `FixedCostPrice`, `IsBookingCredit`, `IsPrintingCredit`, `ApplyChargeToVisitors`.

  To get all fields, fetch the full record using the [Get one ExtraService](/rest-api/billing/get-extraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "InvoiceLineDisplayAs": null,
    "ResourceTypes": [],
    "Price": 0,
    "ChargePeriod": 0,
    "MaximumPrice": null,
    "IsDefaultPrice": false,
    "UsePerNightPricing": false,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxRateId": null,
    "ReducedTaxRateId": null,
    "ExemptTaxRateId": null,
    "FinancialAccountId": null,
    "Tariffs": [],
    "OnlyForContacts": false,
    "OnlyForMembers": false,
    "PriceFactorLowDemand": null,
    "PriceFactorAverageDemand": null,
    "PriceFactorHighDemand": null,
    "PriceFactorLastMinute": null,
    "LastMinutePeriodMinutes": null,
    "LastMinuteAdjustmentType": 0,
    "ApplyFrom": null,
    "ApplyTo": null,
    "ResourceTypeNames": null,
    "Teams": [],
    "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": "ExtraService Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ExtraService
Source: https://learn.nexudus.com/rest-api/billing/get-extraservices-by-id

GET /api/billing/extraservices/{id}
Retrieve a single ExtraService record by its Id.

An **ExtraService** serves two distinct purposes:

1. **Resource-type pricing rule** — defines how one or more resource types are billed. A single resource type can have multiple extra services — for example, one per charge period (hourly, half-day, full-day) or one per customer segment.
2. **Printing credit** — when `IsPrintingCredit` is `true`, the extra service represents a printing allowance rather than booking time. In this case `ChargePeriod` must always be `5` (Uses) and `Price` should be set to `1`.

CRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates)

Restrictions available on each extra service include:

* **Charge period** — hourly, daily, etc. (`ChargePeriod`). For printing credit, always use `5` (Uses).
* **Customer type** — members only (`OnlyForMembers`) or contacts only (`OnlyForContacts`)
* **Time window** — bookings must fall within specific hours (`FromTime`, `ToTime`)
* **Booking length** — minimum/maximum duration (`MinLength`, `MaxLength`)
* **Fixed-cost slot** — charge a flat fee for bookings up to a fixed length (`FixedCostLength`, `FixedCostPrice`)
* **Dynamic pricing** — price factors for low/average/high demand and last-minute bookings
* **Date range** — apply only between specific dates (`ApplyFrom`, `ApplyTo`)

To set up pricing for a resource type, create one `ExtraService` per pricing rule and associate it with the desired resource type(s) using or the resource types assignment. The `ResourceTypeNames` field on an extra service shows which resource types it currently applies to.

To create a **printing credit** extra service, set ``IsPrintingCredit` true`, ``ChargePeriod` 5`, and \`\`Price` 1`. Resource type assignment is not required for printing credit extra services.

### Setting up hourly pricing

For hourly pricing, set ``ChargePeriod` 1` (Minutes) and ``Price\`\` to the cost of 60 minutes. The system interprets a charge period of 1 minute as hourly billing when the price represents a full hour.

Example — create a \$50/hour meeting room pricing rule:

## Authentication

<Note>
  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 **`ExtraService-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraService record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Extra service name.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this extra service.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Invoice line display text.
</ResponseField>

<ResponseField name="Visible" type="boolean">
  Whether the price is visible on the portal and app.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Display order.
</ResponseField>

<ResponseField name="ResourceTypes" type="integer[]">
  List of resource types linked to this record.
</ResponseField>

<ResponseField name="Price" type="number">
  Unit price amount.
</ResponseField>

<ResponseField name="CreditPrice" type="number">
  Credit price.
</ResponseField>

<ResponseField name="ChargePeriod" type="integer">
  Charge period. See `eChargePeriod` enum values: `1` = Minutes, `2` = Days, `3` = Weeks, `4` = Months, `5` = Uses, `6` = FourWeekMonths.
</ResponseField>

<ResponseField name="MaximumPrice" type="number">
  Maximum price cap.
</ResponseField>

<ResponseField name="IsDefaultPrice" type="boolean">
  Use as the default price for matched resource types if more than one price applies.
</ResponseField>

<ResponseField name="UsePerNightPricing" type="boolean">
  Use per-night pricing.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  Currency code.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  ID of the tax rate linked to this record.
</ResponseField>

<ResponseField name="ReducedTaxRateId" type="integer">
  ID of the reduced tax rate linked to this record.
</ResponseField>

<ResponseField name="ExemptTaxRateId" type="integer">
  ID of the exempt tax rate linked to this record.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  ID of the financial account linked to this record.
</ResponseField>

<ResponseField name="FromTime" type="integer">
  Start time restriction (minutes from midnight).
</ResponseField>

<ResponseField name="ToTime" type="integer">
  End time restriction (minutes from midnight).
</ResponseField>

<ResponseField name="MinLength" type="integer">
  Minimum booking length (minutes).
</ResponseField>

<ResponseField name="MaxLength" type="integer">
  Maximum booking length (minutes).
</ResponseField>

<ResponseField name="OnlyWithinAvailableTimes" type="boolean">
  Only apply within the resource's available times.
</ResponseField>

<ResponseField name="FixedCostLength" type="integer">
  Fixed cost booking length threshold (minutes).
</ResponseField>

<ResponseField name="FixedCostPrice" type="number">
  Fixed cost price applied once the threshold is reached.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Only available for contacts.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Only available for members.
</ResponseField>

<ResponseField name="IsBookingCredit" type="boolean">
  Price uses booking credits.
</ResponseField>

<ResponseField name="IsPrintingCredit" type="boolean">
  Price uses printing credits.
</ResponseField>

<ResponseField name="ApplyChargeToVisitors" type="boolean">
  Apply charge to visitors.
</ResponseField>

<ResponseField name="PriceFactorLowDemand" type="number">
  Price factor for low demand periods.
</ResponseField>

<ResponseField name="PriceFactorAverageDemand" type="number">
  Price factor for average demand periods.
</ResponseField>

<ResponseField name="PriceFactorHighDemand" type="number">
  Price factor for high demand periods.
</ResponseField>

<ResponseField name="PriceFactorLastMinute" type="number">
  Price factor for last-minute bookings.
</ResponseField>

<ResponseField name="LastMinutePeriodMinutes" type="integer">
  Last-minute period threshold (minutes before booking).
</ResponseField>

<ResponseField name="LastMinuteAdjustmentType" type="integer">
  Last-minute discount type. See `eLastMinuteDiscountType` enum values: `1` = Disabled, `2` = Fixed, `3` = Gradual.
</ResponseField>

<ResponseField name="ApplyFrom" type="string">
  Date from which this price applies.
</ResponseField>

<ResponseField name="ApplyTo" type="string">
  Date until which this price applies.
</ResponseField>

<ResponseField name="ResourceTypeNames" type="string">
  Comma-separated names of associated resource types.
</ResponseField>

<ResponseField name="Teams" type="integer[]">
  List of teams linked to this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "InvoiceLineDisplayAs": null,
  "Visible": false,
  "DisplayOrder": 0,
  "ResourceTypes": [],
  "Price": 0,
  "CreditPrice": null,
  "ChargePeriod": 0,
  "MaximumPrice": null,
  "IsDefaultPrice": false,
  "UsePerNightPricing": false,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "FromTime": null,
  "ToTime": null,
  "MinLength": null,
  "MaxLength": null,
  "OnlyWithinAvailableTimes": false,
  "FixedCostLength": null,
  "FixedCostPrice": null,
  "Tariffs": [],
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "IsBookingCredit": false,
  "IsPrintingCredit": false,
  "ApplyChargeToVisitors": false,
  "PriceFactorLowDemand": null,
  "PriceFactorAverageDemand": null,
  "PriceFactorHighDemand": null,
  "PriceFactorLastMinute": null,
  "LastMinutePeriodMinutes": null,
  "LastMinuteAdjustmentType": 0,
  "ApplyFrom": null,
  "ApplyTo": null,
  "ResourceTypeNames": null,
  "Teams": [],
  "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": "ExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ExtraServiceTimeSlots
Source: https://learn.nexudus.com/rest-api/billing/get-extraservicetimeslots

GET /api/billing/extraservicetimeslots
Search and list ExtraServiceTimeSlot records with filtering, sorting, and pagination.

An **ExtraServiceTimeSlot** defines the days and times during which an `ExtraService` (resource pricing rule) is available for booking. Each time slot specifies a day of the week and a from/to time window.

The year, month, and day components of `FromTime` and `ToTime` are always `1976-01-01` — only the time-of-day portion is meaningful.

When no time slots are defined for an extra service, the price applies at all times. Adding time slots restricts the price to the specified windows only.

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-List`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Filter by start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="string">
  Filter by end time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="integer">
  Filter by the day of week value for this extra service time slot.
</ParamField>

<ParamField type="boolean">
  Filter by whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots?ExtraServiceTimeSlot_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots?' + new URLSearchParams({
      ExtraServiceTimeSlot_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
      params={
          'ExtraServiceTimeSlot_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots?from_ExtraServiceTimeSlot_UpdatedOn=2025-01-01T00:00&to_ExtraServiceTimeSlot_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots?' + new URLSearchParams({
      from_ExtraServiceTimeSlot_UpdatedOn: '2025-01-01T00:00',
      to_ExtraServiceTimeSlot_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
      params={
          'from_ExtraServiceTimeSlot_UpdatedOn': '2025-01-01T00:00',
          'to_ExtraServiceTimeSlot_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ExtraServiceTimeSlot[]">
  The list of ExtraServiceTimeSlot records matching the query. See the [Get one ExtraServiceTimeSlot](/rest-api/billing/get-extraservicetimeslots-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ExtraServiceId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0,
      "Available": 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": "ExtraServiceTimeSlot Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ExtraServiceTimeSlots
Source: https://learn.nexudus.com/rest-api/billing/get-extraservicetimeslots-batch

GET /api/billing/extraservicetimeslots/?id=[{id1},{id2},{id3}]
Retrieve multiple ExtraServiceTimeSlot records by their Ids in a single request.

Fetch several ExtraServiceTimeSlot records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ExtraServiceTimeSlot Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ExtraServiceTimeSlot records. Each record has the same structure as the response from the [Get one ExtraServiceTimeSlot](/rest-api/billing/get-extraservicetimeslots-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ExtraServiceId": 0,
    "FromTime": "2025-01-15T10:30:00Z",
    "ToTime": "2025-01-15T10:30:00Z",
    "DayOfWeek": 0,
    "Available": 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": "ExtraServiceTimeSlot Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ExtraServiceTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/get-extraservicetimeslots-by-id

GET /api/billing/extraservicetimeslots/{id}
Retrieve a single ExtraServiceTimeSlot record by its Id.

An **ExtraServiceTimeSlot** defines the days and times during which an `ExtraService` (resource pricing rule) is available for booking. Each time slot specifies a day of the week and a from/to time window.

The year, month, and day components of `FromTime` and `ToTime` are always `1976-01-01` — only the time-of-day portion is meaningful.

When no time slots are defined for an extra service, the price applies at all times. Adding time slots restricts the price to the specified windows only.

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ExtraServiceTimeSlot record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ExtraServiceId" type="integer">
  ID of the extra service linked to this record.
</ResponseField>

<ResponseField name="FromTime" type="string">
  Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ResponseField>

<ResponseField name="ToTime" type="string">
  End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ResponseField>

<ResponseField name="DayOfWeek" type="integer">
  The day of week value for this extra service time slot. See `DayOfWeek` enum values: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday.
</ResponseField>

<ResponseField name="Available" type="boolean">
  Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ExtraServiceId": 0,
  "FromTime": "2025-01-15T10:30:00Z",
  "ToTime": "2025-01-15T10:30:00Z",
  "DayOfWeek": 0,
  "Available": 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": "ExtraServiceTimeSlot Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search FinancialAccounts
Source: https://learn.nexudus.com/rest-api/billing/get-financialaccounts

GET /api/billing/financialaccounts
Search and list FinancialAccount records with filtering, sorting, and pagination.

A **FinancialAccount** represents a bookkeeping account used for categorising revenue and payments.

Financial accounts can be assigned to Products, EventProducts, TimePasses, ExtraServices (resource prices), Tariffs and Charges to control how income is tracked and reported.

Each account has a `Code` (typically matching an external accounting system reference), a `Name`, and an `AccountType` that determines where it appears:

| AccountType | Value | Purpose                                      |
| ----------- | ----- | -------------------------------------------- |
| Sales       | 1     | Revenue from products, services and bookings |
| Payments    | 2     | Incoming payment receipts                    |
| Deposits    | 3     | Security deposits held against contracts     |

**Important:** Changing a financial account's details or reassigning it to different items has no effect on existing invoices. The financial account recorded on each invoice line is captured at the time the invoice is issued and is never updated retroactively.

## Authentication

<Note>
  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 **`FinancialAccount-List`** role.
</Note>

## Enums

<Accordion title="eFinancialAccountType — AccountType values">
  | Value | Name     |
  | ----- | -------- |
  | 0     | None     |
  | 1     | Sales    |
  | 2     | Payments |
  | 3     | Deposits |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name for this financial account.
</ParamField>

<ParamField type="string">
  Filter by short reference code, typically matching the account code in an external accounting system.
</ParamField>

<ParamField type="string">
  Filter by optional free-text description of the account's purpose.
</ParamField>

<ParamField type="integer">
  Filter by category of the account: Sales (1), Payments (2) or Deposits (3).
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/financialaccounts?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/financialaccounts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/financialaccounts?FinancialAccount_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts?' + new URLSearchParams({
      FinancialAccount_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/financialaccounts',
      params={
          'FinancialAccount_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/financialaccounts?from_FinancialAccount_UpdatedOn=2025-01-01T00:00&to_FinancialAccount_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts?' + new URLSearchParams({
      from_FinancialAccount_UpdatedOn: '2025-01-01T00:00',
      to_FinancialAccount_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/financialaccounts',
      params={
          'from_FinancialAccount_UpdatedOn': '2025-01-01T00:00',
          'to_FinancialAccount_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="FinancialAccount[]">
  The list of FinancialAccount records matching the query. See the [Get one FinancialAccount](/rest-api/billing/get-financialaccounts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Code": "",
      "Description": null,
      "AccountType": 0,
      "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": "FinancialAccount Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple FinancialAccounts
Source: https://learn.nexudus.com/rest-api/billing/get-financialaccounts-batch

GET /api/billing/financialaccounts/?id=[{id1},{id2},{id3}]
Retrieve multiple FinancialAccount records by their Ids in a single request.

Fetch several FinancialAccount records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`FinancialAccount-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of FinancialAccount Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/financialaccounts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/financialaccounts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of FinancialAccount records. Each record has the same structure as the response from the [Get one FinancialAccount](/rest-api/billing/get-financialaccounts-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "Code": "",
    "Description": null,
    "AccountType": 0,
    "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": "FinancialAccount Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one FinancialAccount
Source: https://learn.nexudus.com/rest-api/billing/get-financialaccounts-by-id

GET /api/billing/financialaccounts/{id}
Retrieve a single FinancialAccount record by its Id.

A **FinancialAccount** represents a bookkeeping account used for categorising revenue and payments.

Financial accounts can be assigned to Products, EventProducts, TimePasses, ExtraServices (resource prices), Tariffs and Charges to control how income is tracked and reported.

Each account has a `Code` (typically matching an external accounting system reference), a `Name`, and an `AccountType` that determines where it appears:

| AccountType | Value | Purpose                                      |
| ----------- | ----- | -------------------------------------------- |
| Sales       | 1     | Revenue from products, services and bookings |
| Payments    | 2     | Incoming payment receipts                    |
| Deposits    | 3     | Security deposits held against contracts     |

**Important:** Changing a financial account's details or reassigning it to different items has no effect on existing invoices. The financial account recorded on each invoice line is captured at the time the invoice is issued and is never updated retroactively.

## Authentication

<Note>
  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 **`FinancialAccount-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FinancialAccount record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/financialaccounts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name for this financial account.
</ResponseField>

<ResponseField name="Code" type="string">
  Short reference code, typically matching the account code in an external accounting system.
</ResponseField>

<ResponseField name="Description" type="string">
  Optional free-text description of the account's purpose.
</ResponseField>

<ResponseField name="AccountType" type="integer">
  Category of the account: Sales (1), Payments (2) or Deposits (3). See `eFinancialAccountType` enum values: `0` = None, `1` = Sales, `2` = Payments, `3` = Deposits.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Code": "",
  "Description": null,
  "AccountType": 0,
  "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": "FinancialAccount Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Invoices
Source: https://learn.nexudus.com/rest-api/billing/get-invoices

GET /api/billing/invoices
Search and list Invoice records with filtering, sorting, and pagination.

An **Invoice** represents a bill issued by Nexudus to the operator (the business running the coworking space). Invoices are generated automatically by the billing engine or can be created manually via the API.

Each invoice captures a snapshot of the billing details at issuance time — bill-to address, currency, tax amounts, and line items. Once issued, the invoice record is immutable with respect to these captured values; changes to the underlying financial accounts, products or customer details do not retroactively update existing invoices.

Invoices support `list`, `get`, and `create` operations. They cannot be updated or deleted through the API.

## Authentication

<Note>
  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 **`Invoice-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by unique sequential invoice number assigned at issuance (e.g. INV-00042).
</ParamField>

<ParamField type="string">
  Filter by name of the person or organisation being billed, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by billing street address, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by billing city, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by billing postal/ZIP code, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by billing phone number, captured at invoice time.
</ParamField>

<ParamField type="string">
  Filter by billing fax number, captured at invoice time.
</ParamField>

<ParamField type="integer">
  Filter by iD of the bill to country linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the billing country (read-only, resolved from BillToCountryId).
</ParamField>

<ParamField type="string">
  Filter by free-text description or notes for this invoice.
</ParamField>

<ParamField type="number">
  Filter by total discount applied to the invoice, in the invoice currency.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is expected.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice.
</ParamField>

<ParamField type="number">
  Filter by portion of the total that corresponds to recurring subscription charges.
</ParamField>

<ParamField type="number">
  Filter by portion of the total attributed to the reseller (partner) channel.
</ParamField>

<ParamField type="number">
  Filter by grand total of the invoice including all line items, taxes, and discounts.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by iSO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.
</ParamField>

<ParamField type="number">
  Filter by total tax amount calculated for the invoice.
</ParamField>

<ParamField type="boolean">
  Filter by whether the invoice has been fully paid.
</ParamField>

<ParamField type="string">
  Filter by date and time when full payment was recorded.
</ParamField>

<ParamField type="string">
  Filter by arbitrary JSON or text blob for storing integration-specific metadata.
</ParamField>

<ParamField type="integer">
  Filter by number of automatic payment collection attempts made for this invoice.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by total discount applied to the invoice, in the invoice currency greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total discount applied to the invoice, in the invoice currency less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is expected greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date by which payment is expected less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date of the billing period covered by this invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end date of the billing period covered by this invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="number">
  Filter by portion of the total that corresponds to recurring subscription charges greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by portion of the total that corresponds to recurring subscription charges less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by portion of the total attributed to the reseller (partner) channel greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by portion of the total attributed to the reseller (partner) channel less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by grand total of the invoice including all line items, taxes, and discounts greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by grand total of the invoice including all line items, taxes, and discounts less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total tax amount calculated for the invoice greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by total tax amount calculated for the invoice less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date and time when full payment was recorded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when full payment was recorded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of automatic payment collection attempts made for this invoice greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of automatic payment collection attempts made for this invoice less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/invoices?page=1&size=15&orderBy=InvoiceNumber&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'InvoiceNumber',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/invoices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'InvoiceNumber',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by InvoiceNumber

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/invoices?Invoice_InvoiceNumber=example-value&orderBy=InvoiceNumber&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
      Invoice_InvoiceNumber: 'example-value',
      orderBy: 'InvoiceNumber',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/invoices',
      params={
          'Invoice_InvoiceNumber': 'example-value',
          'orderBy': 'InvoiceNumber',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/invoices?from_Invoice_UpdatedOn=2025-01-01T00:00&to_Invoice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices?' + new URLSearchParams({
      from_Invoice_UpdatedOn: '2025-01-01T00:00',
      to_Invoice_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/invoices',
      params={
          'from_Invoice_UpdatedOn': '2025-01-01T00:00',
          'to_Invoice_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Invoice[]">
  The list of Invoice records matching the query. See the [Get one Invoice](/rest-api/billing/get-invoices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Invoice. The following fields are **not populated** in the `Records[]` response: `BillToAddress`, `BillToCity`, `BillToTaxIDNumber`, `BillToPostCode`, `BillToPhone`, `BillToFax`.

  To get all fields, fetch the full record using the [Get one Invoice](/rest-api/billing/get-invoices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "InvoiceNumber": "",
      "BillToName": "",
      "BillToCountryId": 0,
      "BillToCountryName": null,
      "Description": null,
      "DiscountAmount": 0,
      "DueDate": null,
      "InvoiceFromDate": null,
      "InvoiceToDate": null,
      "SubscriptionAmount": 0,
      "ResellerAmount": 0,
      "TotalAmount": 0,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxAmount": 0,
      "Paid": false,
      "PaidOn": null,
      "CustomData": null,
      "PaymentAttemptsCount": 0,
      "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": "Invoice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "InvoiceNumber",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Invoices
Source: https://learn.nexudus.com/rest-api/billing/get-invoices-batch

GET /api/billing/invoices/?id=[{id1},{id2},{id3}]
Retrieve multiple Invoice records by their Ids in a single request.

Fetch several Invoice records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Invoice-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Invoice Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/invoices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/invoices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Invoice records. Each record has the same structure as the response from the [Get one Invoice](/rest-api/billing/get-invoices-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Invoice. The following fields are **not populated** in the response: `BillToAddress`, `BillToCity`, `BillToTaxIDNumber`, `BillToPostCode`, `BillToPhone`, `BillToFax`.

  To get all fields, fetch the full record using the [Get one Invoice](/rest-api/billing/get-invoices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "InvoiceNumber": "",
    "BillToName": "",
    "BillToCountryId": 0,
    "BillToCountryName": null,
    "Description": null,
    "DiscountAmount": 0,
    "DueDate": null,
    "InvoiceFromDate": null,
    "InvoiceToDate": null,
    "SubscriptionAmount": 0,
    "ResellerAmount": 0,
    "TotalAmount": 0,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxAmount": 0,
    "Paid": false,
    "PaidOn": null,
    "CustomData": null,
    "PaymentAttemptsCount": 0,
    "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": "Invoice Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Invoice
Source: https://learn.nexudus.com/rest-api/billing/get-invoices-by-id

GET /api/billing/invoices/{id}
Retrieve a single Invoice record by its Id.

An **Invoice** represents a bill issued by Nexudus to the operator (the business running the coworking space). Invoices are generated automatically by the billing engine or can be created manually via the API.

Each invoice captures a snapshot of the billing details at issuance time — bill-to address, currency, tax amounts, and line items. Once issued, the invoice record is immutable with respect to these captured values; changes to the underlying financial accounts, products or customer details do not retroactively update existing invoices.

Invoices support `list`, `get`, and `create` operations. They cannot be updated or deleted through the API.

## Authentication

<Note>
  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 **`Invoice-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Invoice record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/invoices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="InvoiceNumber" type="string">
  Unique sequential invoice number assigned at issuance (e.g. INV-00042).
</ResponseField>

<ResponseField name="BillToName" type="string">
  Name of the person or organisation being billed, captured at invoice time.
</ResponseField>

<ResponseField name="BillToAddress" type="string">
  Billing street address, captured at invoice time.
</ResponseField>

<ResponseField name="BillToCity" type="string">
  Billing city, captured at invoice time.
</ResponseField>

<ResponseField name="BillToTaxIDNumber" type="string">
  Tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
</ResponseField>

<ResponseField name="BillToPostCode" type="string">
  Billing postal/ZIP code, captured at invoice time.
</ResponseField>

<ResponseField name="BillToPhone" type="string">
  Billing phone number, captured at invoice time.
</ResponseField>

<ResponseField name="BillToFax" type="string">
  Billing fax number, captured at invoice time.
</ResponseField>

<ResponseField name="BillToCountryId" type="integer">
  ID of the bill to country linked to this record.
</ResponseField>

<ResponseField name="BillToCountryName" type="string">
  Display name of the billing country (read-only, resolved from BillToCountryId).
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description or notes for this invoice.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Total discount applied to the invoice, in the invoice currency.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Date by which payment is expected.
</ResponseField>

<ResponseField name="InvoiceFromDate" type="string">
  Start date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="InvoiceToDate" type="string">
  End date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="SubscriptionAmount" type="number">
  Portion of the total that corresponds to recurring subscription charges.
</ResponseField>

<ResponseField name="ResellerAmount" type="number">
  Portion of the total attributed to the reseller (partner) channel.
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Grand total of the invoice including all line items, taxes, and discounts.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  ISO 4217 currency code (e.g. USD, EUR), resolved from CurrencyId.
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Total tax amount calculated for the invoice.
</ResponseField>

<ResponseField name="Paid" type="boolean">
  Whether the invoice has been fully paid.
</ResponseField>

<ResponseField name="PaidOn" type="string">
  Date and time when full payment was recorded.
</ResponseField>

<ResponseField name="CustomData" type="string">
  Arbitrary JSON or text blob for storing integration-specific metadata.
</ResponseField>

<ResponseField name="PaymentAttemptsCount" type="integer">
  Number of automatic payment collection attempts made for this invoice.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "InvoiceNumber": "",
  "BillToName": "",
  "BillToAddress": "",
  "BillToCity": "",
  "BillToTaxIDNumber": null,
  "BillToPostCode": "",
  "BillToPhone": null,
  "BillToFax": null,
  "BillToCountryId": 0,
  "BillToCountryName": null,
  "Description": null,
  "DiscountAmount": 0,
  "DueDate": null,
  "InvoiceFromDate": null,
  "InvoiceToDate": null,
  "SubscriptionAmount": 0,
  "ResellerAmount": 0,
  "TotalAmount": 0,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxAmount": 0,
  "Paid": false,
  "PaidOn": null,
  "CustomData": null,
  "PaymentAttemptsCount": 0,
  "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": "Invoice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search LedgerEntries
Source: https://learn.nexudus.com/rest-api/billing/get-ledgerentries

GET /api/billing/ledgerentries
Search and list LedgerEntry records with filtering, sorting, and pagination.

A **LedgerEntry** is a credit or debit record in the financial ledger for invoices issued by Nexudus to the operator (the business running the coworking space).

Each entry records either a debit or a credit against a location. Entries are identified by an optional `Code` for grouping or reconciliation and a free-text `Description` explaining the transaction.

## Authentication

<Note>
  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 **`LedgerEntry-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by short reference code for grouping or reconciliation (e.g. an external accounting reference).
</ParamField>

<ParamField type="string">
  Filter by free-text description explaining the purpose of this ledger entry.
</ParamField>

<ParamField type="number">
  Filter by debit amount in the location's default currency. Use 0 if this entry is a credit-only record.
</ParamField>

<ParamField type="number">
  Filter by credit amount in the location's default currency. Use 0 if this entry is a debit-only record.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by debit amount in the location's default currency. Use 0 if this entry is a credit-only record greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by debit amount in the location's default currency. Use 0 if this entry is a credit-only record less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount in the location's default currency. Use 0 if this entry is a debit-only record greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount in the location's default currency. Use 0 if this entry is a debit-only record less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by account balance after this transaction. Read-only less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/ledgerentries?page=1&size=15&orderBy=Code&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Code',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/ledgerentries',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Code',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Code

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/ledgerentries?LedgerEntry_Code=example-value&orderBy=Code&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
      LedgerEntry_Code: 'example-value',
      orderBy: 'Code',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/ledgerentries',
      params={
          'LedgerEntry_Code': 'example-value',
          'orderBy': 'Code',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/ledgerentries?from_LedgerEntry_UpdatedOn=2025-01-01T00:00&to_LedgerEntry_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
      from_LedgerEntry_UpdatedOn: '2025-01-01T00:00',
      to_LedgerEntry_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/ledgerentries',
      params={
          'from_LedgerEntry_UpdatedOn': '2025-01-01T00:00',
          'to_LedgerEntry_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="LedgerEntry[]">
  The list of LedgerEntry records matching the query. See the [Get one LedgerEntry](/rest-api/billing/get-ledgerentries-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Code": "",
      "Description": "",
      "Debit": 0,
      "Credit": 0,
      "Balance": 0,
      "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": "LedgerEntry Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Code",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple LedgerEntries
Source: https://learn.nexudus.com/rest-api/billing/get-ledgerentries-batch

GET /api/billing/ledgerentries/?id=[{id1},{id2},{id3}]
Retrieve multiple LedgerEntry records by their Ids in a single request.

Fetch several LedgerEntry records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`LedgerEntry-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of LedgerEntry Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/ledgerentries/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/ledgerentries/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/ledgerentries/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of LedgerEntry records. Each record has the same structure as the response from the [Get one LedgerEntry](/rest-api/billing/get-ledgerentries-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Code": "",
    "Description": "",
    "Debit": 0,
    "Credit": 0,
    "Balance": 0,
    "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": "LedgerEntry Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one LedgerEntry
Source: https://learn.nexudus.com/rest-api/billing/get-ledgerentries-by-id

GET /api/billing/ledgerentries/{id}
Retrieve a single LedgerEntry record by its Id.

A **LedgerEntry** is a credit or debit record in the financial ledger for invoices issued by Nexudus to the operator (the business running the coworking space).

Each entry records either a debit or a credit against a location. Entries are identified by an optional `Code` for grouping or reconciliation and a free-text `Description` explaining the transaction.

## Authentication

<Note>
  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 **`LedgerEntry-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the LedgerEntry record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/ledgerentries/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/ledgerentries/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Code" type="string">
  Short reference code for grouping or reconciliation (e.g. an external accounting reference).
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description explaining the purpose of this ledger entry.
</ResponseField>

<ResponseField name="Debit" type="number">
  Debit amount in the location's default currency. Use 0 if this entry is a credit-only record.
</ResponseField>

<ResponseField name="Credit" type="number">
  Credit amount in the location's default currency. Use 0 if this entry is a debit-only record.
</ResponseField>

<ResponseField name="Balance" type="number">
  Account balance after this transaction. Read-only.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Code": "",
  "Description": "",
  "Debit": 0,
  "Credit": 0,
  "Balance": 0,
  "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": "LedgerEntry Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search PaymentGateways
Source: https://learn.nexudus.com/rest-api/billing/get-paymentgateways

GET /api/billing/paymentgateways
Search and list PaymentGateway records with filtering, sorting, and pagination.

A **PaymentGateway** represents a connection to one of the supported payment gateways used to process card payments.

Each gateway can be associated to one or more locations (`Business` entity) via the `DefaultPaymentGatewayId` property on the business. A gateway is configured with a specific `PaymentGatewayType` (e.g. `stripe`, `braintree`, `adyen`) and the corresponding credentials (`AccessToken`, `ConfigurationXml`).

An optional `TransactionFee` can be set to track per-transaction costs, and a `FinancialAccountId` and `TaxRateId` can be linked for accounting purposes.

## Authentication

<Note>
  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 **`PaymentGateway-List`** role.
</Note>

## Enums

<Accordion title="ePaymentGatewayType — PaymentGatewayType values">
  | Value | Name                               |
  | ----- | ---------------------------------- |
  | 0     | None                               |
  | 1     | test                               |
  | 2     | authorize\_net                     |
  | 3     | beanstream                         |
  | 4     | braintree                          |
  | 6     | first\_data\_e4                    |
  | 7     | jetpay\_v2                         |
  | 8     | merchant\_e\_solutions             |
  | 9     | netbilling                         |
  | 10    | payment\_express                   |
  | 12    | sage                               |
  | 13    | stripe                             |
  | 14    | trans\_first                       |
  | 15    | usa\_epay                          |
  | 17    | blue\_pay                          |
  | 18    | cyber\_source                      |
  | 19    | elavon                             |
  | 20    | first\_data\_e4\_v27               |
  | 21    | litle                              |
  | 22    | mercury                            |
  | 23    | nmi                                |
  | 24    | payflow\_pro                       |
  | 25    | quantum                            |
  | 26    | secure\_net                        |
  | 27    | trust\_commerce                    |
  | 28    | worldpay                           |
  | 29    | wirecard                           |
  | 30    | paymill                            |
  | 31    | merchant\_warrior                  |
  | 32    | nab\_transact                      |
  | 33    | secure\_pay\_au                    |
  | 34    | eway                               |
  | 35    | migs                               |
  | 36    | pin                                |
  | 37    | ogone                              |
  | 38    | realex                             |
  | 39    | moneris                            |
  | 40    | psi\_gate                          |
  | 41    | epay                               |
  | 42    | hdfc                               |
  | 43    | net\_pay                           |
  | 44    | redsys                             |
  | 45    | iridium                            |
  | 46    | barclays\_epdq\_extra\_plus        |
  | 49    | paypal                             |
  | 50    | payex                              |
  | 51    | openpay                            |
  | 52    | hps                                |
  | 53    | checkout                           |
  | 54    | checkout\_v2                       |
  | 55    | worldpay\_us                       |
  | 56    | conekta                            |
  | 57    | orbital                            |
  | 59    | barclaycard\_smartpay              |
  | 60    | trans\_first\_transaction\_express |
  | 63    | forte                              |
  | 65    | citrus\_pay                        |
  | 66    | payu\_latam                        |
  | 67    | global\_collect                    |
  | 68    | cayan                              |
  | 69    | clearhaus                          |
  | 70    | sage\_pay                          |
  | 71    | safe\_charge                       |
  | 72    | mercado\_pago                      |
  | 73    | payeezy                            |
  | 200   | acapture                           |
  | 201   | adyen                              |
  | 203   | banco\_sabadell                    |
  | 208   | blue\_snap                         |
  | 209   | borgun                             |
  | 210   | bpoint                             |
  | 212   | bridge\_pay                        |
  | 213   | card\_connect                      |
  | 214   | card\_stream                       |
  | 215   | cardprocess                        |
  | 217   | cecabank                           |
  | 218   | cenpos                             |
  | 224   | creditcall                         |
  | 225   | credorax                           |
  | 226   | ct\_payment                        |
  | 227   | culqi                              |
  | 229   | data\_cash                         |
  | 230   | diamond\_mind                      |
  | 231   | dibs                               |
  | 232   | digitzs                            |
  | 234   | element                            |
  | 237   | eway\_rapid                        |
  | 238   | ezic                               |
  | 239   | fat\_zebra                         |
  | 242   | first\_giving                      |
  | 243   | first\_pay                         |
  | 244   | flo2cash                           |
  | 245   | flo2cash\_simple                   |
  | 247   | global                             |
  | 249   | global\_iris                       |
  | 250   | global\_transport                  |
  | 253   | iats\_payments                     |
  | 255   | iveri                              |
  | 256   | ixopay                             |
  | 257   | jabstry                            |
  | 258   | jetpay                             |
  | 260   | kushki                             |
  | 261   | latitude19                         |
  | 263   | maxipago                           |
  | 266   | merchant\_partners                 |
  | 272   | mundipagg                          |
  | 274   | ncr\_secure\_pay                   |
  | 280   | optimal\_payments                  |
  | 282   | pay\_conex                         |
  | 283   | pay\_junction\_v2                  |
  | 288   | paymentez                          |
  | 291   | paystation                         |
  | 294   | pro\_pay                           |
  | 296   | qbms                               |
  | 298   | quickpay                           |
  | 299   | quickpay\_v10                      |
  | 300   | qvalent                            |
  | 303   | s5                                 |
  | 309   | securion\_pay                      |
  | 312   | tns                                |
  | 317   | vanco                              |
  | 318   | visanet\_peru                      |
  | 319   | wepay                              |
  | 320   | stripe\_payment\_intents           |
  | 321   | stripeACH                          |
  | 323   | quickbooks                         |
  | 324   | monei                              |
  | 401   | HostedPaymentPage1                 |
  | 402   | HostedPaymentPage2                 |
  | 403   | HostedPaymentPage3                 |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name for this payment gateway configuration.
</ParamField>

<ParamField type="integer">
  Filter by the payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required.
</ParamField>

<ParamField type="boolean">
  Filter by whether attempt3d secure is enabled.
</ParamField>

<ParamField type="string">
  Filter by aPI access token or secret key for authenticating with the payment provider.
</ParamField>

<ParamField type="string">
  Filter by provider-specific configuration in XML format (e.g. merchant ID, additional keys).
</ParamField>

<ParamField type="string">
  Filter by last XML response returned by the payment provider.
</ParamField>

<ParamField type="number">
  Filter by fee charged per transaction processed through this gateway.
</ParamField>

<ParamField type="integer">
  Filter by iD of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tax rate linked to this record.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by fee charged per transaction processed through this gateway greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by fee charged per transaction processed through this gateway less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/paymentgateways',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways?PaymentGateway_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways?' + new URLSearchParams({
      PaymentGateway_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/paymentgateways',
      params={
          'PaymentGateway_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways?from_PaymentGateway_UpdatedOn=2025-01-01T00:00&to_PaymentGateway_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways?' + new URLSearchParams({
      from_PaymentGateway_UpdatedOn: '2025-01-01T00:00',
      to_PaymentGateway_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/paymentgateways',
      params={
          'from_PaymentGateway_UpdatedOn': '2025-01-01T00:00',
          'to_PaymentGateway_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="PaymentGateway[]">
  The list of PaymentGateway records matching the query. See the [Get one PaymentGateway](/rest-api/billing/get-paymentgateways-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each PaymentGateway. The following fields are **not populated** in the `Records[]` response: `ConfigurationXml`, `TransactionFee`.

  To get all fields, fetch the full record using the [Get one PaymentGateway](/rest-api/billing/get-paymentgateways-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "PaymentGatewayType": 0,
      "Attempt3dSecure": false,
      "AccessToken": null,
      "XmlResponse": null,
      "FinancialAccountId": null,
      "TaxRateId": 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": "PaymentGateway Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple PaymentGateways
Source: https://learn.nexudus.com/rest-api/billing/get-paymentgateways-batch

GET /api/billing/paymentgateways/?id=[{id1},{id2},{id3}]
Retrieve multiple PaymentGateway records by their Ids in a single request.

Fetch several PaymentGateway records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`PaymentGateway-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of PaymentGateway Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/paymentgateways/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of PaymentGateway records. Each record has the same structure as the response from the [Get one PaymentGateway](/rest-api/billing/get-paymentgateways-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each PaymentGateway. The following fields are **not populated** in the response: `ConfigurationXml`, `TransactionFee`.

  To get all fields, fetch the full record using the [Get one PaymentGateway](/rest-api/billing/get-paymentgateways-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "PaymentGatewayType": 0,
    "Attempt3dSecure": false,
    "AccessToken": null,
    "XmlResponse": null,
    "FinancialAccountId": null,
    "TaxRateId": 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": "PaymentGateway Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one PaymentGateway
Source: https://learn.nexudus.com/rest-api/billing/get-paymentgateways-by-id

GET /api/billing/paymentgateways/{id}
Retrieve a single PaymentGateway record by its Id.

A **PaymentGateway** represents a connection to one of the supported payment gateways used to process card payments.

Each gateway can be associated to one or more locations (`Business` entity) via the `DefaultPaymentGatewayId` property on the business. A gateway is configured with a specific `PaymentGatewayType` (e.g. `stripe`, `braintree`, `adyen`) and the corresponding credentials (`AccessToken`, `ConfigurationXml`).

An optional `TransactionFee` can be set to track per-transaction costs, and a `FinancialAccountId` and `TaxRateId` can be linked for accounting purposes.

## Authentication

<Note>
  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 **`PaymentGateway-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the PaymentGateway record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/paymentgateways/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name for this payment gateway configuration.
</ResponseField>

<ResponseField name="PaymentGatewayType" type="integer">
  The payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required. See `ePaymentGatewayType` enum values: `0` = None, `1` = test, `2` = authorize\_net, `3` = beanstream, `4` = braintree, `6` = first\_data\_e4, `7` = jetpay\_v2, `8` = merchant\_e\_solutions, `9` = netbilling, `10` = payment\_express, `12` = sage, `13` = stripe, `14` = trans\_first, `15` = usa\_epay, `17` = blue\_pay, `18` = cyber\_source, `19` = elavon, `20` = first\_data\_e4\_v27, `21` = litle, `22` = mercury, `23` = nmi, `24` = payflow\_pro, `25` = quantum, `26` = secure\_net, `27` = trust\_commerce, `28` = worldpay, `29` = wirecard, `30` = paymill, `31` = merchant\_warrior, `32` = nab\_transact, `33` = secure\_pay\_au, `34` = eway, `35` = migs, `36` = pin, `37` = ogone, `38` = realex, `39` = moneris, `40` = psi\_gate, `41` = epay, `42` = hdfc, `43` = net\_pay, `44` = redsys, `45` = iridium, `46` = barclays\_epdq\_extra\_plus, `49` = paypal, `50` = payex, `51` = openpay, `52` = hps, `53` = checkout, `54` = checkout\_v2, `55` = worldpay\_us, `56` = conekta, `57` = orbital, `59` = barclaycard\_smartpay, `60` = trans\_first\_transaction\_express, `63` = forte, `65` = citrus\_pay, `66` = payu\_latam, `67` = global\_collect, `68` = cayan, `69` = clearhaus, `70` = sage\_pay, `71` = safe\_charge, `72` = mercado\_pago, `73` = payeezy, `200` = acapture, `201` = adyen, `203` = banco\_sabadell, `208` = blue\_snap, `209` = borgun, `210` = bpoint, `212` = bridge\_pay, `213` = card\_connect, `214` = card\_stream, `215` = cardprocess, `217` = cecabank, `218` = cenpos, `224` = creditcall, `225` = credorax, `226` = ct\_payment, `227` = culqi, `229` = data\_cash, `230` = diamond\_mind, `231` = dibs, `232` = digitzs, `234` = element, `237` = eway\_rapid, `238` = ezic, `239` = fat\_zebra, `242` = first\_giving, `243` = first\_pay, `244` = flo2cash, `245` = flo2cash\_simple, `247` = global, `249` = global\_iris, `250` = global\_transport, `253` = iats\_payments, `255` = iveri, `256` = ixopay, `257` = jabstry, `258` = jetpay, `260` = kushki, `261` = latitude19, `263` = maxipago, `266` = merchant\_partners, `272` = mundipagg, `274` = ncr\_secure\_pay, `280` = optimal\_payments, `282` = pay\_conex, `283` = pay\_junction\_v2, `288` = paymentez, `291` = paystation, `294` = pro\_pay, `296` = qbms, `298` = quickpay, `299` = quickpay\_v10, `300` = qvalent, `303` = s5, `309` = securion\_pay, `312` = tns, `317` = vanco, `318` = visanet\_peru, `319` = wepay, `320` = stripe\_payment\_intents, `321` = stripeACH, `323` = quickbooks, `324` = monei, `401` = HostedPaymentPage1, `402` = HostedPaymentPage2, `403` = HostedPaymentPage3.
</ResponseField>

<ResponseField name="Attempt3dSecure" type="boolean">
  Whether attempt3d secure is enabled.
</ResponseField>

<ResponseField name="AccessToken" type="string">
  API access token or secret key for authenticating with the payment provider.
</ResponseField>

<ResponseField name="ConfigurationXml" type="string">
  Provider-specific configuration in XML format (e.g. merchant ID, additional keys).
</ResponseField>

<ResponseField name="XmlResponse" type="string">
  Last XML response returned by the payment provider.
</ResponseField>

<ResponseField name="TransactionFee" type="number">
  Fee charged per transaction processed through this gateway.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  ID of the financial account linked to this record.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  ID of the tax rate linked to this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "PaymentGatewayType": 0,
  "Attempt3dSecure": false,
  "AccessToken": null,
  "ConfigurationXml": null,
  "XmlResponse": null,
  "TransactionFee": null,
  "FinancialAccountId": null,
  "TaxRateId": 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": "PaymentGateway Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProductBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-productbookingcredits

GET /api/billing/productbookingcredits
Search and list ProductBookingCredit records with filtering, sorting, and pagination.

A **ProductBookingCredit** represents an amount of credit linked to a `Product`. When a customer purchases the product, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ExpirationType` and `ExpiresIn` to control when the released credit expires.

## Authentication

<Note>
  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 **`ProductBookingCredit-List`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="string">
  Filter by credit name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="string">
  Filter by product business currency code.
</ParamField>

<ParamField type="number">
  Filter by credit amount.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product booking credit.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product booking credit.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer">
  Filter by expiration type.
</ParamField>

<ParamField type="integer">
  Filter by number of periods (of `ExpirationType`) until the released credit expires.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="boolean">
  Filter by whether this universal credit applies to other charges.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by credit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product booking credit greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product booking credit less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product booking credit greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product booking credit less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of periods (of `ExpirationType`) until the released credit expires greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of periods (of `ExpirationType`) until the released credit expires less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productbookingcredits?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productbookingcredits',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productbookingcredits?ProductBookingCredit_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
      ProductBookingCredit_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productbookingcredits',
      params={
          'ProductBookingCredit_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productbookingcredits?from_ProductBookingCredit_UpdatedOn=2025-01-01T00:00&to_ProductBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits?' + new URLSearchParams({
      from_ProductBookingCredit_UpdatedOn: '2025-01-01T00:00',
      to_ProductBookingCredit_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productbookingcredits',
      params={
          'from_ProductBookingCredit_UpdatedOn': '2025-01-01T00:00',
          'to_ProductBookingCredit_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProductBookingCredit[]">
  The list of ProductBookingCredit records matching the query. See the [Get one ProductBookingCredit](/rest-api/billing/get-productbookingcredits-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProductBookingCredit. The following fields are **not populated** in the `Records[]` response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `ExpiresIn`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one ProductBookingCredit](/rest-api/billing/get-productbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "Name": "",
      "ProductId": 0,
      "ProductName": null,
      "ProductBusinessCurrencyCode": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "Credit": 0,
      "EventCategories": [],
      "ExpirationType": 0,
      "ElegiblePasses": [],
      "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": "ProductBookingCredit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProductBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-productbookingcredits-batch

GET /api/billing/productbookingcredits/?id=[{id1},{id2},{id3}]
Retrieve multiple ProductBookingCredit records by their Ids in a single request.

Fetch several ProductBookingCredit records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProductBookingCredit-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProductBookingCredit Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productbookingcredits/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productbookingcredits/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProductBookingCredit records. Each record has the same structure as the response from the [Get one ProductBookingCredit](/rest-api/billing/get-productbookingcredits-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProductBookingCredit. The following fields are **not populated** in the response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `ExpiresIn`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one ProductBookingCredit](/rest-api/billing/get-productbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "Name": "",
    "ProductId": 0,
    "ProductName": null,
    "ProductBusinessCurrencyCode": null,
    "ElegibleResourceTypes": [],
    "ElegibleProducts": [],
    "ElegibleTariffs": [],
    "Credit": 0,
    "EventCategories": [],
    "ExpirationType": 0,
    "ElegiblePasses": [],
    "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": "ProductBookingCredit Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProductBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/get-productbookingcredits-by-id

GET /api/billing/productbookingcredits/{id}
Retrieve a single ProductBookingCredit record by its Id.

A **ProductBookingCredit** represents an amount of credit linked to a `Product`. When a customer purchases the product, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ExpirationType` and `ExpiresIn` to control when the released credit expires.

## Authentication

<Note>
  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 **`ProductBookingCredit-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductBookingCredit record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Name" type="string">
  Credit name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductBusinessCurrencyCode" type="string">
  Product business currency code.
</ResponseField>

<ResponseField name="ElegibleResourceTypes" type="integer[]">
  List of elegible resource types linked to this record.
</ResponseField>

<ResponseField name="ElegibleProducts" type="integer[]">
  List of elegible products linked to this record.
</ResponseField>

<ResponseField name="ElegibleTariffs" type="integer[]">
  List of elegible tariffs linked to this record.
</ResponseField>

<ResponseField name="Credit" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="ExpireTimeInMonths" type="integer">
  The expire time in months value for this product booking credit.
</ResponseField>

<ResponseField name="ExpireTimeInWeeks" type="integer">
  The expire time in weeks value for this product booking credit.
</ResponseField>

<ResponseField name="CaneBeUsedForBookings" type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ResponseField>

<ResponseField name="CaneBeUsedForEvents" type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ResponseField>

<ResponseField name="EventCategories" type="integer[]">
  List of event categories linked to this record.
</ResponseField>

<ResponseField name="ExpirationType" type="integer">
  Expiration type.
</ResponseField>

<ResponseField name="ExpiresIn" type="integer">
  Number of periods (of `ExpirationType`) until the released credit expires.
</ResponseField>

<ResponseField name="IsUniversalCredit" type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ResponseField>

<ResponseField name="ElegiblePasses" type="integer[]">
  List of elegible passes linked to this record.
</ResponseField>

<ResponseField name="AppliesToCharges" type="boolean">
  Whether this universal credit applies to other charges.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "Name": "",
  "ProductId": 0,
  "ProductName": null,
  "ProductBusinessCurrencyCode": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "Credit": 0,
  "ExpireTimeInMonths": null,
  "ExpireTimeInWeeks": null,
  "CaneBeUsedForBookings": false,
  "CaneBeUsedForEvents": false,
  "EventCategories": [],
  "ExpirationType": 0,
  "ExpiresIn": null,
  "IsUniversalCredit": false,
  "ElegiblePasses": [],
  "AppliesToCharges": false,
  "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": "ProductBookingCredit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProductExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-productextraservices

GET /api/billing/productextraservices
Search and list ProductExtraService records with filtering, sorting, and pagination.

A **ProductExtraService** links an `ExtraService` to a `Product`. The meaning of `UsesIncluded` depends on the type of the linked extra service:

* **Booking time** (ExtraService with `IsPrintingCredit = false`) — customers receive an allowance of booking time for the resource type(s) associated with that extra service. For example, a product called "Hot Desk Bundle" might include 2 hours of meeting room usage — achieved by linking a "Meeting Room Hourly" extra service with \`\`UsesIncluded` 120`.
* **Printing credit** (ExtraService with `IsPrintingCredit = true`) — customers receive a number of print jobs/pages. `UsesIncluded` is the number of printing credits included. The linked extra service must have `ChargePeriod = 5` (Uses) and `Price = 1`.

Always check `IsPrintingCredit` on the linked extra service before interpreting `UsesIncluded`.

For booking-time extra services, the unit of `UsesIncluded` is determined by the **ChargePeriod** of the linked `ExtraService`:

| ExtraService ChargePeriod | UsesIncluded unit |
| ------------------------- | ----------------- |
| 1 (Minutes)               | Minutes           |
| 2 (Days)                  | Days              |
| 3 (Weeks)                 | Weeks             |
| 4 (Months)                | Months            |
| 5 (Uses)                  | Individual uses   |
| 6 (FourWeekMonths)        | 4-week periods    |

So \`\`UsesIncluded` 60` on a minutes extra service means 60 minutes of booking time included. On a daily extra service it means 60 full days.

## Authentication

<Note>
  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 **`ProductExtraService-List`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ExtraServiceChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Filter by extra service name.
</ParamField>

<ParamField type="string">
  Filter by charge period of the linked extra service.
</ParamField>

<ParamField type="boolean">
  Filter by benefit is booking credit.
</ParamField>

<ParamField type="boolean">
  Filter by benefit is printing credit.
</ParamField>

<ParamField type="integer">
  Filter by uses included.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product extra service.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product extra service.
</ParamField>

<ParamField type="integer">
  Filter by expiration type.
</ParamField>

<ParamField type="integer">
  Filter by expires in.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by uses included greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by uses included less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product extra service greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product extra service less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product extra service greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product extra service less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by expires in greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by expires in less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productextraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productextraservices?ProductExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices?' + new URLSearchParams({
      ProductExtraService_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productextraservices',
      params={
          'ProductExtraService_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productextraservices?from_ProductExtraService_UpdatedOn=2025-01-01T00:00&to_ProductExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices?' + new URLSearchParams({
      from_ProductExtraService_UpdatedOn: '2025-01-01T00:00',
      to_ProductExtraService_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productextraservices',
      params={
          'from_ProductExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_ProductExtraService_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProductExtraService[]">
  The list of ProductExtraService records matching the query. See the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProductExtraService. The following fields are **not populated** in the `Records[]` response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProductId": 0,
      "ProductName": null,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceChargePeriod": null,
      "ExtraServiceIsBookingCredit": false,
      "ExtraServiceIsPrintingCredit": false,
      "UsesIncluded": 0,
      "ExpirationType": 0,
      "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": "ProductExtraService Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProductExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-productextraservices-batch

GET /api/billing/productextraservices/?id=[{id1},{id2},{id3}]
Retrieve multiple ProductExtraService records by their Ids in a single request.

Fetch several ProductExtraService records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProductExtraService-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProductExtraService Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productextraservices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/productextraservices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProductExtraService records. Each record has the same structure as the response from the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProductExtraService. The following fields are **not populated** in the response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one ProductExtraService](/rest-api/billing/get-productextraservices-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProductId": 0,
    "ProductName": null,
    "ExtraServiceId": 0,
    "ExtraServiceName": null,
    "ExtraServiceChargePeriod": null,
    "ExtraServiceIsBookingCredit": false,
    "ExtraServiceIsPrintingCredit": false,
    "UsesIncluded": 0,
    "ExpirationType": 0,
    "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": "ProductExtraService Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProductExtraService
Source: https://learn.nexudus.com/rest-api/billing/get-productextraservices-by-id

GET /api/billing/productextraservices/{id}
Retrieve a single ProductExtraService record by its Id.

A **ProductExtraService** links an `ExtraService` to a `Product`. The meaning of `UsesIncluded` depends on the type of the linked extra service:

* **Booking time** (ExtraService with `IsPrintingCredit = false`) — customers receive an allowance of booking time for the resource type(s) associated with that extra service. For example, a product called "Hot Desk Bundle" might include 2 hours of meeting room usage — achieved by linking a "Meeting Room Hourly" extra service with \`\`UsesIncluded` 120`.
* **Printing credit** (ExtraService with `IsPrintingCredit = true`) — customers receive a number of print jobs/pages. `UsesIncluded` is the number of printing credits included. The linked extra service must have `ChargePeriod = 5` (Uses) and `Price = 1`.

Always check `IsPrintingCredit` on the linked extra service before interpreting `UsesIncluded`.

For booking-time extra services, the unit of `UsesIncluded` is determined by the **ChargePeriod** of the linked `ExtraService`:

| ExtraService ChargePeriod | UsesIncluded unit |
| ------------------------- | ----------------- |
| 1 (Minutes)               | Minutes           |
| 2 (Days)                  | Days              |
| 3 (Weeks)                 | Weeks             |
| 4 (Months)                | Months            |
| 5 (Uses)                  | Individual uses   |
| 6 (FourWeekMonths)        | 4-week periods    |

So \`\`UsesIncluded` 60` on a minutes extra service means 60 minutes of booking time included. On a daily extra service it means 60 full days.

## Authentication

<Note>
  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 **`ProductExtraService-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductExtraService record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/productextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ExtraServiceId" type="integer">
  ID of the extra service linked to this record.
</ResponseField>

<ResponseField name="ExtraServiceName" type="string">
  Extra service name.
</ResponseField>

<ResponseField name="ExtraServiceChargePeriod" type="string">
  Charge period of the linked extra service.
</ResponseField>

<ResponseField name="ExtraServiceIsBookingCredit" type="boolean">
  Benefit is booking credit.
</ResponseField>

<ResponseField name="ExtraServiceIsPrintingCredit" type="boolean">
  Benefit is printing credit.
</ResponseField>

<ResponseField name="UsesIncluded" type="integer">
  Uses included.
</ResponseField>

<ResponseField name="ExpireTimeInMonths" type="integer">
  The expire time in months value for this product extra service.
</ResponseField>

<ResponseField name="ExpireTimeInWeeks" type="integer">
  The expire time in weeks value for this product extra service.
</ResponseField>

<ResponseField name="ExpirationType" type="integer">
  Expiration type.
</ResponseField>

<ResponseField name="ExpiresIn" type="integer">
  Expires in.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProductId": 0,
  "ProductName": null,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceChargePeriod": null,
  "ExtraServiceIsBookingCredit": false,
  "ExtraServiceIsPrintingCredit": false,
  "UsesIncluded": 0,
  "ExpireTimeInMonths": null,
  "ExpireTimeInWeeks": null,
  "ExpirationType": 0,
  "ExpiresIn": 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": "ProductExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Products
Source: https://learn.nexudus.com/rest-api/billing/get-products

GET /api/billing/products
Search and list Product records with filtering, sorting, and pagination.

A **Product** represents an item that can be sold to customers. Products can be sold via contracts (`ContractProduct` entity), added to bookings (`BookingProduct` entity), or purchased directly (`CoworkerProduct` entity).

Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using `ContractProduct` to associate the sale directly with a specific contract rather than relying on the customer's `MainContract`.

Use `AvailableAs` to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The `SystemProductType` field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other).

Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.

## Authentication

<Note>
  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 **`Product-List`** role.
</Note>

## Enums

<Accordion title="eProductType — SystemProductType values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | None            |
  | 1     | DayPass         |
  | 2     | CreditBundle    |
  | 3     | Stationery      |
  | 4     | BookingFeature  |
  | 5     | BookingProducts |
  | 99    | Other           |
</Accordion>

<Accordion title="eRecurrentProductOptions — AvailableAs values">
  | Value | Name              |
  | ----- | ----------------- |
  | 0     | None              |
  | 1     | RecurrentOrOneOff |
  | 2     | OnlyRecurrent     |
  | 3     | OnlyOneOff        |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by business name.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="integer">
  Filter by category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.
</ParamField>

<ParamField type="string">
  Filter by product description.
</ParamField>

<ParamField type="string">
  Filter by custom text shown on the invoice line instead of the product name.
</ParamField>

<ParamField type="string">
  Filter by sKU code.
</ParamField>

<ParamField type="string">
  Filter by comma-separated tags for categorising and filtering.
</ParamField>

<ParamField type="integer">
  Filter by display order.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="boolean">
  Filter by whether the product is visible to customers on the members portal and mobile app.
</ParamField>

<ParamField type="boolean">
  Filter by whether the product is visible to customers in the NexKiosk app.
</ParamField>

<ParamField type="boolean">
  Filter by whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.
</ParamField>

<ParamField type="string">
  Filter by additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.
</ParamField>

<ParamField type="boolean">
  Filter by whether to show the price of this product in AI channel recommendations and responses based on users' budget preferences.
</ParamField>

<ParamField type="number">
  Filter by override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used).
</ParamField>

<ParamField type="boolean">
  Filter by sync to Square Point of Sale.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by currency code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).
</ParamField>

<ParamField type="boolean">
  Filter by restrict purchase to contacts (customers without an active contract).
</ParamField>

<ParamField type="boolean">
  Filter by restrict purchase to customers with an active contract (members).
</ParamField>

<ParamField type="boolean">
  Filter by whether the product is archived. Archived products cannot be sold but existing charges remain active.
</ParamField>

<ParamField type="boolean">
  Filter by mark the product as featured or highlighted.
</ParamField>

<ParamField type="boolean">
  Filter by enable stock tracking for this product. When enabled, each sale reduces the stock count.
</ParamField>

<ParamField type="boolean">
  Filter by allow sales to continue even when stock reaches zero.
</ParamField>

<ParamField type="integer">
  Filter by current stock level.
</ParamField>

<ParamField type="integer">
  Filter by stock level at which a low-stock alert is triggered.
</ParamField>

<ParamField type="boolean">
  Filter by whether to pro-rate the price when the product is added or removed part-way through a billing period.
</ParamField>

<ParamField type="string">
  Filter by current file name of the image (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current image file.
</ParamField>

<ParamField type="boolean">
  Filter by whether to invoice the customer directly rather than their company or team.
</ParamField>

<ParamField type="boolean">
  Filter by sync to NexKiosk.
</ParamField>

<ParamField type="boolean">
  Filter by automatically create a delivery record for the customer when this product is purchased.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by display order greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used) greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by current stock level greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by current stock level less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by stock level at which a low-stock alert is triggered greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by stock level at which a low-stock alert is triggered less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/products',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products?Product_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products?' + new URLSearchParams({
      Product_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/products',
      params={
          'Product_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products?from_Product_UpdatedOn=2025-01-01T00:00&to_Product_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products?' + new URLSearchParams({
      from_Product_UpdatedOn: '2025-01-01T00:00',
      to_Product_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/products',
      params={
          'from_Product_UpdatedOn': '2025-01-01T00:00',
          'to_Product_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Product[]">
  The list of Product records matching the query. See the [Get one Product](/rest-api/billing/get-products-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Product. The following fields are **not populated** in the `Records[]` response: `DisplayOrder`, `AvailableAs`, `OnlyForContacts`, `OnlyForMembers`, `InvoiceCoworker`.

  To get all fields, fetch the full record using the [Get one Product](/rest-api/billing/get-products-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "SystemProductType": 0,
      "Description": "",
      "InvoiceLineDisplayAs": null,
      "Sku": null,
      "Tags": null,
      "Price": 0,
      "Visible": false,
      "VisibleInKiosk": false,
      "AvailableToAi": false,
      "NotesForAi": null,
      "ShowPriceForAi": false,
      "PriceForAi": null,
      "SyncToSquare": false,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "Tariffs": [],
      "Archived": false,
      "Starred": false,
      "TrackStock": false,
      "AllowNegativeStock": false,
      "CurrentStock": null,
      "StockAlertLevel": null,
      "ApplyProRating": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "SyncToNexKiosk": false,
      "CreateDeliveryWhenPurchased": false,
      "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": "Product Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Products
Source: https://learn.nexudus.com/rest-api/billing/get-products-batch

GET /api/billing/products/?id=[{id1},{id2},{id3}]
Retrieve multiple Product records by their Ids in a single request.

Fetch several Product records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Product-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Product Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/products/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Product records. Each record has the same structure as the response from the [Get one Product](/rest-api/billing/get-products-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Product. The following fields are **not populated** in the response: `DisplayOrder`, `AvailableAs`, `OnlyForContacts`, `OnlyForMembers`, `InvoiceCoworker`.

  To get all fields, fetch the full record using the [Get one Product](/rest-api/billing/get-products-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "Name": "",
    "SystemProductType": 0,
    "Description": "",
    "InvoiceLineDisplayAs": null,
    "Sku": null,
    "Tags": null,
    "Price": 0,
    "Visible": false,
    "VisibleInKiosk": false,
    "AvailableToAi": false,
    "NotesForAi": null,
    "ShowPriceForAi": false,
    "PriceForAi": null,
    "SyncToSquare": false,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxRateId": null,
    "ReducedTaxRateId": null,
    "ExemptTaxRateId": null,
    "FinancialAccountId": null,
    "Tariffs": [],
    "Archived": false,
    "Starred": false,
    "TrackStock": false,
    "AllowNegativeStock": false,
    "CurrentStock": null,
    "StockAlertLevel": null,
    "ApplyProRating": false,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "SyncToNexKiosk": false,
    "CreateDeliveryWhenPurchased": false,
    "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": "Product Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Product
Source: https://learn.nexudus.com/rest-api/billing/get-products-by-id

GET /api/billing/products/{id}
Retrieve a single Product record by its Id.

A **Product** represents an item that can be sold to customers. Products can be sold via contracts (`ContractProduct` entity), added to bookings (`BookingProduct` entity), or purchased directly (`CoworkerProduct` entity).

Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using `ContractProduct` to associate the sale directly with a specific contract rather than relying on the customer's `MainContract`.

Use `AvailableAs` to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The `SystemProductType` field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other).

Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.

## Authentication

<Note>
  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 **`Product-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Product record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Product name.
</ResponseField>

<ResponseField name="SystemProductType" type="integer">
  Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other. See `eProductType` enum values: `0` = None, `1` = DayPass, `2` = CreditBundle, `3` = Stationery, `4` = BookingFeature, `5` = BookingProducts, `99` = Other.
</ResponseField>

<ResponseField name="Description" type="string">
  Product description.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Custom text shown on the invoice line instead of the product name.
</ResponseField>

<ResponseField name="Sku" type="string">
  SKU code.
</ResponseField>

<ResponseField name="Tags" type="string">
  Comma-separated tags for categorising and filtering.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Display order.
</ResponseField>

<ResponseField name="Price" type="number">
  Product price.
</ResponseField>

<ResponseField name="Visible" type="boolean">
  Whether the product is visible to customers on the members portal and mobile app.
</ResponseField>

<ResponseField name="VisibleInKiosk" type="boolean">
  Whether the product is visible to customers in the NexKiosk app.
</ResponseField>

<ResponseField name="AvailableToAi" type="boolean">
  Whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.
</ResponseField>

<ResponseField name="NotesForAi" type="string">
  Additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.
</ResponseField>

<ResponseField name="ShowPriceForAi" type="boolean">
  Whether to show the price of this product in AI channel recommendations and responses based on users' budget preferences.
</ResponseField>

<ResponseField name="PriceForAi" type="number">
  Override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used).
</ResponseField>

<ResponseField name="SyncToSquare" type="boolean">
  Sync to Square Point of Sale.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  Currency code.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  ID of the tax rate linked to this record.
</ResponseField>

<ResponseField name="ReducedTaxRateId" type="integer">
  ID of the reduced tax rate linked to this record.
</ResponseField>

<ResponseField name="ExemptTaxRateId" type="integer">
  ID of the exempt tax rate linked to this record.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  ID of the financial account linked to this record.
</ResponseField>

<ResponseField name="AvailableAs" type="integer">
  Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff). See `eRecurrentProductOptions` enum values: `0` = None, `1` = RecurrentOrOneOff, `2` = OnlyRecurrent, `3` = OnlyOneOff.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Restrict purchase to contacts (customers without an active contract).
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Restrict purchase to customers with an active contract (members).
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="Archived" type="boolean">
  Whether the product is archived. Archived products cannot be sold but existing charges remain active.
</ResponseField>

<ResponseField name="Starred" type="boolean">
  Mark the product as featured or highlighted.
</ResponseField>

<ResponseField name="TrackStock" type="boolean">
  Enable stock tracking for this product. When enabled, each sale reduces the stock count.
</ResponseField>

<ResponseField name="AllowNegativeStock" type="boolean">
  Allow sales to continue even when stock reaches zero.
</ResponseField>

<ResponseField name="CurrentStock" type="integer">
  Current stock level.
</ResponseField>

<ResponseField name="StockAlertLevel" type="integer">
  Stock level at which a low-stock alert is triggered.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Whether to pro-rate the price when the product is added or removed part-way through a billing period.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current file name of the image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new file to upload as the image.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current image file.
</ResponseField>

<ResponseField name="InvoiceCoworker" type="boolean">
  Whether to invoice the customer directly rather than their company or team.
</ResponseField>

<ResponseField name="SyncToNexKiosk" type="boolean">
  Sync to NexKiosk.
</ResponseField>

<ResponseField name="CreateDeliveryWhenPurchased" type="boolean">
  Automatically create a delivery record for the customer when this product is purchased.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "SystemProductType": 0,
  "Description": "",
  "InvoiceLineDisplayAs": null,
  "Sku": null,
  "Tags": null,
  "DisplayOrder": 0,
  "Price": 0,
  "Visible": false,
  "VisibleInKiosk": false,
  "AvailableToAi": false,
  "NotesForAi": null,
  "ShowPriceForAi": false,
  "PriceForAi": null,
  "SyncToSquare": false,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "AvailableAs": 0,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "Starred": false,
  "TrackStock": false,
  "AllowNegativeStock": false,
  "CurrentStock": null,
  "StockAlertLevel": null,
  "ApplyProRating": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "InvoiceCoworker": false,
  "SyncToNexKiosk": false,
  "CreateDeliveryWhenPurchased": false,
  "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": "Product Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Commands for Products
Source: https://learn.nexudus.com/rest-api/billing/get-products-commands

GET /api/billing/products/commands
Retrieve the list of available commands that can be executed on Product records.

Commands are actions that can be executed on one or more Product records. Use this endpoint to discover which commands are available, then execute them via the [Run command](/rest-api/billing/post-products-run-command) endpoint.

## Authentication

<Note>
  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 **`Product-List`** role.
</Note>

## Query Parameters

<ParamField type="integer">
  If provided, only commands available for this specific Product will be returned.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/products/commands" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products/commands',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const commands = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  commands = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of available commands.

<ResponseField name="Key" type="string">
  Unique identifier for the command. Pass this to the [Run command](/rest-api/billing/post-products-run-command) endpoint.
</ResponseField>

<ResponseField name="Name" type="string">
  Human-readable name of the command.
</ResponseField>

<ResponseField name="AppliesOnlyToMultipleEntities" type="boolean">
  Whether the command can only be run on multiple records at once.
</ResponseField>

<ResponseField name="AppliesOnlyToOneEntity" type="boolean">
  Whether the command can only be run on a single record.
</ResponseField>

<ResponseField name="NeedsEntitiesToRun" type="boolean">
  Whether the command requires record Ids to execute.
</ResponseField>

<ResponseField name="Order" type="integer">
  Display order for the command.
</ResponseField>

<ResponseField name="RequiresParameters" type="object[]">
  List of parameters required by this command, each containing `Name` and `Type`.
</ResponseField>

```json Example Response theme={null}
[
  {
    "Key": "COMMAND_KEY_1",
    "Name": "Command name",
    "AppliesOnlyToMultipleEntities": false,
    "DisplayInDropdown": false,
    "DisplayInDropdownV2": true,
    "AppliesOnlyToOneEntity": true,
    "AppliesOnlyToTwoEntities": false,
    "DisplayInGrid": false,
    "Icon": "/Content/Themes/Admin/Images/Icons/Fugue/gear.png",
    "NeedsEntitiesToRun": true,
    "Order": 8,
    "RequiresParameters": [
      {
        "Name": "Parameter name",
        "Type": "parameterType"
      }
    ]
  }
]
```


# Search ProductTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-producttimepasses

GET /api/billing/producttimepasses
Search and list ProductTimePass records with filtering, sorting, and pagination.

A **ProductTimePass** links a `TimePass` to a `Product` so that customers purchasing the product automatically receive an amount of check-in time. The nature of that time depends on the type of the linked `TimePass`:

* **Day Pass** (TimePass with `MinutesIncluded` = null) — `PassesIncluded` is the number of calendar days. The customer can check in any number of times during each calendar day they hold.
* **Time Pass** (TimePass with `MinutesIncluded` set) — `PassesIncluded` is the number of pass instances (each worth `MinutesIncluded` minutes). Multiply `PassesIncluded` by `MinutesIncluded` to get total hours. For example, `PassesIncluded = 10` with a 60-minute time pass gives the customer 10 hours of check-in time to use across different dates.

## Authentication

<Note>
  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 **`ProductTimePass-List`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Filter by time pass name.
</ParamField>

<ParamField type="integer">
  Filter by passes included.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product time pass.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product time pass.
</ParamField>

<ParamField type="integer">
  Filter by expiration type.
</ParamField>

<ParamField type="integer">
  Filter by expires in.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by passes included greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by passes included less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product time pass greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in months value for this product time pass less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product time pass greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the expire time in weeks value for this product time pass less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by expires in greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by expires in less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/producttimepasses?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/producttimepasses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/producttimepasses?ProductTimePass_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses?' + new URLSearchParams({
      ProductTimePass_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/producttimepasses',
      params={
          'ProductTimePass_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/producttimepasses?from_ProductTimePass_UpdatedOn=2025-01-01T00:00&to_ProductTimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses?' + new URLSearchParams({
      from_ProductTimePass_UpdatedOn: '2025-01-01T00:00',
      to_ProductTimePass_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/producttimepasses',
      params={
          'from_ProductTimePass_UpdatedOn': '2025-01-01T00:00',
          'to_ProductTimePass_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProductTimePass[]">
  The list of ProductTimePass records matching the query. See the [Get one ProductTimePass](/rest-api/billing/get-producttimepasses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProductTimePass. The following fields are **not populated** in the `Records[]` response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one ProductTimePass](/rest-api/billing/get-producttimepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProductId": 0,
      "ProductName": null,
      "TimePassId": 0,
      "TimePassName": null,
      "PassesIncluded": 0,
      "ExpirationType": 0,
      "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": "ProductTimePass Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProductTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-producttimepasses-batch

GET /api/billing/producttimepasses/?id=[{id1},{id2},{id3}]
Retrieve multiple ProductTimePass records by their Ids in a single request.

Fetch several ProductTimePass records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProductTimePass-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProductTimePass Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/producttimepasses/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/producttimepasses/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProductTimePass records. Each record has the same structure as the response from the [Get one ProductTimePass](/rest-api/billing/get-producttimepasses-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProductTimePass. The following fields are **not populated** in the response: `ExpireTimeInMonths`, `ExpireTimeInWeeks`, `ExpiresIn`.

  To get all fields, fetch the full record using the [Get one ProductTimePass](/rest-api/billing/get-producttimepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProductId": 0,
    "ProductName": null,
    "TimePassId": 0,
    "TimePassName": null,
    "PassesIncluded": 0,
    "ExpirationType": 0,
    "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": "ProductTimePass Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProductTimePass
Source: https://learn.nexudus.com/rest-api/billing/get-producttimepasses-by-id

GET /api/billing/producttimepasses/{id}
Retrieve a single ProductTimePass record by its Id.

A **ProductTimePass** links a `TimePass` to a `Product` so that customers purchasing the product automatically receive an amount of check-in time. The nature of that time depends on the type of the linked `TimePass`:

* **Day Pass** (TimePass with `MinutesIncluded` = null) — `PassesIncluded` is the number of calendar days. The customer can check in any number of times during each calendar day they hold.
* **Time Pass** (TimePass with `MinutesIncluded` set) — `PassesIncluded` is the number of pass instances (each worth `MinutesIncluded` minutes). Multiply `PassesIncluded` by `MinutesIncluded` to get total hours. For example, `PassesIncluded = 10` with a 60-minute time pass gives the customer 10 hours of check-in time to use across different dates.

## Authentication

<Note>
  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 **`ProductTimePass-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProductTimePass record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/producttimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="TimePassId" type="integer">
  ID of the time pass linked to this record.
</ResponseField>

<ResponseField name="TimePassName" type="string">
  Time pass name.
</ResponseField>

<ResponseField name="PassesIncluded" type="integer">
  Passes included.
</ResponseField>

<ResponseField name="ExpireTimeInMonths" type="integer">
  The expire time in months value for this product time pass.
</ResponseField>

<ResponseField name="ExpireTimeInWeeks" type="integer">
  The expire time in weeks value for this product time pass.
</ResponseField>

<ResponseField name="ExpirationType" type="integer">
  Expiration type.
</ResponseField>

<ResponseField name="ExpiresIn" type="integer">
  Expires in.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProductId": 0,
  "ProductName": null,
  "TimePassId": 0,
  "TimePassName": null,
  "PassesIncluded": 0,
  "ExpireTimeInMonths": null,
  "ExpireTimeInWeeks": null,
  "ExpirationType": 0,
  "ExpiresIn": 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": "ProductTimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProposalContracts
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontracts

GET /api/billing/proposalcontracts
Search and list ProposalContract records with filtering, sorting, and pagination.

A **ProposalContract** links a contract configuration to a proposal, defining the pricing plan and terms that will be applied if the proposal is accepted by the customer.

## Authentication

<Note>
  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 **`ProposalContract-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the proposal linked to this record.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker ID.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker email.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker full name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="string">
  Filter by tariff invoice frequency.
</ParamField>

<ParamField type="string">
  Filter by tariff invoice frequency in weeks.
</ParamField>

<ParamField type="number">
  Filter by tariff price.
</ParamField>

<ParamField type="string">
  Filter by tariff business currency code.
</ParamField>

<ParamField type="number">
  Filter by price override.
</ParamField>

<ParamField type="string">
  Filter by contract start date.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days.
</ParamField>

<ParamField type="string">
  Filter by contract term end date.
</ParamField>

<ParamField type="string">
  Filter by cancellation date.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="integer">
  Filter by iD of the discount code linked to this record.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk IDs.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk names.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk variant IDs.
</ParamField>

<ParamField type="string">
  Filter by floor plan desk variant names.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by tariff price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tariff price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by contract start date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by contract start date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by contract term end date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by contract term end date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by cancellation date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by cancellation date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontracts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontracts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontracts?ProposalContract_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
      ProposalContract_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontracts',
      params={
          'ProposalContract_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontracts?from_ProposalContract_UpdatedOn=2025-01-01T00:00&to_ProposalContract_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
      from_ProposalContract_UpdatedOn: '2025-01-01T00:00',
      to_ProposalContract_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontracts',
      params={
          'from_ProposalContract_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalContract_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProposalContract[]">
  The list of ProposalContract records matching the query. See the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProposalContract. The following fields are **not populated** in the `Records[]` response: `CancellationLimitDays`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProposalId": 0,
      "ProposalCoworkerId": null,
      "ProposalCoworkerEmail": null,
      "ProposalCoworkerFullName": null,
      "TariffId": 0,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": 0,
      "TariffBusinessCurrencyCode": null,
      "Desks": [],
      "Variants": [],
      "Price": null,
      "StartDate": null,
      "ContractTerm": null,
      "CancellationDate": null,
      "DiscountCodeId": null,
      "FloorPlanDeskIds": null,
      "FloorPlanDeskNames": null,
      "FloorPlanDeskVariantIds": null,
      "FloorPlanDeskVariantNames": 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": "ProposalContract Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProposalContracts
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontracts-batch

GET /api/billing/proposalcontracts/?id=[{id1},{id2},{id3}]
Retrieve multiple ProposalContract records by their Ids in a single request.

Fetch several ProposalContract records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProposalContract-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProposalContract Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontracts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontracts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProposalContract records. Each record has the same structure as the response from the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProposalContract. The following fields are **not populated** in the response: `CancellationLimitDays`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProposalId": 0,
    "ProposalCoworkerId": null,
    "ProposalCoworkerEmail": null,
    "ProposalCoworkerFullName": null,
    "TariffId": 0,
    "TariffName": null,
    "TariffInvoiceEvery": null,
    "TariffInvoiceEveryWeeks": null,
    "TariffPrice": 0,
    "TariffBusinessCurrencyCode": null,
    "Desks": [],
    "Variants": [],
    "Price": null,
    "StartDate": null,
    "ContractTerm": null,
    "CancellationDate": null,
    "DiscountCodeId": null,
    "FloorPlanDeskIds": null,
    "FloorPlanDeskNames": null,
    "FloorPlanDeskVariantIds": null,
    "FloorPlanDeskVariantNames": 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": "ProposalContract Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProposalContract
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontracts-by-id

GET /api/billing/proposalcontracts/{id}
Retrieve a single ProposalContract record by its Id.

A **ProposalContract** links a contract configuration to a proposal, defining the pricing plan and terms that will be applied if the proposal is accepted by the customer.

## Authentication

<Note>
  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 **`ProposalContract-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalContract record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontracts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProposalId" type="integer">
  ID of the proposal linked to this record.
</ResponseField>

<ResponseField name="ProposalCoworkerId" type="string">
  Proposal coworker ID.
</ResponseField>

<ResponseField name="ProposalCoworkerEmail" type="string">
  Proposal coworker email.
</ResponseField>

<ResponseField name="ProposalCoworkerFullName" type="string">
  Proposal coworker full name.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="TariffInvoiceEvery" type="string">
  Tariff invoice frequency.
</ResponseField>

<ResponseField name="TariffInvoiceEveryWeeks" type="string">
  Tariff invoice frequency in weeks.
</ResponseField>

<ResponseField name="TariffPrice" type="number">
  Tariff price.
</ResponseField>

<ResponseField name="TariffBusinessCurrencyCode" type="string">
  Tariff business currency code.
</ResponseField>

<ResponseField name="Desks" type="integer[]">
  List of desks linked to this record.
</ResponseField>

<ResponseField name="Variants" type="integer[]">
  List of variants linked to this record.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="StartDate" type="string">
  Contract start date.
</ResponseField>

<ResponseField name="CancellationLimitDays" type="integer">
  Cancellation limit in days.
</ResponseField>

<ResponseField name="ContractTerm" type="string">
  Contract term end date.
</ResponseField>

<ResponseField name="CancellationDate" type="string">
  Cancellation date.
</ResponseField>

<ResponseField name="BillingDay" type="integer">
  Billing day of month.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="DiscountCodeId" type="integer">
  ID of the discount code linked to this record.
</ResponseField>

<ResponseField name="FloorPlanDeskIds" type="string">
  Floor plan desk IDs.
</ResponseField>

<ResponseField name="FloorPlanDeskNames" type="string">
  Floor plan desk names.
</ResponseField>

<ResponseField name="FloorPlanDeskVariantIds" type="string">
  Floor plan desk variant IDs.
</ResponseField>

<ResponseField name="FloorPlanDeskVariantNames" type="string">
  Floor plan desk variant names.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProposalId": 0,
  "ProposalCoworkerId": null,
  "ProposalCoworkerEmail": null,
  "ProposalCoworkerFullName": null,
  "TariffId": 0,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": 0,
  "TariffBusinessCurrencyCode": null,
  "Desks": [],
  "Variants": [],
  "Price": null,
  "StartDate": null,
  "CancellationLimitDays": null,
  "ContractTerm": null,
  "CancellationDate": null,
  "BillingDay": 0,
  "Quantity": 0,
  "DiscountCodeId": null,
  "FloorPlanDeskIds": null,
  "FloorPlanDeskNames": null,
  "FloorPlanDeskVariantIds": null,
  "FloorPlanDeskVariantNames": 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": "ProposalContract Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProposalContractSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontractschedules

GET /api/billing/proposalcontractschedules
Search and list ProposalContractSchedule records with filtering, sorting, and pagination.

A **ProposalContractSchedule** defines the billing schedule for a contract within a proposal, specifying payment frequency, amounts, and timing.

## Authentication

<Note>
  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 **`ProposalContractSchedule-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the proposal contract linked to this record.
</ParamField>

<ParamField type="string">
  Filter by proposal contract quantity.
</ParamField>

<ParamField type="string">
  Filter by proposal contract tariff name.
</ParamField>

<ParamField type="string">
  Filter by proposal contract coworker ID.
</ParamField>

<ParamField type="string">
  Filter by proposal contract coworker full name.
</ParamField>

<ParamField type="string">
  Filter by proposal contract coworker billing name.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this proposal contract schedule.
</ParamField>

<ParamField type="number">
  Filter by scheduled price.
</ParamField>

<ParamField type="string">
  Filter by date to apply.
</ParamField>

<ParamField type="boolean">
  Filter by whether the schedule has been applied.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by scheduled price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by scheduled price less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date to apply greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date to apply less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules?ProposalContractSchedule_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules?' + new URLSearchParams({
      ProposalContractSchedule_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
      params={
          'ProposalContractSchedule_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules?from_ProposalContractSchedule_UpdatedOn=2025-01-01T00:00&to_ProposalContractSchedule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules?' + new URLSearchParams({
      from_ProposalContractSchedule_UpdatedOn: '2025-01-01T00:00',
      to_ProposalContractSchedule_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
      params={
          'from_ProposalContractSchedule_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalContractSchedule_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProposalContractSchedule[]">
  The list of ProposalContractSchedule records matching the query. See the [Get one ProposalContractSchedule](/rest-api/billing/get-proposalcontractschedules-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProposalContractSchedule. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalContractSchedule](/rest-api/billing/get-proposalcontractschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProposalContractId": 0,
      "ProposalContractQuantity": null,
      "ProposalContractTariffName": null,
      "ProposalContractProposalCoworkerId": null,
      "ProposalContractProposalCoworkerFullName": null,
      "ProposalContractProposalCoworkerBillingName": null,
      "Price": null,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Applied": false,
      "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": "ProposalContractSchedule Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProposalContractSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontractschedules-batch

GET /api/billing/proposalcontractschedules/?id=[{id1},{id2},{id3}]
Retrieve multiple ProposalContractSchedule records by their Ids in a single request.

Fetch several ProposalContractSchedule records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProposalContractSchedule-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProposalContractSchedule Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProposalContractSchedule records. Each record has the same structure as the response from the [Get one ProposalContractSchedule](/rest-api/billing/get-proposalcontractschedules-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProposalContractSchedule. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalContractSchedule](/rest-api/billing/get-proposalcontractschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProposalContractId": 0,
    "ProposalContractQuantity": null,
    "ProposalContractTariffName": null,
    "ProposalContractProposalCoworkerId": null,
    "ProposalContractProposalCoworkerFullName": null,
    "ProposalContractProposalCoworkerBillingName": null,
    "Price": null,
    "ApplyOn": "2025-01-15T10:30:00Z",
    "Applied": false,
    "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": "ProposalContractSchedule Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProposalContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/get-proposalcontractschedules-by-id

GET /api/billing/proposalcontractschedules/{id}
Retrieve a single ProposalContractSchedule record by its Id.

A **ProposalContractSchedule** defines the billing schedule for a contract within a proposal, specifying payment frequency, amounts, and timing.

## Authentication

<Note>
  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 **`ProposalContractSchedule-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalContractSchedule record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProposalContractId" type="integer">
  ID of the proposal contract linked to this record.
</ResponseField>

<ResponseField name="ProposalContractQuantity" type="string">
  Proposal contract quantity.
</ResponseField>

<ResponseField name="ProposalContractTariffName" type="string">
  Proposal contract tariff name.
</ResponseField>

<ResponseField name="ProposalContractProposalCoworkerId" type="string">
  Proposal contract coworker ID.
</ResponseField>

<ResponseField name="ProposalContractProposalCoworkerFullName" type="string">
  Proposal contract coworker full name.
</ResponseField>

<ResponseField name="ProposalContractProposalCoworkerBillingName" type="string">
  Proposal contract coworker billing name.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this proposal contract schedule.
</ResponseField>

<ResponseField name="Price" type="number">
  Scheduled price.
</ResponseField>

<ResponseField name="ApplyOn" type="string">
  Date to apply.
</ResponseField>

<ResponseField name="Applied" type="boolean">
  Whether the schedule has been applied.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProposalContractId": 0,
  "ProposalContractQuantity": null,
  "ProposalContractTariffName": null,
  "ProposalContractProposalCoworkerId": null,
  "ProposalContractProposalCoworkerFullName": null,
  "ProposalContractProposalCoworkerBillingName": null,
  "Notes": null,
  "Price": null,
  "ApplyOn": "2025-01-15T10:30:00Z",
  "Applied": false,
  "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": "ProposalContractSchedule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProposalProducts
Source: https://learn.nexudus.com/rest-api/billing/get-proposalproducts

GET /api/billing/proposalproducts
Search and list ProposalProduct records with filtering, sorting, and pagination.

A **ProposalProduct** links a product to a proposal, defining additional items or services included in the offer with their pricing and recurrence settings.

## Authentication

<Note>
  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 **`ProposalProduct-List`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the proposal linked to this record.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker ID.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker email.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker full name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="string">
  Filter by whether product applies pro-rating.
</ParamField>

<ParamField type="string">
  Filter by product business currency code.
</ParamField>

<ParamField type="integer">
  Filter by number of units.
</ParamField>

<ParamField type="number">
  Filter by price override.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a deposit.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a contract product.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a regular charge.
</ParamField>

<ParamField type="integer">
  Filter by repeat cycle pattern.
</ParamField>

<ParamField type="string">
  Filter by invoice on date.
</ParamField>

<ParamField type="string">
  Filter by repeat from date.
</ParamField>

<ParamField type="string">
  Filter by repeat until date.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units.
</ParamField>

<ParamField type="boolean">
  Filter by apply pro-rating.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this proposal product.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of units less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by invoice on date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by invoice on date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat from date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by repeat until date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of repeat units less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalproducts?ProposalProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts?' + new URLSearchParams({
      ProposalProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalproducts',
      params={
          'ProposalProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalproducts?from_ProposalProduct_UpdatedOn=2025-01-01T00:00&to_ProposalProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts?' + new URLSearchParams({
      from_ProposalProduct_UpdatedOn: '2025-01-01T00:00',
      to_ProposalProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalproducts',
      params={
          'from_ProposalProduct_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProposalProduct[]">
  The list of ProposalProduct records matching the query. See the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProposalProduct. The following fields are **not populated** in the `Records[]` response: `RepeatCycle`, `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProposalId": 0,
      "ProposalCoworkerId": null,
      "ProposalCoworkerEmail": null,
      "ProposalCoworkerFullName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductApplyProRating": null,
      "ProductBusinessCurrencyCode": null,
      "Quantity": 0,
      "Price": null,
      "IsDeposit": false,
      "IsContractProduct": false,
      "RegularCharge": false,
      "InvoiceOn": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "RepeatUnit": null,
      "ApplyProRating": false,
      "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": "ProposalProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProposalProducts
Source: https://learn.nexudus.com/rest-api/billing/get-proposalproducts-batch

GET /api/billing/proposalproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple ProposalProduct records by their Ids in a single request.

Fetch several ProposalProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProposalProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProposalProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProposalProduct records. Each record has the same structure as the response from the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProposalProduct. The following fields are **not populated** in the response: `RepeatCycle`, `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProposalId": 0,
    "ProposalCoworkerId": null,
    "ProposalCoworkerEmail": null,
    "ProposalCoworkerFullName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductApplyProRating": null,
    "ProductBusinessCurrencyCode": null,
    "Quantity": 0,
    "Price": null,
    "IsDeposit": false,
    "IsContractProduct": false,
    "RegularCharge": false,
    "InvoiceOn": null,
    "RepeatFrom": null,
    "RepeatUntil": null,
    "RepeatUnit": null,
    "ApplyProRating": false,
    "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": "ProposalProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProposalProduct
Source: https://learn.nexudus.com/rest-api/billing/get-proposalproducts-by-id

GET /api/billing/proposalproducts/{id}
Retrieve a single ProposalProduct record by its Id.

A **ProposalProduct** links a product to a proposal, defining additional items or services included in the offer with their pricing and recurrence settings.

## Authentication

<Note>
  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 **`ProposalProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProposalId" type="integer">
  ID of the proposal linked to this record.
</ResponseField>

<ResponseField name="ProposalCoworkerId" type="string">
  Proposal coworker ID.
</ResponseField>

<ResponseField name="ProposalCoworkerEmail" type="string">
  Proposal coworker email.
</ResponseField>

<ResponseField name="ProposalCoworkerFullName" type="string">
  Proposal coworker full name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductApplyProRating" type="string">
  Whether product applies pro-rating.
</ResponseField>

<ResponseField name="ProductBusinessCurrencyCode" type="string">
  Product business currency code.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="IsDeposit" type="boolean">
  Whether this is a deposit.
</ResponseField>

<ResponseField name="IsContractProduct" type="boolean">
  Whether this is a contract product.
</ResponseField>

<ResponseField name="RegularCharge" type="boolean">
  Whether this is a regular charge.
</ResponseField>

<ResponseField name="RepeatCycle" type="integer">
  Repeat cycle pattern. See `eRecurrentChargePattern` enum values: `1` = PricePlan, `2` = Day, `3` = Week, `4` = Month, `5` = Year, `6` = LastDayOfMonth.
</ResponseField>

<ResponseField name="InvoiceOn" type="string">
  Invoice on date.
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Repeat from date.
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Repeat until date.
</ResponseField>

<ResponseField name="RepeatUnit" type="integer">
  Number of repeat units.
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Apply pro-rating.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this proposal product.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProposalId": 0,
  "ProposalCoworkerId": null,
  "ProposalCoworkerEmail": null,
  "ProposalCoworkerFullName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductApplyProRating": null,
  "ProductBusinessCurrencyCode": null,
  "Quantity": 0,
  "Price": null,
  "IsDeposit": false,
  "IsContractProduct": false,
  "RegularCharge": false,
  "RepeatCycle": 0,
  "InvoiceOn": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "RepeatUnit": null,
  "ApplyProRating": false,
  "Notes": 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": "ProposalProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Proposals
Source: https://learn.nexudus.com/rest-api/billing/get-proposals

GET /api/billing/proposals
Search and list Proposal records with filtering, sorting, and pagination.

A **Proposal** bundles one or more contracts (`ProposalContract` records) that are presented to a customer for review and acceptance. Each `ProposalContract` carries the same properties as a `CoworkerContract` and becomes one when the proposal is accepted.

When a Proposal is created, a `ProposalContract` is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (`TariffId`, `Desks`, `Variants`, `Price`, `StartDate`, `CancellationLimitDays`, `ContractTerm`, `CancellationDate`, `ExpirationDate`, `BillingDay`, `Quantity`) become read-only — they are all `createOnly`. Subsequent edits to those values must be made via the associated `ProposalContract`. Additional `ProposalContract` records can also be added.

Proposals support three optional attachments:

* **DocumentToSendId** — a `DocumentTemplate` entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
* **DocumentToSignId** — a `DocumentTemplate` entity used to generate a document for e-signature.
* **ProposalFile** — a file shown as a downloadable link before the proposal is accepted.

Set `DoNotIssueInvoice` to control whether the first invoice is issued automatically when the proposal is accepted.

## Authentication

<Note>
  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 **`Proposal-List`** role.
</Note>

## Enums

<Accordion title="eProposalStatus — ProposalStatus values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Draft    |
  | 2     | Sent     |
  | 3     | Accepted |
  | 4     | Rejected |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the issued by linked to this record.
</ParamField>

<ParamField type="string">
  Filter by issuing business name.
</ParamField>

<ParamField type="string">
  Filter by issuing business currency code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the responsible linked to this record.
</ParamField>

<ParamField type="string">
  Filter by responsible person full name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by coworker type.
</ParamField>

<ParamField type="string">
  Filter by coworker full name.
</ParamField>

<ParamField type="string">
  Filter by coworker company name.
</ParamField>

<ParamField type="string">
  Filter by coworker billing name.
</ParamField>

<ParamField type="string">
  Filter by proposal reference.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this proposal.
</ParamField>

<ParamField type="integer">
  Filter by proposal status.
</ParamField>

<ParamField type="integer">
  Filter by iD of the document to send linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the document to sign linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the document to sign html value for this proposal.
</ParamField>

<ParamField type="string">
  Filter by current file name of the document to sign binary document (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the document to sign binary document.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current document to sign binary document file.
</ParamField>

<ParamField type="string">
  Filter by the document to send html value for this proposal.
</ParamField>

<ParamField type="string">
  Filter by current file name of the document to send binary document (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the document to send binary document.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current document to send binary document file.
</ParamField>

<ParamField type="string">
  Filter by current file name of the proposal file (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the proposal file.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current proposal file file.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="string">
  Filter by tariff invoice frequency.
</ParamField>

<ParamField type="string">
  Filter by tariff invoice frequency in weeks.
</ParamField>

<ParamField type="number">
  Filter by tariff price.
</ParamField>

<ParamField type="string">
  Filter by tariff business currency code.
</ParamField>

<ParamField type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Filter by iD of the discount code linked to this record.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local.
</ParamField>

<ParamField type="string">
  Filter by date the proposal was sent.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sent on local.
</ParamField>

<ParamField type="string">
  Filter by date the customer last opened the proposal.
</ParamField>

<ParamField type="boolean">
  Filter by if true, the first invoice is not issued automatically when the proposal is accepted.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by tariff price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by tariff price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for start date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the proposal was sent greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the proposal was sent less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sent on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for sent on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the customer last opened the proposal greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the customer last opened the proposal less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals?page=1&size=15&orderBy=Reference&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Reference',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposals',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Reference',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Reference

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals?Proposal_Reference=example-value&orderBy=Reference&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
      Proposal_Reference: 'example-value',
      orderBy: 'Reference',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposals',
      params={
          'Proposal_Reference': 'example-value',
          'orderBy': 'Reference',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals?from_Proposal_UpdatedOn=2025-01-01T00:00&to_Proposal_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
      from_Proposal_UpdatedOn: '2025-01-01T00:00',
      to_Proposal_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposals',
      params={
          'from_Proposal_UpdatedOn': '2025-01-01T00:00',
          'to_Proposal_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Proposal[]">
  The list of Proposal records matching the query. See the [Get one Proposal](/rest-api/billing/get-proposals-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Proposal. The following fields are **not populated** in the `Records[]` response: `Notes`, `DocumentToSignHtml`, `DocumentToSendHtml`, `Price`, `StartDate`, `CancellationLimitDays`, `CancellationDate`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one Proposal](/rest-api/billing/get-proposals-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "IssuedById": 0,
      "IssuedByName": null,
      "IssuedByCurrencyCode": null,
      "ResponsibleId": 0,
      "ResponsibleFullName": null,
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "Reference": "",
      "ProposalStatus": 0,
      "DocumentToSendId": null,
      "DocumentToSignId": null,
      "DocumentToSignBinaryDocumentFileName": null,
      "NewDocumentToSignBinaryDocumentUrl": null,
      "ClearDocumentToSignBinaryDocumentFile": null,
      "DocumentToSendBinaryDocumentFileName": null,
      "NewDocumentToSendBinaryDocumentUrl": null,
      "ClearDocumentToSendBinaryDocumentFile": null,
      "ProposalFileFileName": null,
      "NewProposalFileUrl": null,
      "ClearProposalFileFile": null,
      "TariffId": 0,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": 0,
      "TariffBusinessCurrencyCode": null,
      "Desks": [],
      "Variants": [],
      "ContractTerm": null,
      "ExpirationDate": null,
      "DiscountCodeId": null,
      "StartDateLocal": null,
      "SentOn": null,
      "SentOnLocal": null,
      "CustomerLastOpenedDate": null,
      "DoNotIssueInvoice": false,
      "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": "Proposal Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Reference",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Proposals
Source: https://learn.nexudus.com/rest-api/billing/get-proposals-batch

GET /api/billing/proposals/?id=[{id1},{id2},{id3}]
Retrieve multiple Proposal records by their Ids in a single request.

Fetch several Proposal records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Proposal-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Proposal Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposals/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Proposal records. Each record has the same structure as the response from the [Get one Proposal](/rest-api/billing/get-proposals-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Proposal. The following fields are **not populated** in the response: `Notes`, `DocumentToSignHtml`, `DocumentToSendHtml`, `Price`, `StartDate`, `CancellationLimitDays`, `CancellationDate`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one Proposal](/rest-api/billing/get-proposals-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "IssuedById": 0,
    "IssuedByName": null,
    "IssuedByCurrencyCode": null,
    "ResponsibleId": 0,
    "ResponsibleFullName": null,
    "CoworkerId": 0,
    "CoworkerCoworkerType": null,
    "CoworkerFullName": null,
    "CoworkerCompanyName": null,
    "CoworkerBillingName": null,
    "Reference": "",
    "ProposalStatus": 0,
    "DocumentToSendId": null,
    "DocumentToSignId": null,
    "DocumentToSignBinaryDocumentFileName": null,
    "NewDocumentToSignBinaryDocumentUrl": null,
    "ClearDocumentToSignBinaryDocumentFile": null,
    "DocumentToSendBinaryDocumentFileName": null,
    "NewDocumentToSendBinaryDocumentUrl": null,
    "ClearDocumentToSendBinaryDocumentFile": null,
    "ProposalFileFileName": null,
    "NewProposalFileUrl": null,
    "ClearProposalFileFile": null,
    "TariffId": 0,
    "TariffName": null,
    "TariffInvoiceEvery": null,
    "TariffInvoiceEveryWeeks": null,
    "TariffPrice": 0,
    "TariffBusinessCurrencyCode": null,
    "Desks": [],
    "Variants": [],
    "ContractTerm": null,
    "ExpirationDate": null,
    "DiscountCodeId": null,
    "StartDateLocal": null,
    "SentOn": null,
    "SentOnLocal": null,
    "CustomerLastOpenedDate": null,
    "DoNotIssueInvoice": false,
    "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": "Proposal Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Proposal
Source: https://learn.nexudus.com/rest-api/billing/get-proposals-by-id

GET /api/billing/proposals/{id}
Retrieve a single Proposal record by its Id.

A **Proposal** bundles one or more contracts (`ProposalContract` records) that are presented to a customer for review and acceptance. Each `ProposalContract` carries the same properties as a `CoworkerContract` and becomes one when the proposal is accepted.

When a Proposal is created, a `ProposalContract` is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (`TariffId`, `Desks`, `Variants`, `Price`, `StartDate`, `CancellationLimitDays`, `ContractTerm`, `CancellationDate`, `ExpirationDate`, `BillingDay`, `Quantity`) become read-only — they are all `createOnly`. Subsequent edits to those values must be made via the associated `ProposalContract`. Additional `ProposalContract` records can also be added.

Proposals support three optional attachments:

* **DocumentToSendId** — a `DocumentTemplate` entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
* **DocumentToSignId** — a `DocumentTemplate` entity used to generate a document for e-signature.
* **ProposalFile** — a file shown as a downloadable link before the proposal is accepted.

Set `DoNotIssueInvoice` to control whether the first invoice is issued automatically when the proposal is accepted.

## Authentication

<Note>
  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 **`Proposal-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Proposal record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="IssuedById" type="integer">
  ID of the issued by linked to this record.
</ResponseField>

<ResponseField name="IssuedByName" type="string">
  Issuing business name.
</ResponseField>

<ResponseField name="IssuedByCurrencyCode" type="string">
  Issuing business currency code.
</ResponseField>

<ResponseField name="ResponsibleId" type="integer">
  ID of the responsible linked to this record.
</ResponseField>

<ResponseField name="ResponsibleFullName" type="string">
  Responsible person full name.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Coworker type.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Coworker full name.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Coworker company name.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Coworker billing name.
</ResponseField>

<ResponseField name="Reference" type="string">
  Proposal reference.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this proposal.
</ResponseField>

<ResponseField name="ProposalStatus" type="integer">
  Proposal status. See `eProposalStatus` enum values: `1` = Draft, `2` = Sent, `3` = Accepted, `4` = Rejected.
</ResponseField>

<ResponseField name="DocumentToSendId" type="integer">
  ID of the document to send linked to this record.
</ResponseField>

<ResponseField name="DocumentToSignId" type="integer">
  ID of the document to sign linked to this record.
</ResponseField>

<ResponseField name="DocumentToSignHtml" type="string">
  The document to sign html value for this proposal.
</ResponseField>

<ResponseField name="DocumentToSignBinaryDocumentFileName" type="string">
  Current file name of the document to sign binary document (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewDocumentToSignBinaryDocumentUrl" type="string">
  URL of a new file to upload as the document to sign binary document.
</ResponseField>

<ResponseField name="ClearDocumentToSignBinaryDocumentFile" type="boolean">
  Set to true to remove the current document to sign binary document file.
</ResponseField>

<ResponseField name="DocumentToSendHtml" type="string">
  The document to send html value for this proposal.
</ResponseField>

<ResponseField name="DocumentToSendBinaryDocumentFileName" type="string">
  Current file name of the document to send binary document (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewDocumentToSendBinaryDocumentUrl" type="string">
  URL of a new file to upload as the document to send binary document.
</ResponseField>

<ResponseField name="ClearDocumentToSendBinaryDocumentFile" type="boolean">
  Set to true to remove the current document to send binary document file.
</ResponseField>

<ResponseField name="ProposalFileFileName" type="string">
  Current file name of the proposal file (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewProposalFileUrl" type="string">
  URL of a new file to upload as the proposal file.
</ResponseField>

<ResponseField name="ClearProposalFileFile" type="boolean">
  Set to true to remove the current proposal file file.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="TariffInvoiceEvery" type="string">
  Tariff invoice frequency.
</ResponseField>

<ResponseField name="TariffInvoiceEveryWeeks" type="string">
  Tariff invoice frequency in weeks.
</ResponseField>

<ResponseField name="TariffPrice" type="number">
  Tariff price.
</ResponseField>

<ResponseField name="TariffBusinessCurrencyCode" type="string">
  Tariff business currency code.
</ResponseField>

<ResponseField name="Desks" type="integer[]">
  List of desks linked to this record.
</ResponseField>

<ResponseField name="Variants" type="integer[]">
  List of variants linked to this record.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="StartDate" type="string">
  Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="CancellationLimitDays" type="integer">
  Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="ContractTerm" type="string">
  Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="CancellationDate" type="string">
  Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="ExpirationDate" type="string">
  Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="BillingDay" type="integer">
  Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="DiscountCodeId" type="integer">
  ID of the discount code linked to this record.
</ResponseField>

<ResponseField name="StartDateLocal" type="string">
  Date/time value for start date local.
</ResponseField>

<ResponseField name="SentOn" type="string">
  Date the proposal was sent.
</ResponseField>

<ResponseField name="SentOnLocal" type="string">
  Date/time value for sent on local.
</ResponseField>

<ResponseField name="CustomerLastOpenedDate" type="string">
  Date the customer last opened the proposal.
</ResponseField>

<ResponseField name="DoNotIssueInvoice" type="boolean">
  If true, the first invoice is not issued automatically when the proposal is accepted.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "IssuedById": 0,
  "IssuedByName": null,
  "IssuedByCurrencyCode": null,
  "ResponsibleId": 0,
  "ResponsibleFullName": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "Reference": "",
  "Notes": null,
  "ProposalStatus": 0,
  "DocumentToSendId": null,
  "DocumentToSignId": null,
  "DocumentToSignHtml": null,
  "DocumentToSignBinaryDocumentFileName": null,
  "NewDocumentToSignBinaryDocumentUrl": null,
  "ClearDocumentToSignBinaryDocumentFile": null,
  "DocumentToSendHtml": null,
  "DocumentToSendBinaryDocumentFileName": null,
  "NewDocumentToSendBinaryDocumentUrl": null,
  "ClearDocumentToSendBinaryDocumentFile": null,
  "ProposalFileFileName": null,
  "NewProposalFileUrl": null,
  "ClearProposalFileFile": null,
  "TariffId": 0,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": 0,
  "TariffBusinessCurrencyCode": null,
  "Desks": [],
  "Variants": [],
  "Price": null,
  "StartDate": null,
  "CancellationLimitDays": null,
  "ContractTerm": null,
  "CancellationDate": null,
  "ExpirationDate": null,
  "BillingDay": 0,
  "Quantity": 0,
  "DiscountCodeId": null,
  "StartDateLocal": null,
  "SentOn": null,
  "SentOnLocal": null,
  "CustomerLastOpenedDate": null,
  "DoNotIssueInvoice": false,
  "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": "Proposal Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ProposalSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-proposalschedules

GET /api/billing/proposalschedules
Search and list ProposalSchedule records with filtering, sorting, and pagination.

A **ProposalSchedule** defines the overall timeline and milestones for a proposal, including validity period and follow-up dates.

## Authentication

<Note>
  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 **`ProposalSchedule-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the proposal linked to this record.
</ParamField>

<ParamField type="string">
  Filter by proposal quantity.
</ParamField>

<ParamField type="string">
  Filter by proposal tariff name.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker ID.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker full name.
</ParamField>

<ParamField type="string">
  Filter by proposal coworker billing name.
</ParamField>

<ParamField type="string">
  Filter by optional notes or comments about this proposal schedule.
</ParamField>

<ParamField type="number">
  Filter by scheduled price.
</ParamField>

<ParamField type="string">
  Filter by date to apply.
</ParamField>

<ParamField type="boolean">
  Filter by whether the schedule has been applied.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by scheduled price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by scheduled price less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date to apply greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date to apply less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalschedules?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalschedules',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalschedules?ProposalSchedule_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules?' + new URLSearchParams({
      ProposalSchedule_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalschedules',
      params={
          'ProposalSchedule_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalschedules?from_ProposalSchedule_UpdatedOn=2025-01-01T00:00&to_ProposalSchedule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules?' + new URLSearchParams({
      from_ProposalSchedule_UpdatedOn: '2025-01-01T00:00',
      to_ProposalSchedule_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalschedules',
      params={
          'from_ProposalSchedule_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalSchedule_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ProposalSchedule[]">
  The list of ProposalSchedule records matching the query. See the [Get one ProposalSchedule](/rest-api/billing/get-proposalschedules-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ProposalSchedule. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalSchedule](/rest-api/billing/get-proposalschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ProposalId": 0,
      "ProposalQuantity": null,
      "ProposalTariffName": null,
      "ProposalCoworkerId": null,
      "ProposalCoworkerFullName": null,
      "ProposalCoworkerBillingName": null,
      "Price": null,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Applied": false,
      "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": "ProposalSchedule Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ProposalSchedules
Source: https://learn.nexudus.com/rest-api/billing/get-proposalschedules-batch

GET /api/billing/proposalschedules/?id=[{id1},{id2},{id3}]
Retrieve multiple ProposalSchedule records by their Ids in a single request.

Fetch several ProposalSchedule records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ProposalSchedule-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ProposalSchedule Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalschedules/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposalschedules/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ProposalSchedule records. Each record has the same structure as the response from the [Get one ProposalSchedule](/rest-api/billing/get-proposalschedules-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each ProposalSchedule. The following fields are **not populated** in the response: `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalSchedule](/rest-api/billing/get-proposalschedules-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "ProposalId": 0,
    "ProposalQuantity": null,
    "ProposalTariffName": null,
    "ProposalCoworkerId": null,
    "ProposalCoworkerFullName": null,
    "ProposalCoworkerBillingName": null,
    "Price": null,
    "ApplyOn": "2025-01-15T10:30:00Z",
    "Applied": false,
    "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": "ProposalSchedule Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ProposalSchedule
Source: https://learn.nexudus.com/rest-api/billing/get-proposalschedules-by-id

GET /api/billing/proposalschedules/{id}
Retrieve a single ProposalSchedule record by its Id.

A **ProposalSchedule** defines the overall timeline and milestones for a proposal, including validity period and follow-up dates.

## Authentication

<Note>
  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 **`ProposalSchedule-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ProposalSchedule record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposalschedules/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ProposalId" type="integer">
  ID of the proposal linked to this record.
</ResponseField>

<ResponseField name="ProposalQuantity" type="string">
  Proposal quantity.
</ResponseField>

<ResponseField name="ProposalTariffName" type="string">
  Proposal tariff name.
</ResponseField>

<ResponseField name="ProposalCoworkerId" type="string">
  Proposal coworker ID.
</ResponseField>

<ResponseField name="ProposalCoworkerFullName" type="string">
  Proposal coworker full name.
</ResponseField>

<ResponseField name="ProposalCoworkerBillingName" type="string">
  Proposal coworker billing name.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or comments about this proposal schedule.
</ResponseField>

<ResponseField name="Price" type="number">
  Scheduled price.
</ResponseField>

<ResponseField name="ApplyOn" type="string">
  Date to apply.
</ResponseField>

<ResponseField name="Applied" type="boolean">
  Whether the schedule has been applied.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ProposalId": 0,
  "ProposalQuantity": null,
  "ProposalTariffName": null,
  "ProposalCoworkerId": null,
  "ProposalCoworkerFullName": null,
  "ProposalCoworkerBillingName": null,
  "Notes": null,
  "Price": null,
  "ApplyOn": "2025-01-15T10:30:00Z",
  "Applied": false,
  "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": "ProposalSchedule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search ResourceProducts
Source: https://learn.nexudus.com/rest-api/billing/get-resourceproducts

GET /api/billing/resourceproducts
Search and list ResourceProduct records with filtering, sorting, and pagination.

A **ResourceProduct** links a product to a resource, enabling products to be offered as add-ons when booking that resource (e.g. catering, AV equipment, room setup).

## Authentication

<Note>
  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 **`ResourceProduct-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the resource linked to this record.
</ParamField>

<ParamField type="string">
  Filter by resource name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="string">
  Filter by product currency code.
</ParamField>

<ParamField type="boolean">
  Filter by whether to invoice in minutes.
</ParamField>

<ParamField type="boolean">
  Filter by whether to request quantity.
</ParamField>

<ParamField type="boolean">
  Filter by whether the resource product is visible.
</ParamField>

<ParamField type="number">
  Filter by price override.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/resourceproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/resourceproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/resourceproducts?ResourceProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts?' + new URLSearchParams({
      ResourceProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/resourceproducts',
      params={
          'ResourceProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/resourceproducts?from_ResourceProduct_UpdatedOn=2025-01-01T00:00&to_ResourceProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts?' + new URLSearchParams({
      from_ResourceProduct_UpdatedOn: '2025-01-01T00:00',
      to_ResourceProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/resourceproducts',
      params={
          'from_ResourceProduct_UpdatedOn': '2025-01-01T00:00',
          'to_ResourceProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="ResourceProduct[]">
  The list of ResourceProduct records matching the query. See the [Get one ResourceProduct](/rest-api/billing/get-resourceproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ResourceId": 0,
      "ResourceName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductCurrencyCode": null,
      "InvoiceInMinutes": false,
      "RequestQuantity": false,
      "Visible": false,
      "Price": 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": "ResourceProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple ResourceProducts
Source: https://learn.nexudus.com/rest-api/billing/get-resourceproducts-batch

GET /api/billing/resourceproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple ResourceProduct records by their Ids in a single request.

Fetch several ResourceProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`ResourceProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of ResourceProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/resourceproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/resourceproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of ResourceProduct records. Each record has the same structure as the response from the [Get one ResourceProduct](/rest-api/billing/get-resourceproducts-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ResourceId": 0,
    "ResourceName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductCurrencyCode": null,
    "InvoiceInMinutes": false,
    "RequestQuantity": false,
    "Visible": false,
    "Price": 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": "ResourceProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one ResourceProduct
Source: https://learn.nexudus.com/rest-api/billing/get-resourceproducts-by-id

GET /api/billing/resourceproducts/{id}
Retrieve a single ResourceProduct record by its Id.

A **ResourceProduct** links a product to a resource, enabling products to be offered as add-ons when booking that resource (e.g. catering, AV equipment, room setup).

## Authentication

<Note>
  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 **`ResourceProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ResourceProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/resourceproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ResourceId" type="integer">
  ID of the resource linked to this record.
</ResponseField>

<ResponseField name="ResourceName" type="string">
  Resource name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  Product currency code.
</ResponseField>

<ResponseField name="InvoiceInMinutes" type="boolean">
  Whether to invoice in minutes.
</ResponseField>

<ResponseField name="RequestQuantity" type="boolean">
  Whether to request quantity.
</ResponseField>

<ResponseField name="Visible" type="boolean">
  Whether the resource product is visible.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ResourceId": 0,
  "ResourceName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "InvoiceInMinutes": false,
  "RequestQuantity": false,
  "Visible": false,
  "Price": 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": "ResourceProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-tariffbookingcredits

GET /api/billing/tariffbookingcredits
Search and list TariffBookingCredit records with filtering, sorting, and pagination.

A **TariffBookingCredit** represents an amount of credit linked to a plan (`Tariff`). When a customer's contract on that plan renews, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ServiceRenewalTime` to control how often the credit is renewed (e.g. weekly, monthly).

## Authentication

<Note>
  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 **`TariffBookingCredit-List`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="string">
  Filter by credit name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="string">
  Filter by tariff business currency code.
</ParamField>

<ParamField type="number">
  Filter by credit amount.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer">
  Filter by service renewal time period.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="boolean">
  Filter by whether this universal credit applies to other charges.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by credit amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by credit amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits?TariffBookingCredit_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits?' + new URLSearchParams({
      TariffBookingCredit_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
      params={
          'TariffBookingCredit_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits?from_TariffBookingCredit_UpdatedOn=2025-01-01T00:00&to_TariffBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits?' + new URLSearchParams({
      from_TariffBookingCredit_UpdatedOn: '2025-01-01T00:00',
      to_TariffBookingCredit_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
      params={
          'from_TariffBookingCredit_UpdatedOn': '2025-01-01T00:00',
          'to_TariffBookingCredit_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffBookingCredit[]">
  The list of TariffBookingCredit records matching the query. See the [Get one TariffBookingCredit](/rest-api/billing/get-tariffbookingcredits-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each TariffBookingCredit. The following fields are **not populated** in the `Records[]` response: `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one TariffBookingCredit](/rest-api/billing/get-tariffbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "Name": "",
      "TariffId": 0,
      "TariffName": null,
      "TariffBusinessCurrencyCode": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "Credit": 0,
      "EventCategories": [],
      "ServiceRenewalTime": 0,
      "ElegiblePasses": [],
      "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": "TariffBookingCredit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffBookingCredits
Source: https://learn.nexudus.com/rest-api/billing/get-tariffbookingcredits-batch

GET /api/billing/tariffbookingcredits/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffBookingCredit records by their Ids in a single request.

Fetch several TariffBookingCredit records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffBookingCredit-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffBookingCredit Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffBookingCredit records. Each record has the same structure as the response from the [Get one TariffBookingCredit](/rest-api/billing/get-tariffbookingcredits-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each TariffBookingCredit. The following fields are **not populated** in the response: `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one TariffBookingCredit](/rest-api/billing/get-tariffbookingcredits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "Name": "",
    "TariffId": 0,
    "TariffName": null,
    "TariffBusinessCurrencyCode": null,
    "ElegibleResourceTypes": [],
    "ElegibleProducts": [],
    "ElegibleTariffs": [],
    "Credit": 0,
    "EventCategories": [],
    "ServiceRenewalTime": 0,
    "ElegiblePasses": [],
    "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": "TariffBookingCredit Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/get-tariffbookingcredits-by-id

GET /api/billing/tariffbookingcredits/{id}
Retrieve a single TariffBookingCredit record by its Id.

A **TariffBookingCredit** represents an amount of credit linked to a plan (`Tariff`). When a customer's contract on that plan renews, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ServiceRenewalTime` to control how often the credit is renewed (e.g. weekly, monthly).

## Authentication

<Note>
  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 **`TariffBookingCredit-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffBookingCredit record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Name" type="string">
  Credit name.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="TariffBusinessCurrencyCode" type="string">
  Tariff business currency code.
</ResponseField>

<ResponseField name="ElegibleResourceTypes" type="integer[]">
  List of elegible resource types linked to this record.
</ResponseField>

<ResponseField name="ElegibleProducts" type="integer[]">
  List of elegible products linked to this record.
</ResponseField>

<ResponseField name="ElegibleTariffs" type="integer[]">
  List of elegible tariffs linked to this record.
</ResponseField>

<ResponseField name="Credit" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="CaneBeUsedForBookings" type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ResponseField>

<ResponseField name="CaneBeUsedForEvents" type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ResponseField>

<ResponseField name="EventCategories" type="integer[]">
  List of event categories linked to this record.
</ResponseField>

<ResponseField name="ServiceRenewalTime" type="integer">
  Service renewal time period. See `eTimeSpanWeekMonth` enum values: `1` = Week, `2` = CalendarMonth, `3` = TariffMonth, `4` = Year, `5` = Day.
</ResponseField>

<ResponseField name="IsUniversalCredit" type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ResponseField>

<ResponseField name="ElegiblePasses" type="integer[]">
  List of elegible passes linked to this record.
</ResponseField>

<ResponseField name="AppliesToCharges" type="boolean">
  Whether this universal credit applies to other charges.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "Name": "",
  "TariffId": 0,
  "TariffName": null,
  "TariffBusinessCurrencyCode": null,
  "ElegibleResourceTypes": [],
  "ElegibleProducts": [],
  "ElegibleTariffs": [],
  "Credit": 0,
  "CaneBeUsedForBookings": false,
  "CaneBeUsedForEvents": false,
  "EventCategories": [],
  "ServiceRenewalTime": 0,
  "IsUniversalCredit": false,
  "ElegiblePasses": [],
  "AppliesToCharges": false,
  "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": "TariffBookingCredit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffDefaultDueDates
Source: https://learn.nexudus.com/rest-api/billing/get-tariffdefaultduedates

GET /api/billing/tariffdefaultduedates
Search and list TariffDefaultDueDate records with filtering, sorting, and pagination.

A **TariffDefaultDueDate** configures the default invoice due date settings for a pricing plan (tariff). This controls when invoices generated for customers on this plan are due for payment.

## Authentication

<Note>
  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 **`TariffDefaultDueDate-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by day of month to auto collect.
</ParamField>

<ParamField type="integer">
  Filter by days after invoice to auto collect.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by day of month to auto collect greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of month to auto collect less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by days after invoice to auto collect greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by days after invoice to auto collect less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates?TariffDefaultDueDate_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates?' + new URLSearchParams({
      TariffDefaultDueDate_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
      params={
          'TariffDefaultDueDate_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates?from_TariffDefaultDueDate_UpdatedOn=2025-01-01T00:00&to_TariffDefaultDueDate_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates?' + new URLSearchParams({
      from_TariffDefaultDueDate_UpdatedOn: '2025-01-01T00:00',
      to_TariffDefaultDueDate_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
      params={
          'from_TariffDefaultDueDate_UpdatedOn': '2025-01-01T00:00',
          'to_TariffDefaultDueDate_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffDefaultDueDate[]">
  The list of TariffDefaultDueDate records matching the query. See the [Get one TariffDefaultDueDate](/rest-api/billing/get-tariffdefaultduedates-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each TariffDefaultDueDate. The following fields are **not populated** in the `Records[]` response: `AutoCollectOn`, `AutoCollectAfter`.

  To get all fields, fetch the full record using the [Get one TariffDefaultDueDate](/rest-api/billing/get-tariffdefaultduedates-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Tariffs": [],
      "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": "TariffDefaultDueDate Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffDefaultDueDates
Source: https://learn.nexudus.com/rest-api/billing/get-tariffdefaultduedates-batch

GET /api/billing/tariffdefaultduedates/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffDefaultDueDate records by their Ids in a single request.

Fetch several TariffDefaultDueDate records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffDefaultDueDate-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffDefaultDueDate Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffdefaultduedates/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffDefaultDueDate records. Each record has the same structure as the response from the [Get one TariffDefaultDueDate](/rest-api/billing/get-tariffdefaultduedates-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each TariffDefaultDueDate. The following fields are **not populated** in the response: `AutoCollectOn`, `AutoCollectAfter`.

  To get all fields, fetch the full record using the [Get one TariffDefaultDueDate](/rest-api/billing/get-tariffdefaultduedates-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Tariffs": [],
    "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": "TariffDefaultDueDate Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffDefaultDueDate
Source: https://learn.nexudus.com/rest-api/billing/get-tariffdefaultduedates-by-id

GET /api/billing/tariffdefaultduedates/{id}
Retrieve a single TariffDefaultDueDate record by its Id.

A **TariffDefaultDueDate** configures the default invoice due date settings for a pricing plan (tariff). This controls when invoices generated for customers on this plan are due for payment.

## Authentication

<Note>
  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 **`TariffDefaultDueDate-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffDefaultDueDate record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="AutoCollectOn" type="integer">
  Day of month to auto collect.
</ResponseField>

<ResponseField name="AutoCollectAfter" type="integer">
  Days after invoice to auto collect.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Tariffs": [],
  "AutoCollectOn": null,
  "AutoCollectAfter": 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": "TariffDefaultDueDate Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-tariffextraservices

GET /api/billing/tariffextraservices
Search and list TariffExtraService records with filtering, sorting, and pagination.

A **TariffExtraService** links an extra service (booking rate) to a pricing plan (tariff), defining an included allowance of booking time or printing credits for customers on that plan. The `UsesIncluded` value specifies how much is included.

## Authentication

<Note>
  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 **`TariffExtraService-List`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Filter by extra service name.
</ParamField>

<ParamField type="string">
  Filter by extra service charge period.
</ParamField>

<ParamField type="string">
  Filter by whether extra service is booking credit.
</ParamField>

<ParamField type="string">
  Filter by whether extra service is printing credit.
</ParamField>

<ParamField type="integer">
  Filter by number of uses included.
</ParamField>

<ParamField type="integer">
  Filter by service renewal time period.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by number of uses included greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of uses included less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffextraservices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffextraservices?TariffExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices?' + new URLSearchParams({
      TariffExtraService_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffextraservices',
      params={
          'TariffExtraService_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffextraservices?from_TariffExtraService_UpdatedOn=2025-01-01T00:00&to_TariffExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices?' + new URLSearchParams({
      from_TariffExtraService_UpdatedOn: '2025-01-01T00:00',
      to_TariffExtraService_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffextraservices',
      params={
          'from_TariffExtraService_UpdatedOn': '2025-01-01T00:00',
          'to_TariffExtraService_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffExtraService[]">
  The list of TariffExtraService records matching the query. See the [Get one TariffExtraService](/rest-api/billing/get-tariffextraservices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TariffId": 0,
      "TariffName": null,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceChargePeriod": null,
      "ExtraServiceIsBookingCredit": null,
      "ExtraServiceIsPrintingCredit": null,
      "UsesIncluded": 0,
      "ServiceRenewalTime": 0,
      "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": "TariffExtraService Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffExtraServices
Source: https://learn.nexudus.com/rest-api/billing/get-tariffextraservices-batch

GET /api/billing/tariffextraservices/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffExtraService records by their Ids in a single request.

Fetch several TariffExtraService records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffExtraService-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffExtraService Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffextraservices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffextraservices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffExtraService records. Each record has the same structure as the response from the [Get one TariffExtraService](/rest-api/billing/get-tariffextraservices-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TariffId": 0,
    "TariffName": null,
    "ExtraServiceId": 0,
    "ExtraServiceName": null,
    "ExtraServiceChargePeriod": null,
    "ExtraServiceIsBookingCredit": null,
    "ExtraServiceIsPrintingCredit": null,
    "UsesIncluded": 0,
    "ServiceRenewalTime": 0,
    "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": "TariffExtraService Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffExtraService
Source: https://learn.nexudus.com/rest-api/billing/get-tariffextraservices-by-id

GET /api/billing/tariffextraservices/{id}
Retrieve a single TariffExtraService record by its Id.

A **TariffExtraService** links an extra service (booking rate) to a pricing plan (tariff), defining an included allowance of booking time or printing credits for customers on that plan. The `UsesIncluded` value specifies how much is included.

## Authentication

<Note>
  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 **`TariffExtraService-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffExtraService record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffextraservices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="ExtraServiceId" type="integer">
  ID of the extra service linked to this record.
</ResponseField>

<ResponseField name="ExtraServiceName" type="string">
  Extra service name.
</ResponseField>

<ResponseField name="ExtraServiceChargePeriod" type="string">
  Extra service charge period.
</ResponseField>

<ResponseField name="ExtraServiceIsBookingCredit" type="string">
  Whether extra service is booking credit.
</ResponseField>

<ResponseField name="ExtraServiceIsPrintingCredit" type="string">
  Whether extra service is printing credit.
</ResponseField>

<ResponseField name="UsesIncluded" type="integer">
  Number of uses included.
</ResponseField>

<ResponseField name="ServiceRenewalTime" type="integer">
  Service renewal time period. See `eTimeSpanWeekMonth` enum values: `1` = Week, `2` = CalendarMonth, `3` = TariffMonth, `4` = Year, `5` = Day.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TariffId": 0,
  "TariffName": null,
  "ExtraServiceId": 0,
  "ExtraServiceName": null,
  "ExtraServiceChargePeriod": null,
  "ExtraServiceIsBookingCredit": null,
  "ExtraServiceIsPrintingCredit": null,
  "UsesIncluded": 0,
  "ServiceRenewalTime": 0,
  "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": "TariffExtraService Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffProducts
Source: https://learn.nexudus.com/rest-api/billing/get-tariffproducts

GET /api/billing/tariffproducts
Search and list TariffProduct records with filtering, sorting, and pagination.

A **TariffProduct** links a product to a pricing plan (tariff), making the product automatically included or available as part of that plan's offering.

## Authentication

<Note>
  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 **`TariffProduct-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="string">
  Filter by product business currency code.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffproducts?TariffProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts?' + new URLSearchParams({
      TariffProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffproducts',
      params={
          'TariffProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffproducts?from_TariffProduct_UpdatedOn=2025-01-01T00:00&to_TariffProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts?' + new URLSearchParams({
      from_TariffProduct_UpdatedOn: '2025-01-01T00:00',
      to_TariffProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffproducts',
      params={
          'from_TariffProduct_UpdatedOn': '2025-01-01T00:00',
          'to_TariffProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffProduct[]">
  The list of TariffProduct records matching the query. See the [Get one TariffProduct](/rest-api/billing/get-tariffproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TariffId": 0,
      "TariffName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductBusinessCurrencyCode": 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": "TariffProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffProducts
Source: https://learn.nexudus.com/rest-api/billing/get-tariffproducts-batch

GET /api/billing/tariffproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffProduct records by their Ids in a single request.

Fetch several TariffProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffProduct records. Each record has the same structure as the response from the [Get one TariffProduct](/rest-api/billing/get-tariffproducts-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TariffId": 0,
    "TariffName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductBusinessCurrencyCode": 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": "TariffProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffProduct
Source: https://learn.nexudus.com/rest-api/billing/get-tariffproducts-by-id

GET /api/billing/tariffproducts/{id}
Retrieve a single TariffProduct record by its Id.

A **TariffProduct** links a product to a pricing plan (tariff), making the product automatically included or available as part of that plan's offering.

## Authentication

<Note>
  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 **`TariffProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductBusinessCurrencyCode" type="string">
  Product business currency code.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TariffId": 0,
  "TariffName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductBusinessCurrencyCode": 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": "TariffProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Tariffs
Source: https://learn.nexudus.com/rest-api/billing/get-tariffs

GET /api/billing/tariffs
Search and list Tariff records with filtering, sorting, and pagination.

A **Tariff** (also called a Plan) is a membership plan that customers can sign up to in exchange for access to a coworking space and other benefits. Tariffs are the foundation for contracts — every time a customer signs up to a plan, Nexudus generates a `CoworkerContract` for that member based on the plan's settings.

Plans define billing frequency (in months or weeks via `InvoiceEvery` / `InvoiceEveryWeeks`), pricing, cancellation rules, and limits on check-ins, booking minutes, visitor passes, and hours. Members are invoiced at the end of each billing cycle. Plans can include benefits such as day passes, booking credits, and money credits — these are configured through `CoworkerExtraService` and `Product` entities linked to the contract.

Use `SystemTariffType` to categorise the plan (e.g. FullTimeHotDesk, VirtualOffice, Storage). Use `Visible` to control whether the plan appears on the members portal. Plans can optionally require identity checks before activation, enforce contract terms, support pausing, and define delivery handling preferences for virtual office mail.

When you edit a plan, changes impact all members signed up to that plan. To customise settings for an individual member, edit their `CoworkerContract` instead.

## Authentication

<Note>
  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 **`Tariff-List`** role.
</Note>

## Enums

<Accordion title="eTariffType — SystemTariffType values">
  | Value | Name                  |
  | ----- | --------------------- |
  | 1     | FullTimePrivateOffice |
  | 2     | PartTimePrivateOffice |
  | 3     | FullTimeDedicatedDesk |
  | 4     | PartTimeDedicatedDesk |
  | 5     | FullTimeHotDesk       |
  | 6     | PartTimeHotDesk       |
  | 7     | FullTimeOther         |
  | 8     | PartTimeOther         |
  | 9     | Storage               |
  | 10    | VirtualOffice         |
  | 11    | Virtual               |
  | 99    | Other                 |
</Accordion>

<Accordion title="eTariffBookingDueDateStrategy — BookingDueDateStrategy values">
  | Value | Name                |
  | ----- | ------------------- |
  | 1     | RenewalDate         |
  | 2     | BookingEndDate      |
  | 3     | BookingCreationDate |
  | 4     | NextNthOfMonth      |
</Accordion>

<Accordion title="eIdentityCheckProvider — AddressIdentityCheckProvider values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Manual         |
  | 2     | StripeIdentity |
</Accordion>

<Accordion title="eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Never         |
  | 2     | Every3Months  |
  | 3     | Every6Months  |
  | 4     | Every12Months |
  | 5     | Every24Months |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by business name.
</ParamField>

<ParamField type="string">
  Filter by plan name.
</ParamField>

<ParamField type="integer">
  Filter by category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.
</ParamField>

<ParamField type="number">
  Filter by recurring price charged per billing cycle.
</ParamField>

<ParamField type="integer">
  Filter by day of the month on which invoices are generated for members on this plan.
</ParamField>

<ParamField type="boolean">
  Filter by whether the plan is visible to customers on the members portal and mobile app.
</ParamField>

<ParamField type="boolean">
  Filter by whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
</ParamField>

<ParamField type="string">
  Filter by custom notes provided to the AI assistant when describing this plan.
</ParamField>

<ParamField type="boolean">
  Filter by whether to show the plan price to the AI assistant.
</ParamField>

<ParamField type="number">
  Filter by custom price shown to the AI assistant instead of the actual price.
</ParamField>

<ParamField type="boolean">
  Filter by whether this plan uses time passes for check-in access.
</ParamField>

<ParamField type="string">
  Filter by plan description shown to customers.
</ParamField>

<ParamField type="string">
  Filter by custom text shown on the invoice line instead of the plan name.
</ParamField>

<ParamField type="number">
  Filter by one-off fee charged when a customer first signs up to this plan.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by currency code.
</ParamField>

<ParamField type="integer">
  Filter by standard tax rate applied to charges on this plan.
</ParamField>

<ParamField type="integer">
  Filter by reduced tax rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Filter by tax-exempt rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Filter by financial account used for revenue tracking.
</ParamField>

<ParamField type="string">
  Filter by terms and conditions text that members must accept when signing up.
</ParamField>

<ParamField type="string">
  Filter by file name of the contract document template.
</ParamField>

<ParamField type="string">
  Filter by uRL to upload a new contract document template.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the uploaded contract document file.
</ParamField>

<ParamField type="integer">
  Filter by number of days' notice required before a contract can be cancelled.
</ParamField>

<ParamField type="integer">
  Filter by display order on the members portal (lower numbers appear first).
</ParamField>

<ParamField type="string">
  Filter by group name used to visually group plans together on the members portal.
</ParamField>

<ParamField type="boolean">
  Filter by prevents members from cancelling this plan through the members portal.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of members that can be signed up to this plan at any time.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days a contract must be active before it can be cancelled.
</ParamField>

<ParamField type="integer">
  Filter by default minimum contract term in months for new sign-ups.
</ParamField>

<ParamField type="integer">
  Filter by number of days after contract cancellation before the member account is deactivated.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins included per billing cycle.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per month.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per week.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per month.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per week.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per day.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours included per billing cycle.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per month.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per week.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per week.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per month.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for extra services.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for time passes.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for charges.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in months. Set to 0 if billing by weeks instead.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in weeks. Set to 0 if billing by months instead.
</ParamField>

<ParamField type="integer">
  Filter by number of days after which the contract is automatically cancelled if not paid.
</ParamField>

<ParamField type="integer">
  Filter by number of billing cycles to invoice in advance.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used to align billing cycles when prorating.
</ParamField>

<ParamField type="integer">
  Filter by number of days before the prorate day to start prorating.
</ParamField>

<ParamField type="boolean">
  Filter by whether to prorate the final invoice when a contract is cancelled mid-cycle.
</ParamField>

<ParamField type="integer">
  Filter by number of days to extend a contract after payment is received.
</ParamField>

<ParamField type="boolean">
  Filter by whether to exclude this plan's charges from member invoices.
</ParamField>

<ParamField type="boolean">
  Filter by whether to automatically generate invoices at the end of each billing cycle.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N months.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N weeks.
</ParamField>

<ParamField type="number">
  Filter by minimum total amount charged per billing cycle regardless of usage.
</ParamField>

<ParamField type="boolean">
  Filter by whether time pass charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Filter by whether extra service charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Filter by whether event charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Filter by whether the plan is archived and no longer available for new sign-ups.
</ParamField>

<ParamField type="boolean">
  Filter by whether the plan is starred (highlighted) on the members portal.
</ParamField>

<ParamField type="boolean">
  Filter by whether new sign-ups are kept on hold until manually approved.
</ParamField>

<ParamField type="boolean">
  Filter by whether members can pause their contract on this plan.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a contract can be paused per year.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of billing cycles a contract can be paused for.
</ParamField>

<ParamField type="integer">
  Filter by strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth.
</ParamField>

<ParamField type="number">
  Filter by calculated total price at sign-up including the plan price and sign-up fee.
</ParamField>

<ParamField type="number">
  Filter by calculated total recurring price per billing cycle.
</ParamField>

<ParamField type="boolean">
  Filter by whether this is a virtual office plan with mail handling features.
</ParamField>

<ParamField type="boolean">
  Filter by whether to keep the contract on hold until all required identity checks are completed.
</ParamField>

<ParamField type="boolean">
  Filter by whether to request an address identity check from members signing up to this plan.
</ParamField>

<ParamField type="string">
  Filter by instructions shown to members when completing the address identity check.
</ParamField>

<ParamField type="integer">
  Filter by provider used for address identity checks: Manual or StripeIdentity.
</ParamField>

<ParamField type="boolean">
  Filter by whether to keep the contract paused if the address identity check reveals a mismatch.
</ParamField>

<ParamField type="integer">
  Filter by how often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
</ParamField>

<ParamField type="boolean">
  Filter by whether to request an identity (ID document) check from members signing up to this plan.
</ParamField>

<ParamField type="integer">
  Filter by provider used for identity checks: Manual or StripeIdentity.
</ParamField>

<ParamField type="integer">
  Filter by how often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
</ParamField>

<ParamField type="string">
  Filter by instructions shown to members when completing the identity check.
</ParamField>

<ParamField type="boolean">
  Filter by whether to request an AML check from members signing up to this plan.
</ParamField>

<ParamField type="boolean">
  Filter by whether to enable AML checks against the OpenSanctions dataset.
</ParamField>

<ParamField type="boolean">
  Filter by whether to enable AML checks against the Pappers dataset.
</ParamField>

<ParamField type="string">
  Filter by which OpenSanctions dataset to check against for AML screening (e.g. 'default').
</ParamField>

<ParamField type="number">
  Filter by score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7.
</ParamField>

<ParamField type="boolean">
  Filter by whether to email the onboarding form to new members signing up to this plan.
</ParamField>

<ParamField type="integer">
  Filter by iD of the onboarding form page sent to new members.
</ParamField>

<ParamField type="string">
  Filter by form page name.
</ParamField>

<ParamField type="integer">
  Filter by allowed handling preferences for mail deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by allowed handling preferences for parcel deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by allowed handling preferences for check deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by allowed handling preferences for publicity deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by allowed handling preferences for other deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by maximum number of days deliveries are stored before being returned (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by maximum number of company name aliases allowed for mail handling (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by maximum number of mail recipients allowed (virtual office).
</ParamField>

<ParamField type="integer">
  Filter by maximum number of forwarding addresses allowed (virtual office).
</ParamField>

<ParamField type="boolean">
  Filter by whether to automatically transfer mail handling products to the member's contract.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by recurring price charged per billing cycle greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by recurring price charged per billing cycle less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month on which invoices are generated for members on this plan greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month on which invoices are generated for members on this plan less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by custom price shown to the AI assistant instead of the actual price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by custom price shown to the AI assistant instead of the actual price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by one-off fee charged when a customer first signs up to this plan greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by one-off fee charged when a customer first signs up to this plan less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days' notice required before a contract can be cancelled greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days' notice required before a contract can be cancelled less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order on the members portal (lower numbers appear first) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order on the members portal (lower numbers appear first) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of members that can be signed up to this plan at any time greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of members that can be signed up to this plan at any time less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days a contract must be active before it can be cancelled greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minimum number of days a contract must be active before it can be cancelled less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by default minimum contract term in months for new sign-ups greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by default minimum contract term in months for new sign-ups less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after contract cancellation before the member account is deactivated greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after contract cancellation before the member account is deactivated less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins included per billing cycle greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins included per billing cycle less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per month greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per month less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per week greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of check-ins allowed per week less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per month greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per month less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per week greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per week less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per day greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of visitor passes allowed per day less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours included per billing cycle greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours included per billing cycle less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per month greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per month less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per week greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of hours allowed per week less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per week greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per week less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per month greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum booking minutes allowed per month less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for extra services greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for extra services less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for time passes greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for time passes less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for charges greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by discount percentage for charges less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in months. Set to 0 if billing by weeks instead greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in months. Set to 0 if billing by weeks instead less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in weeks. Set to 0 if billing by months instead greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing cycle length in weeks. Set to 0 if billing by months instead less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after which the contract is automatically cancelled if not paid greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after which the contract is automatically cancelled if not paid less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of billing cycles to invoice in advance greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of billing cycles to invoice in advance less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used to align billing cycles when prorating greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used to align billing cycles when prorating less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days before the prorate day to start prorating greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days before the prorate day to start prorating less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days to extend a contract after payment is received greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days to extend a contract after payment is received less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N months greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N months less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N weeks greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by raise invoice every N weeks less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by minimum total amount charged per billing cycle regardless of usage greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by minimum total amount charged per billing cycle regardless of usage less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a contract can be paused per year greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of times a contract can be paused per year less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of billing cycles a contract can be paused for greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of billing cycles a contract can be paused for less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by day of the month used when BookingDueDateStrategy is NextNthOfMonth less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by calculated total price at sign-up including the plan price and sign-up fee greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by calculated total price at sign-up including the plan price and sign-up fee less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by calculated total recurring price per billing cycle greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by calculated total recurring price per billing cycle less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7 greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7 less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of days deliveries are stored before being returned (virtual office) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of days deliveries are stored before being returned (virtual office) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of company name aliases allowed for mail handling (virtual office) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of company name aliases allowed for mail handling (virtual office) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of mail recipients allowed (virtual office) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of mail recipients allowed (virtual office) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of forwarding addresses allowed (virtual office) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of forwarding addresses allowed (virtual office) less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffs?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffs',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffs?Tariff_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({
      Tariff_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffs',
      params={
          'Tariff_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffs?from_Tariff_UpdatedOn=2025-01-01T00:00&to_Tariff_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs?' + new URLSearchParams({
      from_Tariff_UpdatedOn: '2025-01-01T00:00',
      to_Tariff_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffs',
      params={
          'from_Tariff_UpdatedOn': '2025-01-01T00:00',
          'to_Tariff_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Tariff[]">
  The list of Tariff records matching the query. See the [Get one Tariff](/rest-api/billing/get-tariffs-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Tariff. The following fields are **not populated** in the `Records[]` response: `Description`, `TermsAndConditions`, `AddressIdentityCheckDescription`, `IdentityCheckDescription`.

  To get all fields, fetch the full record using the [Get one Tariff](/rest-api/billing/get-tariffs-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "SystemTariffType": 0,
      "Price": 0,
      "DefaultInvoicingDay": null,
      "Visible": false,
      "AvailableToAi": false,
      "NotesForAi": null,
      "ShowPriceForAi": false,
      "PriceForAi": null,
      "UseTimePasses": false,
      "InvoiceLineDisplayAs": null,
      "SignUpFee": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "ContractDocumentFileName": null,
      "NewContractDocumentUrl": null,
      "ClearContractDocumentFile": null,
      "CancellationPeriod": 0,
      "DisplayOrder": 0,
      "GroupName": null,
      "DisablePortalCancellations": false,
      "SubscribersLimit": null,
      "CancellationLimitDays": null,
      "DefaultContractTerm": null,
      "CancelMemeberAccountAfter": null,
      "CheckinPricePlanLimit": null,
      "CheckinMonthLimit": null,
      "CheckinWeekLimit": null,
      "VisitorMonthLimit": null,
      "VisitorWeekLimit": null,
      "VisitorDayLimit": null,
      "HoursPricePlanLimit": null,
      "HoursMonthLimit": null,
      "HoursWeekLimit": null,
      "BookingMinuteWeekLimit": null,
      "BookingMinuteMonthLimit": null,
      "DiscountExtraServices": null,
      "DiscountTimePasses": null,
      "DiscountCharges": null,
      "InvoiceEvery": 0,
      "InvoiceEveryWeeks": 0,
      "AutoCancelAfter": null,
      "AdvanceInvoiceCycles": null,
      "ProrateDayOfMonth": null,
      "ProrateDaysBefore": null,
      "ProrateCancellations": false,
      "ChargeAndExtend": null,
      "ExcludeFromInvoice": null,
      "AutoRaiseInvoices": false,
      "RaiseInvoiceEvery": null,
      "RaiseInvoiceEveryWeeks": null,
      "MinimumPrice": null,
      "MinimumPriceIncludeTimePasses": false,
      "MinimumPriceIncludeExtraServices": false,
      "MinimumPriceIncludeEvents": false,
      "Archived": false,
      "Starred": false,
      "KeepNewAccountsOnHold": false,
      "CanBePaused": false,
      "PauseYearlyLimit": null,
      "PauseCyclesLimit": null,
      "BookingDueDateStrategy": 0,
      "BookingDueDateDayOfMonth": null,
      "TotalSignUpPrice": 0,
      "TotalPrice": 0,
      "IsVirtualOffice": false,
      "WaitForIdentityChecksToActivate": false,
      "RequestAddressIdentityCheck": false,
      "AddressIdentityCheckProvider": 0,
      "KeepPausedIfAddressMismatch": false,
      "AddressIdentityCheckRepeatPattern": 0,
      "RequestIdentityCheck": false,
      "IdentityCheckProvider": 0,
      "IdentityCheckRepeatPattern": 0,
      "RequestAmlCheck": false,
      "AmlCheckOpenSanctionsEnabled": false,
      "AmlCheckPappersEnabled": false,
      "AmlCheckOpenSanctionsDataset": null,
      "AmlCheckScoreThreshold": null,
      "SendOnBoardingFormByEmail": false,
      "FormPageId": null,
      "FormPageName": null,
      "ProductsStore": [],
      "ProductsForward": [],
      "ProductsRecycle": [],
      "ProductsShred": [],
      "ProductsScan": [],
      "ProductsReturn": [],
      "ProductsDeposit": [],
      "ProductsCollect": [],
      "DeliveryPreferencesMail": 0,
      "DeliveryPreferencesParcels": 0,
      "DeliveryPreferencesChecks": 0,
      "DeliveryPreferencesPublicity": 0,
      "DeliveryPreferencesOther": 0,
      "MaximumDeliveryStorageDays": null,
      "MaximumCompanyAliases": null,
      "MaximumRecipients": null,
      "MaximumAddresses": null,
      "TransferProductsToContract": false,
      "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": "Tariff Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Tariffs
Source: https://learn.nexudus.com/rest-api/billing/get-tariffs-batch

GET /api/billing/tariffs/?id=[{id1},{id2},{id3}]
Retrieve multiple Tariff records by their Ids in a single request.

Fetch several Tariff records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Tariff-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Tariff Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffs/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffs/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Tariff records. Each record has the same structure as the response from the [Get one Tariff](/rest-api/billing/get-tariffs-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Tariff. The following fields are **not populated** in the response: `Description`, `TermsAndConditions`, `AddressIdentityCheckDescription`, `IdentityCheckDescription`.

  To get all fields, fetch the full record using the [Get one Tariff](/rest-api/billing/get-tariffs-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "Name": "",
    "SystemTariffType": 0,
    "Price": 0,
    "DefaultInvoicingDay": null,
    "Visible": false,
    "AvailableToAi": false,
    "NotesForAi": null,
    "ShowPriceForAi": false,
    "PriceForAi": null,
    "UseTimePasses": false,
    "InvoiceLineDisplayAs": null,
    "SignUpFee": null,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxRateId": null,
    "ReducedTaxRateId": null,
    "ExemptTaxRateId": null,
    "FinancialAccountId": null,
    "ContractDocumentFileName": null,
    "NewContractDocumentUrl": null,
    "ClearContractDocumentFile": null,
    "CancellationPeriod": 0,
    "DisplayOrder": 0,
    "GroupName": null,
    "DisablePortalCancellations": false,
    "SubscribersLimit": null,
    "CancellationLimitDays": null,
    "DefaultContractTerm": null,
    "CancelMemeberAccountAfter": null,
    "CheckinPricePlanLimit": null,
    "CheckinMonthLimit": null,
    "CheckinWeekLimit": null,
    "VisitorMonthLimit": null,
    "VisitorWeekLimit": null,
    "VisitorDayLimit": null,
    "HoursPricePlanLimit": null,
    "HoursMonthLimit": null,
    "HoursWeekLimit": null,
    "BookingMinuteWeekLimit": null,
    "BookingMinuteMonthLimit": null,
    "DiscountExtraServices": null,
    "DiscountTimePasses": null,
    "DiscountCharges": null,
    "InvoiceEvery": 0,
    "InvoiceEveryWeeks": 0,
    "AutoCancelAfter": null,
    "AdvanceInvoiceCycles": null,
    "ProrateDayOfMonth": null,
    "ProrateDaysBefore": null,
    "ProrateCancellations": false,
    "ChargeAndExtend": null,
    "ExcludeFromInvoice": null,
    "AutoRaiseInvoices": false,
    "RaiseInvoiceEvery": null,
    "RaiseInvoiceEveryWeeks": null,
    "MinimumPrice": null,
    "MinimumPriceIncludeTimePasses": false,
    "MinimumPriceIncludeExtraServices": false,
    "MinimumPriceIncludeEvents": false,
    "Archived": false,
    "Starred": false,
    "KeepNewAccountsOnHold": false,
    "CanBePaused": false,
    "PauseYearlyLimit": null,
    "PauseCyclesLimit": null,
    "BookingDueDateStrategy": 0,
    "BookingDueDateDayOfMonth": null,
    "TotalSignUpPrice": 0,
    "TotalPrice": 0,
    "IsVirtualOffice": false,
    "WaitForIdentityChecksToActivate": false,
    "RequestAddressIdentityCheck": false,
    "AddressIdentityCheckProvider": 0,
    "KeepPausedIfAddressMismatch": false,
    "AddressIdentityCheckRepeatPattern": 0,
    "RequestIdentityCheck": false,
    "IdentityCheckProvider": 0,
    "IdentityCheckRepeatPattern": 0,
    "RequestAmlCheck": false,
    "AmlCheckOpenSanctionsEnabled": false,
    "AmlCheckPappersEnabled": false,
    "AmlCheckOpenSanctionsDataset": null,
    "AmlCheckScoreThreshold": null,
    "SendOnBoardingFormByEmail": false,
    "FormPageId": null,
    "FormPageName": null,
    "ProductsStore": [],
    "ProductsForward": [],
    "ProductsRecycle": [],
    "ProductsShred": [],
    "ProductsScan": [],
    "ProductsReturn": [],
    "ProductsDeposit": [],
    "ProductsCollect": [],
    "DeliveryPreferencesMail": 0,
    "DeliveryPreferencesParcels": 0,
    "DeliveryPreferencesChecks": 0,
    "DeliveryPreferencesPublicity": 0,
    "DeliveryPreferencesOther": 0,
    "MaximumDeliveryStorageDays": null,
    "MaximumCompanyAliases": null,
    "MaximumRecipients": null,
    "MaximumAddresses": null,
    "TransferProductsToContract": false,
    "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": "Tariff Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Tariff
Source: https://learn.nexudus.com/rest-api/billing/get-tariffs-by-id

GET /api/billing/tariffs/{id}
Retrieve a single Tariff record by its Id.

A **Tariff** (also called a Plan) is a membership plan that customers can sign up to in exchange for access to a coworking space and other benefits. Tariffs are the foundation for contracts — every time a customer signs up to a plan, Nexudus generates a `CoworkerContract` for that member based on the plan's settings.

Plans define billing frequency (in months or weeks via `InvoiceEvery` / `InvoiceEveryWeeks`), pricing, cancellation rules, and limits on check-ins, booking minutes, visitor passes, and hours. Members are invoiced at the end of each billing cycle. Plans can include benefits such as day passes, booking credits, and money credits — these are configured through `CoworkerExtraService` and `Product` entities linked to the contract.

Use `SystemTariffType` to categorise the plan (e.g. FullTimeHotDesk, VirtualOffice, Storage). Use `Visible` to control whether the plan appears on the members portal. Plans can optionally require identity checks before activation, enforce contract terms, support pausing, and define delivery handling preferences for virtual office mail.

When you edit a plan, changes impact all members signed up to that plan. To customise settings for an individual member, edit their `CoworkerContract` instead.

## Authentication

<Note>
  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 **`Tariff-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Tariff record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffs/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Plan name.
</ResponseField>

<ResponseField name="SystemTariffType" type="integer">
  Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other. See `eTariffType` enum values: `1` = FullTimePrivateOffice, `2` = PartTimePrivateOffice, `3` = FullTimeDedicatedDesk, `4` = PartTimeDedicatedDesk, `5` = FullTimeHotDesk, `6` = PartTimeHotDesk, `7` = FullTimeOther, `8` = PartTimeOther, `9` = Storage, `10` = VirtualOffice, `11` = Virtual, `99` = Other.
</ResponseField>

<ResponseField name="Price" type="number">
  Recurring price charged per billing cycle.
</ResponseField>

<ResponseField name="DefaultInvoicingDay" type="integer">
  Day of the month on which invoices are generated for members on this plan.
</ResponseField>

<ResponseField name="Visible" type="boolean">
  Whether the plan is visible to customers on the members portal and mobile app.
</ResponseField>

<ResponseField name="AvailableToAi" type="boolean">
  Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
</ResponseField>

<ResponseField name="NotesForAi" type="string">
  Custom notes provided to the AI assistant when describing this plan.
</ResponseField>

<ResponseField name="ShowPriceForAi" type="boolean">
  Whether to show the plan price to the AI assistant.
</ResponseField>

<ResponseField name="PriceForAi" type="number">
  Custom price shown to the AI assistant instead of the actual price.
</ResponseField>

<ResponseField name="UseTimePasses" type="boolean">
  Whether this plan uses time passes for check-in access.
</ResponseField>

<ResponseField name="Description" type="string">
  Plan description shown to customers.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Custom text shown on the invoice line instead of the plan name.
</ResponseField>

<ResponseField name="SignUpFee" type="number">
  One-off fee charged when a customer first signs up to this plan.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  Currency code.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  Standard tax rate applied to charges on this plan.
</ResponseField>

<ResponseField name="ReducedTaxRateId" type="integer">
  Reduced tax rate applied when applicable.
</ResponseField>

<ResponseField name="ExemptTaxRateId" type="integer">
  Tax-exempt rate applied when applicable.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  Financial account used for revenue tracking.
</ResponseField>

<ResponseField name="TermsAndConditions" type="string">
  Terms and conditions text that members must accept when signing up.
</ResponseField>

<ResponseField name="ContractDocumentFileName" type="string">
  File name of the contract document template.
</ResponseField>

<ResponseField name="NewContractDocumentUrl" type="string">
  URL to upload a new contract document template.
</ResponseField>

<ResponseField name="ClearContractDocumentFile" type="boolean">
  Set to true to remove the uploaded contract document file.
</ResponseField>

<ResponseField name="CancellationPeriod" type="integer">
  Number of days' notice required before a contract can be cancelled.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Display order on the members portal (lower numbers appear first).
</ResponseField>

<ResponseField name="GroupName" type="string">
  Group name used to visually group plans together on the members portal.
</ResponseField>

<ResponseField name="DisablePortalCancellations" type="boolean">
  Prevents members from cancelling this plan through the members portal.
</ResponseField>

<ResponseField name="SubscribersLimit" type="integer">
  Maximum number of members that can be signed up to this plan at any time.
</ResponseField>

<ResponseField name="CancellationLimitDays" type="integer">
  Minimum number of days a contract must be active before it can be cancelled.
</ResponseField>

<ResponseField name="DefaultContractTerm" type="integer">
  Default minimum contract term in months for new sign-ups.
</ResponseField>

<ResponseField name="CancelMemeberAccountAfter" type="integer">
  Number of days after contract cancellation before the member account is deactivated.
</ResponseField>

<ResponseField name="CheckinPricePlanLimit" type="integer">
  Maximum number of check-ins included per billing cycle.
</ResponseField>

<ResponseField name="CheckinMonthLimit" type="integer">
  Maximum number of check-ins allowed per month.
</ResponseField>

<ResponseField name="CheckinWeekLimit" type="integer">
  Maximum number of check-ins allowed per week.
</ResponseField>

<ResponseField name="VisitorMonthLimit" type="integer">
  Maximum number of visitor passes allowed per month.
</ResponseField>

<ResponseField name="VisitorWeekLimit" type="integer">
  Maximum number of visitor passes allowed per week.
</ResponseField>

<ResponseField name="VisitorDayLimit" type="integer">
  Maximum number of visitor passes allowed per day.
</ResponseField>

<ResponseField name="HoursPricePlanLimit" type="integer">
  Maximum number of hours included per billing cycle.
</ResponseField>

<ResponseField name="HoursMonthLimit" type="integer">
  Maximum number of hours allowed per month.
</ResponseField>

<ResponseField name="HoursWeekLimit" type="integer">
  Maximum number of hours allowed per week.
</ResponseField>

<ResponseField name="BookingMinuteWeekLimit" type="integer">
  Maximum booking minutes allowed per week.
</ResponseField>

<ResponseField name="BookingMinuteMonthLimit" type="integer">
  Maximum booking minutes allowed per month.
</ResponseField>

<ResponseField name="DiscountExtraServices" type="number">
  Discount percentage for extra services.
</ResponseField>

<ResponseField name="DiscountTimePasses" type="number">
  Discount percentage for time passes.
</ResponseField>

<ResponseField name="DiscountCharges" type="number">
  Discount percentage for charges.
</ResponseField>

<ResponseField name="InvoiceEvery" type="integer">
  Billing cycle length in months. Set to 0 if billing by weeks instead.
</ResponseField>

<ResponseField name="InvoiceEveryWeeks" type="integer">
  Billing cycle length in weeks. Set to 0 if billing by months instead.
</ResponseField>

<ResponseField name="AutoCancelAfter" type="integer">
  Number of days after which the contract is automatically cancelled if not paid.
</ResponseField>

<ResponseField name="AdvanceInvoiceCycles" type="integer">
  Number of billing cycles to invoice in advance.
</ResponseField>

<ResponseField name="ProrateDayOfMonth" type="integer">
  Day of the month used to align billing cycles when prorating.
</ResponseField>

<ResponseField name="ProrateDaysBefore" type="integer">
  Number of days before the prorate day to start prorating.
</ResponseField>

<ResponseField name="ProrateCancellations" type="boolean">
  Whether to prorate the final invoice when a contract is cancelled mid-cycle.
</ResponseField>

<ResponseField name="ChargeAndExtend" type="integer">
  Number of days to extend a contract after payment is received.
</ResponseField>

<ResponseField name="ExcludeFromInvoice" type="boolean">
  Whether to exclude this plan's charges from member invoices.
</ResponseField>

<ResponseField name="AutoRaiseInvoices" type="boolean">
  Whether to automatically generate invoices at the end of each billing cycle.
</ResponseField>

<ResponseField name="RaiseInvoiceEvery" type="integer">
  Raise invoice every N months.
</ResponseField>

<ResponseField name="RaiseInvoiceEveryWeeks" type="integer">
  Raise invoice every N weeks.
</ResponseField>

<ResponseField name="MinimumPrice" type="number">
  Minimum total amount charged per billing cycle regardless of usage.
</ResponseField>

<ResponseField name="MinimumPriceIncludeTimePasses" type="boolean">
  Whether time pass charges count towards the minimum price.
</ResponseField>

<ResponseField name="MinimumPriceIncludeExtraServices" type="boolean">
  Whether extra service charges count towards the minimum price.
</ResponseField>

<ResponseField name="MinimumPriceIncludeEvents" type="boolean">
  Whether event charges count towards the minimum price.
</ResponseField>

<ResponseField name="Archived" type="boolean">
  Whether the plan is archived and no longer available for new sign-ups.
</ResponseField>

<ResponseField name="Starred" type="boolean">
  Whether the plan is starred (highlighted) on the members portal.
</ResponseField>

<ResponseField name="KeepNewAccountsOnHold" type="boolean">
  Whether new sign-ups are kept on hold until manually approved.
</ResponseField>

<ResponseField name="CanBePaused" type="boolean">
  Whether members can pause their contract on this plan.
</ResponseField>

<ResponseField name="PauseYearlyLimit" type="integer">
  Maximum number of times a contract can be paused per year.
</ResponseField>

<ResponseField name="PauseCyclesLimit" type="integer">
  Maximum number of billing cycles a contract can be paused for.
</ResponseField>

<ResponseField name="BookingDueDateStrategy" type="integer">
  Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth. See `eTariffBookingDueDateStrategy` enum values: `1` = RenewalDate, `2` = BookingEndDate, `3` = BookingCreationDate, `4` = NextNthOfMonth.
</ResponseField>

<ResponseField name="BookingDueDateDayOfMonth" type="integer">
  Day of the month used when BookingDueDateStrategy is NextNthOfMonth.
</ResponseField>

<ResponseField name="TotalSignUpPrice" type="number">
  Calculated total price at sign-up including the plan price and sign-up fee.
</ResponseField>

<ResponseField name="TotalPrice" type="number">
  Calculated total recurring price per billing cycle.
</ResponseField>

<ResponseField name="IsVirtualOffice" type="boolean">
  Whether this is a virtual office plan with mail handling features.
</ResponseField>

<ResponseField name="WaitForIdentityChecksToActivate" type="boolean">
  Whether to keep the contract on hold until all required identity checks are completed.
</ResponseField>

<ResponseField name="RequestAddressIdentityCheck" type="boolean">
  Whether to request an address identity check from members signing up to this plan.
</ResponseField>

<ResponseField name="AddressIdentityCheckDescription" type="string">
  Instructions shown to members when completing the address identity check.
</ResponseField>

<ResponseField name="AddressIdentityCheckProvider" type="integer">
  Provider used for address identity checks: Manual or StripeIdentity. See `eIdentityCheckProvider` enum values: `1` = Manual, `2` = StripeIdentity.
</ResponseField>

<ResponseField name="KeepPausedIfAddressMismatch" type="boolean">
  Whether to keep the contract paused if the address identity check reveals a mismatch.
</ResponseField>

<ResponseField name="AddressIdentityCheckRepeatPattern" type="integer">
  How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months. See `eIdentityCheckRepeatPattern` enum values: `1` = Never, `2` = Every3Months, `3` = Every6Months, `4` = Every12Months, `5` = Every24Months.
</ResponseField>

<ResponseField name="RequestIdentityCheck" type="boolean">
  Whether to request an identity (ID document) check from members signing up to this plan.
</ResponseField>

<ResponseField name="IdentityCheckProvider" type="integer">
  Provider used for identity checks: Manual or StripeIdentity. See `eIdentityCheckProvider` enum values: `1` = Manual, `2` = StripeIdentity.
</ResponseField>

<ResponseField name="IdentityCheckRepeatPattern" type="integer">
  How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months. See `eIdentityCheckRepeatPattern` enum values: `1` = Never, `2` = Every3Months, `3` = Every6Months, `4` = Every12Months, `5` = Every24Months.
</ResponseField>

<ResponseField name="IdentityCheckDescription" type="string">
  Instructions shown to members when completing the identity check.
</ResponseField>

<ResponseField name="RequestAmlCheck" type="boolean">
  Whether to request an AML check from members signing up to this plan.
</ResponseField>

<ResponseField name="AmlCheckOpenSanctionsEnabled" type="boolean">
  Whether to enable AML checks against the OpenSanctions dataset.
</ResponseField>

<ResponseField name="AmlCheckPappersEnabled" type="boolean">
  Whether to enable AML checks against the Pappers dataset.
</ResponseField>

<ResponseField name="AmlCheckOpenSanctionsDataset" type="string">
  Which OpenSanctions dataset to check against for AML screening (e.g. 'default').
</ResponseField>

<ResponseField name="AmlCheckScoreThreshold" type="number">
  Score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7.
</ResponseField>

<ResponseField name="SendOnBoardingFormByEmail" type="boolean">
  Whether to email the onboarding form to new members signing up to this plan.
</ResponseField>

<ResponseField name="FormPageId" type="integer">
  ID of the onboarding form page sent to new members.
</ResponseField>

<ResponseField name="FormPageName" type="string">
  Form page name.
</ResponseField>

<ResponseField name="ProductsStore" type="integer[]">
  Product IDs for mail stored for collection (virtual office).
</ResponseField>

<ResponseField name="ProductsForward" type="integer[]">
  Product IDs for mail forwarding (virtual office).
</ResponseField>

<ResponseField name="ProductsRecycle" type="integer[]">
  Product IDs for mail recycling (virtual office).
</ResponseField>

<ResponseField name="ProductsShred" type="integer[]">
  Product IDs for mail shredding (virtual office).
</ResponseField>

<ResponseField name="ProductsScan" type="integer[]">
  Product IDs for mail scanning (virtual office).
</ResponseField>

<ResponseField name="ProductsReturn" type="integer[]">
  Product IDs for returning mail to sender (virtual office).
</ResponseField>

<ResponseField name="ProductsDeposit" type="integer[]">
  Product IDs for check deposits (virtual office).
</ResponseField>

<ResponseField name="ProductsCollect" type="integer[]">
  Product IDs for mail collection (virtual office).
</ResponseField>

<ResponseField name="DeliveryPreferencesMail" type="integer">
  Allowed handling preferences for mail deliveries (virtual office).
</ResponseField>

<ResponseField name="DeliveryPreferencesParcels" type="integer">
  Allowed handling preferences for parcel deliveries (virtual office).
</ResponseField>

<ResponseField name="DeliveryPreferencesChecks" type="integer">
  Allowed handling preferences for check deliveries (virtual office).
</ResponseField>

<ResponseField name="DeliveryPreferencesPublicity" type="integer">
  Allowed handling preferences for publicity deliveries (virtual office).
</ResponseField>

<ResponseField name="DeliveryPreferencesOther" type="integer">
  Allowed handling preferences for other deliveries (virtual office).
</ResponseField>

<ResponseField name="MaximumDeliveryStorageDays" type="integer">
  Maximum number of days deliveries are stored before being returned (virtual office).
</ResponseField>

<ResponseField name="MaximumCompanyAliases" type="integer">
  Maximum number of company name aliases allowed for mail handling (virtual office).
</ResponseField>

<ResponseField name="MaximumRecipients" type="integer">
  Maximum number of mail recipients allowed (virtual office).
</ResponseField>

<ResponseField name="MaximumAddresses" type="integer">
  Maximum number of forwarding addresses allowed (virtual office).
</ResponseField>

<ResponseField name="TransferProductsToContract" type="boolean">
  Whether to automatically transfer mail handling products to the member's contract.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "SystemTariffType": 0,
  "Price": 0,
  "DefaultInvoicingDay": null,
  "Visible": false,
  "AvailableToAi": false,
  "NotesForAi": null,
  "ShowPriceForAi": false,
  "PriceForAi": null,
  "UseTimePasses": false,
  "Description": null,
  "InvoiceLineDisplayAs": null,
  "SignUpFee": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "TermsAndConditions": null,
  "ContractDocumentFileName": null,
  "NewContractDocumentUrl": null,
  "ClearContractDocumentFile": null,
  "CancellationPeriod": 0,
  "DisplayOrder": 0,
  "GroupName": null,
  "DisablePortalCancellations": false,
  "SubscribersLimit": null,
  "CancellationLimitDays": null,
  "DefaultContractTerm": null,
  "CancelMemeberAccountAfter": null,
  "CheckinPricePlanLimit": null,
  "CheckinMonthLimit": null,
  "CheckinWeekLimit": null,
  "VisitorMonthLimit": null,
  "VisitorWeekLimit": null,
  "VisitorDayLimit": null,
  "HoursPricePlanLimit": null,
  "HoursMonthLimit": null,
  "HoursWeekLimit": null,
  "BookingMinuteWeekLimit": null,
  "BookingMinuteMonthLimit": null,
  "DiscountExtraServices": null,
  "DiscountTimePasses": null,
  "DiscountCharges": null,
  "InvoiceEvery": 0,
  "InvoiceEveryWeeks": 0,
  "AutoCancelAfter": null,
  "AdvanceInvoiceCycles": null,
  "ProrateDayOfMonth": null,
  "ProrateDaysBefore": null,
  "ProrateCancellations": false,
  "ChargeAndExtend": null,
  "ExcludeFromInvoice": null,
  "AutoRaiseInvoices": false,
  "RaiseInvoiceEvery": null,
  "RaiseInvoiceEveryWeeks": null,
  "MinimumPrice": null,
  "MinimumPriceIncludeTimePasses": false,
  "MinimumPriceIncludeExtraServices": false,
  "MinimumPriceIncludeEvents": false,
  "Archived": false,
  "Starred": false,
  "KeepNewAccountsOnHold": false,
  "CanBePaused": false,
  "PauseYearlyLimit": null,
  "PauseCyclesLimit": null,
  "BookingDueDateStrategy": 0,
  "BookingDueDateDayOfMonth": null,
  "TotalSignUpPrice": 0,
  "TotalPrice": 0,
  "IsVirtualOffice": false,
  "WaitForIdentityChecksToActivate": false,
  "RequestAddressIdentityCheck": false,
  "AddressIdentityCheckDescription": null,
  "AddressIdentityCheckProvider": 0,
  "KeepPausedIfAddressMismatch": false,
  "AddressIdentityCheckRepeatPattern": 0,
  "RequestIdentityCheck": false,
  "IdentityCheckProvider": 0,
  "IdentityCheckRepeatPattern": 0,
  "IdentityCheckDescription": null,
  "RequestAmlCheck": false,
  "AmlCheckOpenSanctionsEnabled": false,
  "AmlCheckPappersEnabled": false,
  "AmlCheckOpenSanctionsDataset": null,
  "AmlCheckScoreThreshold": null,
  "SendOnBoardingFormByEmail": false,
  "FormPageId": null,
  "FormPageName": null,
  "ProductsStore": [],
  "ProductsForward": [],
  "ProductsRecycle": [],
  "ProductsShred": [],
  "ProductsScan": [],
  "ProductsReturn": [],
  "ProductsDeposit": [],
  "ProductsCollect": [],
  "DeliveryPreferencesMail": 0,
  "DeliveryPreferencesParcels": 0,
  "DeliveryPreferencesChecks": 0,
  "DeliveryPreferencesPublicity": 0,
  "DeliveryPreferencesOther": 0,
  "MaximumDeliveryStorageDays": null,
  "MaximumCompanyAliases": null,
  "MaximumRecipients": null,
  "MaximumAddresses": null,
  "TransferProductsToContract": false,
  "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": "Tariff Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffSignupProducts
Source: https://learn.nexudus.com/rest-api/billing/get-tariffsignupproducts

GET /api/billing/tariffsignupproducts
Search and list TariffSignupProduct records with filtering, sorting, and pagination.

A **TariffSignupProduct** links a product to a pricing plan (tariff) as a one-time sign-up charge. Products linked this way are automatically added to a customer's first invoice when they join the plan.

## Authentication

<Note>
  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 **`TariffSignupProduct-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by product name.
</ParamField>

<ParamField type="number">
  Filter by product price.
</ParamField>

<ParamField type="string">
  Filter by product currency code.
</ParamField>

<ParamField type="number">
  Filter by signup product price override.
</ParamField>

<ParamField type="boolean">
  Filter by whether the signup product is refundable.
</ParamField>

<ParamField type="boolean">
  Filter by whether invoice during online checkout is enabled.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by product price greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by product price less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by signup product price override greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by signup product price override less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts?TariffSignupProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts?' + new URLSearchParams({
      TariffSignupProduct_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
      params={
          'TariffSignupProduct_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts?from_TariffSignupProduct_UpdatedOn=2025-01-01T00:00&to_TariffSignupProduct_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts?' + new URLSearchParams({
      from_TariffSignupProduct_UpdatedOn: '2025-01-01T00:00',
      to_TariffSignupProduct_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
      params={
          'from_TariffSignupProduct_UpdatedOn': '2025-01-01T00:00',
          'to_TariffSignupProduct_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffSignupProduct[]">
  The list of TariffSignupProduct records matching the query. See the [Get one TariffSignupProduct](/rest-api/billing/get-tariffsignupproducts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TariffId": 0,
      "TariffName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductCurrencyCode": null,
      "Price": null,
      "Refundable": false,
      "InvoiceDuringOnlineCheckout": false,
      "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": "TariffSignupProduct Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffSignupProducts
Source: https://learn.nexudus.com/rest-api/billing/get-tariffsignupproducts-batch

GET /api/billing/tariffsignupproducts/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffSignupProduct records by their Ids in a single request.

Fetch several TariffSignupProduct records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffSignupProduct-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffSignupProduct Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffSignupProduct records. Each record has the same structure as the response from the [Get one TariffSignupProduct](/rest-api/billing/get-tariffsignupproducts-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TariffId": 0,
    "TariffName": null,
    "ProductId": 0,
    "ProductName": null,
    "ProductPrice": 0,
    "ProductCurrencyCode": null,
    "Price": null,
    "Refundable": false,
    "InvoiceDuringOnlineCheckout": false,
    "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": "TariffSignupProduct Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffSignupProduct
Source: https://learn.nexudus.com/rest-api/billing/get-tariffsignupproducts-by-id

GET /api/billing/tariffsignupproducts/{id}
Retrieve a single TariffSignupProduct record by its Id.

A **TariffSignupProduct** links a product to a pricing plan (tariff) as a one-time sign-up charge. Products linked this way are automatically added to a customer's first invoice when they join the plan.

## Authentication

<Note>
  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 **`TariffSignupProduct-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffSignupProduct record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Product name.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Product price.
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  Product currency code.
</ResponseField>

<ResponseField name="Price" type="number">
  Signup product price override.
</ResponseField>

<ResponseField name="Refundable" type="boolean">
  Whether the signup product is refundable.
</ResponseField>

<ResponseField name="InvoiceDuringOnlineCheckout" type="boolean">
  Whether invoice during online checkout is enabled.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TariffId": 0,
  "TariffName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "Price": null,
  "Refundable": false,
  "InvoiceDuringOnlineCheckout": false,
  "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": "TariffSignupProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TariffTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-tarifftimepasses

GET /api/billing/tarifftimepasses
Search and list TariffTimePass records with filtering, sorting, and pagination.

A **TariffTimePass** links a time pass to a pricing plan (tariff), defining an included allowance of time passes for customers on that plan. The renewal time controls how often the allowance resets.

## Authentication

<Note>
  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 **`TariffTimePass-List`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — PassRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Filter by time pass name.
</ParamField>

<ParamField type="integer">
  Filter by number of passes included.
</ParamField>

<ParamField type="integer">
  Filter by pass renewal time period.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by number of passes included greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of passes included less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses?TariffTimePass_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses?' + new URLSearchParams({
      TariffTimePass_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses',
      params={
          'TariffTimePass_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses?from_TariffTimePass_UpdatedOn=2025-01-01T00:00&to_TariffTimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses?' + new URLSearchParams({
      from_TariffTimePass_UpdatedOn: '2025-01-01T00:00',
      to_TariffTimePass_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses',
      params={
          'from_TariffTimePass_UpdatedOn': '2025-01-01T00:00',
          'to_TariffTimePass_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TariffTimePass[]">
  The list of TariffTimePass records matching the query. See the [Get one TariffTimePass](/rest-api/billing/get-tarifftimepasses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TariffId": 0,
      "TariffName": null,
      "TimePassId": 0,
      "TimePassName": null,
      "PassesIncluded": 0,
      "PassRenewalTime": 0,
      "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": "TariffTimePass Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TariffTimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-tarifftimepasses-batch

GET /api/billing/tarifftimepasses/?id=[{id1},{id2},{id3}]
Retrieve multiple TariffTimePass records by their Ids in a single request.

Fetch several TariffTimePass records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TariffTimePass-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TariffTimePass Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TariffTimePass records. Each record has the same structure as the response from the [Get one TariffTimePass](/rest-api/billing/get-tarifftimepasses-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TariffId": 0,
    "TariffName": null,
    "TimePassId": 0,
    "TimePassName": null,
    "PassesIncluded": 0,
    "PassRenewalTime": 0,
    "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": "TariffTimePass Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TariffTimePass
Source: https://learn.nexudus.com/rest-api/billing/get-tarifftimepasses-by-id

GET /api/billing/tarifftimepasses/{id}
Retrieve a single TariffTimePass record by its Id.

A **TariffTimePass** links a time pass to a pricing plan (tariff), defining an included allowance of time passes for customers on that plan. The renewal time controls how often the allowance resets.

## Authentication

<Note>
  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 **`TariffTimePass-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TariffTimePass record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="TimePassId" type="integer">
  ID of the time pass linked to this record.
</ResponseField>

<ResponseField name="TimePassName" type="string">
  Time pass name.
</ResponseField>

<ResponseField name="PassesIncluded" type="integer">
  Number of passes included.
</ResponseField>

<ResponseField name="PassRenewalTime" type="integer">
  Pass renewal time period. See `eTimeSpanWeekMonth` enum values: `1` = Week, `2` = CalendarMonth, `3` = TariffMonth, `4` = Year, `5` = Day.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TariffId": 0,
  "TariffName": null,
  "TimePassId": 0,
  "TimePassName": null,
  "PassesIncluded": 0,
  "PassRenewalTime": 0,
  "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": "TariffTimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-timepasses

GET /api/billing/timepasses
Search and list TimePass records with filtering, sorting, and pagination.

Passes allow customers to check in to a coworking space. There are two kinds:

* **Day Pass** — valid for a single calendar day. Created with `MinutesIncluded` omitted (null). The customer can check in any number of times during that day.
* **Time Pass** — valid across multiple days up to a fixed amount of time. Created with \`\`MinutesIncluded` <minutes>` set. The customer can check in until the included minutes are exhausted.

## Authentication

<Note>
  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 **`TimePass-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by business name.
</ParamField>

<ParamField type="string">
  Filter by time pass name.
</ParamField>

<ParamField type="string">
  Filter by invoice line display text.
</ParamField>

<ParamField type="number">
  Filter by unit price amount.
</ParamField>

<ParamField type="integer">
  Filter by minutes included.
</ParamField>

<ParamField type="boolean">
  Filter by counts towards plan limits.
</ParamField>

<ParamField type="boolean">
  Filter by use as pay-as-you-go for members.
</ParamField>

<ParamField type="boolean">
  Filter by use as pay-as-you-go for contacts.
</ParamField>

<ParamField type="integer">
  Filter by use priority.
</ParamField>

<ParamField type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField type="string">
  Filter by currency code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the financial account linked to this record.
</ParamField>

<ParamField type="string">
  Filter by kisi group ID.
</ParamField>

<ParamField type="string">
  Filter by doorGuard group ID.
</ParamField>

<ParamField type="string">
  Filter by iD of the access control group associated with this record.
</ParamField>

<ParamField type="string">
  Filter by the access control group ids value for this time pass.
</ParamField>

<ParamField type="boolean">
  Filter by allow network check-in.
</ParamField>

<ParamField type="boolean">
  Filter by only available for contacts.
</ParamField>

<ParamField type="boolean">
  Filter by only available for members.
</ParamField>

<ParamField type="boolean">
  Filter by whether this time pass is archived and hidden from active lists.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by unit price amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by unit price amount less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minutes included greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by minutes included less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by use priority greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by use priority less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?TimePass_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      TimePass_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'TimePass_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?from_TimePass_UpdatedOn=2025-01-01T00:00&to_TimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      from_TimePass_UpdatedOn: '2025-01-01T00:00',
      to_TimePass_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'from_TimePass_UpdatedOn': '2025-01-01T00:00',
          'to_TimePass_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TimePass[]">
  The list of TimePass records matching the query. See the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each TimePass. The following fields are **not populated** in the `Records[]` response: `CountsTowardsPlanLimits`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "InvoiceLineDisplayAs": null,
      "Price": 0,
      "MinutesIncluded": null,
      "UseAsPayAsYouGoForMembers": false,
      "UseAsPayAsYouGoForContacts": false,
      "UsePriority": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "TaxRateId": null,
      "ReducedTaxRateId": null,
      "ExemptTaxRateId": null,
      "FinancialAccountId": null,
      "Businesses": [],
      "KisiGroupId": null,
      "DoorGuardGroupId": null,
      "AccessControlGroupId": null,
      "AccessControlGroupIds": null,
      "AllowNetworkCheckIn": false,
      "Tariffs": [],
      "Archived": false,
      "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": "TimePass Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TimePasses
Source: https://learn.nexudus.com/rest-api/billing/get-timepasses-batch

GET /api/billing/timepasses/?id=[{id1},{id2},{id3}]
Retrieve multiple TimePass records by their Ids in a single request.

Fetch several TimePass records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TimePass-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TimePass Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TimePass records. Each record has the same structure as the response from the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each TimePass. The following fields are **not populated** in the response: `CountsTowardsPlanLimits`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "Name": "",
    "InvoiceLineDisplayAs": null,
    "Price": 0,
    "MinutesIncluded": null,
    "UseAsPayAsYouGoForMembers": false,
    "UseAsPayAsYouGoForContacts": false,
    "UsePriority": null,
    "CurrencyId": 0,
    "CurrencyCode": null,
    "TaxRateId": null,
    "ReducedTaxRateId": null,
    "ExemptTaxRateId": null,
    "FinancialAccountId": null,
    "Businesses": [],
    "KisiGroupId": null,
    "DoorGuardGroupId": null,
    "AccessControlGroupId": null,
    "AccessControlGroupIds": null,
    "AllowNetworkCheckIn": false,
    "Tariffs": [],
    "Archived": false,
    "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": "TimePass Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TimePass
Source: https://learn.nexudus.com/rest-api/billing/get-timepasses-by-id

GET /api/billing/timepasses/{id}
Retrieve a single TimePass record by its Id.

Passes allow customers to check in to a coworking space. There are two kinds:

* **Day Pass** — valid for a single calendar day. Created with `MinutesIncluded` omitted (null). The customer can check in any number of times during that day.
* **Time Pass** — valid across multiple days up to a fixed amount of time. Created with \`\`MinutesIncluded` <minutes>` set. The customer can check in until the included minutes are exhausted.

## Authentication

<Note>
  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 **`TimePass-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePass record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Time pass name.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Invoice line display text.
</ResponseField>

<ResponseField name="Price" type="number">
  Unit price amount.
</ResponseField>

<ResponseField name="MinutesIncluded" type="integer">
  Minutes included.
</ResponseField>

<ResponseField name="CountsTowardsPlanLimits" type="boolean">
  Counts towards plan limits.
</ResponseField>

<ResponseField name="UseAsPayAsYouGoForMembers" type="boolean">
  Use as pay-as-you-go for members.
</ResponseField>

<ResponseField name="UseAsPayAsYouGoForContacts" type="boolean">
  Use as pay-as-you-go for contacts.
</ResponseField>

<ResponseField name="UsePriority" type="integer">
  Use priority.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  ID of the currency linked to this record.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  Currency code.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  ID of the tax rate linked to this record.
</ResponseField>

<ResponseField name="ReducedTaxRateId" type="integer">
  ID of the reduced tax rate linked to this record.
</ResponseField>

<ResponseField name="ExemptTaxRateId" type="integer">
  ID of the exempt tax rate linked to this record.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  ID of the financial account linked to this record.
</ResponseField>

<ResponseField name="Businesses" type="integer[]">
  List of businesses linked to this record.
</ResponseField>

<ResponseField name="KisiGroupId" type="string">
  Kisi group ID.
</ResponseField>

<ResponseField name="DoorGuardGroupId" type="string">
  DoorGuard group ID.
</ResponseField>

<ResponseField name="AccessControlGroupId" type="string">
  ID of the access control group associated with this record.
</ResponseField>

<ResponseField name="AccessControlGroupIds" type="string">
  The access control group ids value for this time pass.
</ResponseField>

<ResponseField name="AllowNetworkCheckIn" type="boolean">
  Allow network check-in.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Only available for contacts.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Only available for members.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="Archived" type="boolean">
  Whether this time pass is archived and hidden from active lists.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "InvoiceLineDisplayAs": null,
  "Price": 0,
  "MinutesIncluded": null,
  "CountsTowardsPlanLimits": false,
  "UseAsPayAsYouGoForMembers": false,
  "UseAsPayAsYouGoForContacts": false,
  "UsePriority": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "Businesses": [],
  "KisiGroupId": null,
  "DoorGuardGroupId": null,
  "AccessControlGroupId": null,
  "AccessControlGroupIds": null,
  "AllowNetworkCheckIn": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "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": "TimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TimePassPrices
Source: https://learn.nexudus.com/rest-api/billing/get-timepassprices

GET /api/billing/timepassprices
Search and list TimePassPrice records with filtering, sorting, and pagination.

A **TimePassPrice** defines a pricing tier for a time pass, allowing different prices based on quantity purchased or customer segment.

## Authentication

<Note>
  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 **`TimePassPrice-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Filter by time pass name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the tariff linked to this record.
</ParamField>

<ParamField type="string">
  Filter by tariff name.
</ParamField>

<ParamField type="number">
  Filter by unit price amount.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by unit price amount greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by unit price amount less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepassprices?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepassprices',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepassprices?TimePassPrice_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices?' + new URLSearchParams({
      TimePassPrice_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepassprices',
      params={
          'TimePassPrice_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepassprices?from_TimePassPrice_UpdatedOn=2025-01-01T00:00&to_TimePassPrice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices?' + new URLSearchParams({
      from_TimePassPrice_UpdatedOn: '2025-01-01T00:00',
      to_TimePassPrice_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepassprices',
      params={
          'from_TimePassPrice_UpdatedOn': '2025-01-01T00:00',
          'to_TimePassPrice_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TimePassPrice[]">
  The list of TimePassPrice records matching the query. See the [Get one TimePassPrice](/rest-api/billing/get-timepassprices-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TimePassId": 0,
      "TimePassName": null,
      "TariffId": 0,
      "TariffName": null,
      "Price": 0,
      "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": "TimePassPrice Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TimePassPrices
Source: https://learn.nexudus.com/rest-api/billing/get-timepassprices-batch

GET /api/billing/timepassprices/?id=[{id1},{id2},{id3}]
Retrieve multiple TimePassPrice records by their Ids in a single request.

Fetch several TimePassPrice records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TimePassPrice-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TimePassPrice Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepassprices/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepassprices/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TimePassPrice records. Each record has the same structure as the response from the [Get one TimePassPrice](/rest-api/billing/get-timepassprices-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TimePassId": 0,
    "TimePassName": null,
    "TariffId": 0,
    "TariffName": null,
    "Price": 0,
    "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": "TimePassPrice Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TimePassPrice
Source: https://learn.nexudus.com/rest-api/billing/get-timepassprices-by-id

GET /api/billing/timepassprices/{id}
Retrieve a single TimePassPrice record by its Id.

A **TimePassPrice** defines a pricing tier for a time pass, allowing different prices based on quantity purchased or customer segment.

## Authentication

<Note>
  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 **`TimePassPrice-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePassPrice record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepassprices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TimePassId" type="integer">
  ID of the time pass linked to this record.
</ResponseField>

<ResponseField name="TimePassName" type="string">
  Time pass name.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the tariff linked to this record.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="Price" type="number">
  Unit price amount.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TimePassId": 0,
  "TimePassName": null,
  "TariffId": 0,
  "TariffName": null,
  "Price": 0,
  "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": "TimePassPrice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search TimePassTimeSlots
Source: https://learn.nexudus.com/rest-api/billing/get-timepasstimeslots

GET /api/billing/timepasstimeslots
Search and list TimePassTimeSlot records with filtering, sorting, and pagination.

A **TimePassTimeSlot** defines the days and times during which a time pass can be used. Each time slot specifies a day of the week and a from/to time window that restricts when the pass is valid.

## Authentication

<Note>
  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 **`TimePassTimeSlot-List`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Filter by start time.
</ParamField>

<ParamField type="string">
  Filter by end time.
</ParamField>

<ParamField type="integer">
  Filter by the day of week value for this time pass time slot.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by start time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by start time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by end time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots?TimePassTimeSlot_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots?' + new URLSearchParams({
      TimePassTimeSlot_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots',
      params={
          'TimePassTimeSlot_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots?from_TimePassTimeSlot_UpdatedOn=2025-01-01T00:00&to_TimePassTimeSlot_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots?' + new URLSearchParams({
      from_TimePassTimeSlot_UpdatedOn: '2025-01-01T00:00',
      to_TimePassTimeSlot_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots',
      params={
          'from_TimePassTimeSlot_UpdatedOn': '2025-01-01T00:00',
          'to_TimePassTimeSlot_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="TimePassTimeSlot[]">
  The list of TimePassTimeSlot records matching the query. See the [Get one TimePassTimeSlot](/rest-api/billing/get-timepasstimeslots-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "TimePassId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0,
      "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": "TimePassTimeSlot Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple TimePassTimeSlots
Source: https://learn.nexudus.com/rest-api/billing/get-timepasstimeslots-batch

GET /api/billing/timepasstimeslots/?id=[{id1},{id2},{id3}]
Retrieve multiple TimePassTimeSlot records by their Ids in a single request.

Fetch several TimePassTimeSlot records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`TimePassTimeSlot-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of TimePassTimeSlot Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of TimePassTimeSlot records. Each record has the same structure as the response from the [Get one TimePassTimeSlot](/rest-api/billing/get-timepasstimeslots-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "TimePassId": 0,
    "FromTime": "2025-01-15T10:30:00Z",
    "ToTime": "2025-01-15T10:30:00Z",
    "DayOfWeek": 0,
    "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": "TimePassTimeSlot Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one TimePassTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/get-timepasstimeslots-by-id

GET /api/billing/timepasstimeslots/{id}
Retrieve a single TimePassTimeSlot record by its Id.

A **TimePassTimeSlot** defines the days and times during which a time pass can be used. Each time slot specifies a day of the week and a from/to time window that restricts when the pass is valid.

## Authentication

<Note>
  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 **`TimePassTimeSlot-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the TimePassTimeSlot record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="TimePassId" type="integer">
  ID of the time pass linked to this record.
</ResponseField>

<ResponseField name="FromTime" type="string">
  Start time.
</ResponseField>

<ResponseField name="ToTime" type="string">
  End time.
</ResponseField>

<ResponseField name="DayOfWeek" type="integer">
  The day of week value for this time pass time slot. See `DayOfWeek` enum values: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "TimePassId": 0,
  "FromTime": "2025-01-15T10:30:00Z",
  "ToTime": "2025-01-15T10:30:00Z",
  "DayOfWeek": 0,
  "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": "TimePassTimeSlot Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Create BasketSession
Source: https://learn.nexudus.com/rest-api/billing/post-basketsessions

POST /api/billing/basketsessions
Create a new BasketSession record.

A **BasketSession** is an internal entity that temporarily stores basket items while a customer is checking out on the Members Portal. It is not intended for direct use via the API or CLI.

## Authentication

<Note>
  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 **`BasketSession-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Unique session identifier linking the basket to the customer's browser session.
</ParamField>

### Optional Fields

<ParamField type="string">
  JSON-serialised basket contents including selected products, quantities, and pricing.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/basketsessions" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "SessionId": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        SessionId: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the basketsession was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BasketSession 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "SessionId: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "SessionId"
    }
  ],
  "WasSuccessful": false
}
```


# Create BusinessCharge
Source: https://learn.nexudus.com/rest-api/billing/post-businesscharges

POST /api/billing/businesscharges
Create a new BusinessCharge record.

A **BusinessCharge** represents a charge issued by Nexudus to a specific location for platform services or subscription fees. Only Nexudus staff can create or manage these charges.

Charges can be one-off or recurring. Set `Recurrent` to `true` and provide `RepeatFrom` and `RepeatUntil` to define the recurrence window.

A charge moves through an approval workflow before it is invoiced. Use `ApprovedByBusiness` and `ApprovedBySender` to reflect the approval state. Once invoiced, the `Invoiced` flag will be set and `InvoicedOn` will record the date.

## Authentication

<Note>
  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 **`BusinessCharge-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Human-readable description of what this charge is for.
</ParamField>

<ParamField type="string">
  URL that Nexudus will call back once the charge is processed or its status changes.
</ParamField>

<ParamField type="number">
  Percentage discount to apply to the charge amount (0–100).
</ParamField>

<ParamField type="number">
  Total amount of the charge before tax.
</ParamField>

<ParamField type="number">
  Tax amount applied to this charge.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the application linked to this record.
</ParamField>

<ParamField type="string">
  Date by which the charge must be paid.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/businesscharges" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Description": "",
      "CallBackUrl": "",
      "PercentageDiscount": 0,
      "TotalAmount": 0,
      "TaxAmount": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Description: '',
        CallBackUrl: '',
        PercentageDiscount: 0,
        TotalAmount: 0,
        TaxAmount: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Description': '',
          'CallBackUrl': '',
          'PercentageDiscount': 0,
          'TotalAmount': 0,
          'TaxAmount': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the businesscharge was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BusinessCharge 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```


# Create Charge
Source: https://learn.nexudus.com/rest-api/billing/post-charges

POST /api/billing/charges
Create a new Charge record.

A **Charge** is a generic debit item applied to a customer account. Prefer more specific entities when available — use `CoworkerProduct` for product sales, `Booking` for room/resource bookings, `EventAttendee` for event registrations, and `CoworkerContract` for recurring plan charges.

Charges can reference the originating sale from another entity via its `UniqueId` (a GUID, not an integer ID). This is how items billed to a non-paying team member are passed through to the team's paying member: the charge appears on the paying member's account with a `UniqueId` reference back to the original `CoworkerProduct`, `Booking`, `EventAttendee`, or `CoworkerTimePass`.

Booking-related extra-service charges are represented by `CoworkerExtraService` records and referenced via `CoworkerExtraServiceUniqueId`.

## Authentication

<Note>
  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 **`Charge-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="number">
  Discount amount.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Total amount.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this charge.
</ParamField>

<ParamField type="string">
  Display text on invoice line.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="string">
  Due date.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether the charge has been invoiced.
</ParamField>

<ParamField type="string">
  Sale date.
</ParamField>

<ParamField type="boolean">
  Whether from team member is enabled.
</ParamField>

<ParamField type="string">
  The coworker extra service name value for this charge.
</ParamField>

<ParamField type="string">
  The coworker time pass name value for this charge.
</ParamField>

<ParamField type="string">
  The coworker product name value for this charge.
</ParamField>

<ParamField type="string">
  The tariff name value for this charge.
</ParamField>

<ParamField type="string">
  ID of the coworker product unique associated with this record.
</ParamField>

<ParamField type="string">
  ID of the booking unique associated with this record.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/charges" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "Quantity": 0,
      "DiscountAmount": 0,
      "CreditAmount": 0,
      "TotalAmount": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        Quantity: 0,
        DiscountAmount: 0,
        CreditAmount: 0,
        TotalAmount: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/charges',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'Quantity': 0,
          'DiscountAmount': 0,
          'CreditAmount': 0,
          'TotalAmount': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the charge was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Charge 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "DiscountAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DiscountAmount"
    }
  ],
  "WasSuccessful": false
}
```


# Create ContractContact
Source: https://learn.nexudus.com/rest-api/billing/post-contractcontacts

POST /api/billing/contractcontacts
Create a new ContractContact record.

A **ContractContact** is a key contact entry on a virtual office contract (`CoworkerContract`). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract.

Each entry can be linked to an existing coworker via `CoworkerId`, in which case the coworker's name and email are resolved automatically. Alternatively, provide `FullName` and `Email` directly for contacts who do not have a coworker record.

Use `ContractContactType` to classify the contact:

| Type                 | Description                                                                 |
| -------------------- | --------------------------------------------------------------------------- |
| `Director`           | A director of the company registered under the virtual office contract      |
| `CompanyAlias`       | A trading name or alias used by the company                                 |
| `NominatedRecipient` | A person authorised to receive mail and deliveries on behalf of the company |

## Authentication

<Note>
  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 **`ContractContact-Create`** role.
</Note>

## Enums

<Accordion title="eContractContactType — ContractContactType values">
  | Value | Name               |
  | ----- | ------------------ |
  | 0     | None               |
  | 1     | Director           |
  | 2     | CompanyAlias       |
  | 3     | NominatedRecipient |
</Accordion>

<Accordion title="eAmlCheckStatus — AmlCheckStatus values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | NotStarted      |
  | 1     | Pending         |
  | 2     | Clear           |
  | 3     | PotentialMatch  |
  | 4     | ConfirmedMatch  |
  | 5     | Error           |
  | 6     | ManuallyCleared |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="string">
  Full name of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="integer">
  Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). Defaults to `eContractContactType.Director`.
</ParamField>

<ParamField type="integer">
  The AML check status for this contact.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Email address of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="string">
  Date of birth. Used for identity verification purposes.
</ParamField>

<ParamField type="string">
  Street address.
</ParamField>

<ParamField type="string">
  Post code.
</ParamField>

<ParamField type="string">
  City name.
</ParamField>

<ParamField type="string">
  State or province.
</ParamField>

<ParamField type="integer">
  ID of the country linked to this record.
</ParamField>

<ParamField type="string">
  Phone number.
</ParamField>

<ParamField type="string">
  Optional notes or comments about this contract contact.
</ParamField>

<ParamField type="string">
  The date when the AML check was performed.
</ParamField>

<ParamField type="number">
  The score from the open sanctions check.
</ParamField>

<ParamField type="string">
  The response from the open sanctions check as JSON string.
</ParamField>

<ParamField type="string">
  The response from the Pappers AML check as TEXT string.
</ParamField>

<ParamField type="string">
  The status from the Pappers AML check.
</ParamField>

<ParamField type="string">
  Notes related to the AML check. Customers cannot see this field, it's for internal use only.
</ParamField>

<ParamField type="string">
  The user who cleared the AML check.
</ParamField>

<ParamField type="string">
  The date when the AML check was cleared.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/contractcontacts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "FullName": "",
      "ContractContactType": 0,
      "AmlCheckStatus": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        FullName: '',
        ContractContactType: 0,
        AmlCheckStatus: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'FullName': '',
          'ContractContactType': 0,
          'AmlCheckStatus': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractcontact was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractContact 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FullName: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FullName"
    }
  ],
  "WasSuccessful": false
}
```


# Create ContractDeposit
Source: https://learn.nexudus.com/rest-api/billing/post-contractdeposits

POST /api/billing/contractdeposits
Create a new ContractDeposit record.

A **ContractDeposit** represents a security deposit or retainer associated with a plan contract (`CoworkerContract`). Each deposit is based on a `Product` and is charged to the member either on the first invoice generated for the contract, or on the next invoice for any contract that has `IncludeSignupFee = true`.

ContractDeposits are created automatically when a contract is signed for a plan (`Tariff`) that includes one or more `TariffSignupProducts`. Each `TariffSignupProduct` on the plan becomes a corresponding `ContractDeposit` on the new contract.

When `Refundable = true`, cancelling the parent contract automatically generates a credit note for the deposit amount. That credit note can then be applied — fully or partially — against any outstanding fees or damage charges raised via a separate invoice.

## Authentication

<Note>
  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 **`ContractDeposit-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or internal comments about this deposit.
</ParamField>

<ParamField type="number">
  Deposit amount to charge. When set, overrides the default price of the linked product.
</ParamField>

<ParamField type="boolean">
  When true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ParamField>

<ParamField type="boolean">
  Whether invoice during online checkout is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/contractdeposits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ProductId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ProductId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ProductId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractdeposit was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractDeposit 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ContractPausedPeriod
Source: https://learn.nexudus.com/rest-api/billing/post-contractpausedperiods

POST /api/billing/contractpausedperiods
Create a new ContractPausedPeriod record.

A **ContractPausedPeriod** represents a freeze period applied to a customer's plan contract (`CoworkerContract`). Plan freezing lets admins — and optionally customers — suspend a contract for one or more billing cycles without cancelling it.

Freeze dates are always aligned to billing cycle boundaries: `PauseFrom` is always the first day of the customer's next billing cycle, and `PauseUntil` is always the first day of the billing cycle when the plan is due to restart.

While a contract is frozen:

* No charges are generated for the contract for the duration of the freeze.
* The customer's status reverts to **Contact** if they have no other active contract.
* No member rates or benefits from the frozen contract apply during the freeze.
* Invoices are still generated on the usual billing day for any purchases (bookings, products) linked to the contract.

Admins can freeze contracts from the customer's account, via teams, or in bulk from Finance > Contracts. Whether customers can freeze their own plans from the Members Portal is controlled by the `AllowContractFreezing` setting on the plan (`Tariff`).

## Authentication

<Note>
  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 **`ContractPausedPeriod-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the customer contract being frozen.
</ParamField>

<ParamField type="string">
  UTC date when the freeze starts. Always falls on the first day of a billing cycle.
</ParamField>

<ParamField type="string">
  UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or reason for this freeze period.
</ParamField>

<ParamField type="string">
  Location-timezone equivalent of PauseFrom.
</ParamField>

<ParamField type="string">
  Location-timezone equivalent of PauseUntil.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "PauseFrom": "2025-01-15T10:30:00Z",
      "PauseUntil": "2025-01-15T10:30:00Z"
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        PauseFrom: '2025-01-15T10:30:00Z',
        PauseUntil: '2025-01-15T10:30:00Z'
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'PauseFrom': '2025-01-15T10:30:00Z',
          'PauseUntil': '2025-01-15T10:30:00Z'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractpausedperiod was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractPausedPeriod 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PauseFrom: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PauseFrom"
    }
  ],
  "WasSuccessful": false
}
```


# Create ContractProduct
Source: https://learn.nexudus.com/rest-api/billing/post-contractproducts

POST /api/billing/contractproducts
Create a new ContractProduct record.

A **ContractProduct** is a product added to a contract that is billed every time the contract is invoiced. Use `ContractProduct` to append product charges to a specific member's billing cycle alongside the base plan.

**Price** — If `Price` is not set, the price of the underlying product (`ProductPrice`) is used instead. Set `Price` to override the product's default price for this specific contract line.

**Billing window** — `RepeatFrom` and `RepeatUntil` control the date range during which the product is included on invoices. Outside that range the product is silently skipped. Leave both null to bill the product on every invoice.

**Pro-rating** — `ApplyProRating` distributes the charge proportionally across the billing period, but only takes effect when the linked location plan has prorating enabled (`Tariff.ProrateDaysBefore > 0`). If the plan does not have prorating configured, `ApplyProRating` is ignored.

## Authentication

<Note>
  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 **`ContractProduct-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  Contract to add this product to.
</ParamField>

<ParamField type="integer">
  Product to bill on each contract invoice.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this contract product.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/contractproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ProductId": 0,
      "Quantity": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ProductId: 0,
        Quantity: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/contractproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ProductId': 0,
          'Quantity': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/post-contractschedules

POST /api/billing/contractschedules
Create a new ContractSchedule record.

A **ContractSchedule** defines a future price change for a plan contract (`CoworkerContract`). On the date specified by `ApplyOn`, the system automatically updates the contract's price to the value in `Price`.

Schedules allow operators to pre-configure stepped pricing — for example, an introductory rate for the first few months that transitions to a full rate on a known date — without any manual intervention at the time of the change.

Once a schedule has been processed, `Applied` is set to `true` and the record becomes read-only.

## Authentication

<Note>
  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 **`ContractSchedule-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="string">
  Date on which the system will automatically update the contract price to the value in Price.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or internal comments about this scheduled price change.
</ParamField>

<ParamField type="number">
  The new contract price to apply on the scheduled date.
</ParamField>

<ParamField type="string">
  Date/time value for apply on local.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/contractschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z"
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ApplyOn: '2025-01-15T10:30:00Z'
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/contractschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractschedule was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractSchedule 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerbookingcredits

POST /api/billing/coworkerbookingcredits
Create a new CoworkerBookingCredit record.

A **CoworkerBookingCredit** is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer's contract on a plan that includes a `TariffBookingCredit` renews, but can also be created manually.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ValidFrom` and `ExpireDate` to control the validity window of the credit.

## Authentication

<Note>
  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 **`CoworkerBookingCredit-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the customer this credit is assigned to.
</ParamField>

<ParamField type="integer">
  ID of the location issuing the credit.
</ParamField>

<ParamField type="number">
  Total credit amount originally assigned.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional description or label for this credit.
</ParamField>

<ParamField type="integer[]">
  Resource types this credit can be used for. If empty, the credit is valid for all resource types.
</ParamField>

<ParamField type="integer[]">
  Products this credit can be used for. If empty, applies to all products.
</ParamField>

<ParamField type="integer[]">
  Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.
</ParamField>

<ParamField type="string">
  Date from which this credit is valid.
</ParamField>

<ParamField type="string">
  Date on which this credit expires.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  Event categories this credit can be used for. If empty, applies to all event categories.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="boolean">
  Whether to use the credit price instead of the standard booking price when this credit is applied.
</ParamField>

<ParamField type="string">
  Unique ID of the contract that originated this credit.
</ParamField>

<ParamField type="integer[]">
  Time passes this credit can be used for. If empty, applies to all passes.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "TotalCredit": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        TotalCredit: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerbookingcredit was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerBookingCredit 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RemainingCredit: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RemainingCredit"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerBookingCreditUseHistory
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerbookingcreditusehistories

POST /api/billing/coworkerbookingcreditusehistories
Create a new CoworkerBookingCreditUseHistory record.

A **CoworkerBookingCreditUseHistory** records each time a `CoworkerBookingCredit` was consumed. Each entry captures the amount of credit deducted and links back to the booking, event attendance, or invoice line that triggered the use.

Use the read-only denormalised fields (`BookingFromTime`, `BookingResourceName`, `EventAttendeeCalendarEventName`, etc.) to inspect what the credit was spent on without needing to fetch the related records separately.

## Authentication

<Note>
  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 **`CoworkerBookingCreditUseHistory-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the booking credit that was consumed.
</ParamField>

<ParamField type="number">
  Amount of credit consumed by this entry.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional description or note for this credit use entry.
</ParamField>

<ParamField type="integer">
  ID of the booking this credit was applied to, if the credit was used for a booking.
</ParamField>

<ParamField type="integer">
  ID of the invoice line this credit was applied to, if the credit was used against an invoice.
</ParamField>

<ParamField type="integer">
  ID of the event attendance record this credit was applied to, if the credit was used for an event.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerBookingCreditId": 0,
      "CreditUsed": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerBookingCreditId: 0,
        CreditUsed: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerBookingCreditId': 0,
          'CreditUsed': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerbookingcreditusehistory was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerBookingCreditUseHistory 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "CreditUsed: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CreditUsed"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerContract
Source: https://learn.nexudus.com/rest-api/billing/post-coworkercontracts

POST /api/billing/coworkercontracts
Create a new CoworkerContract record.

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

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

## Enums

<Accordion title="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                    |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the issued by linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Day of month on which billing occurs.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the next tariff linked to this record.
</ParamField>

<ParamField type="string">
  Free-text notes for this contract.
</ParamField>

<ParamField type="string">
  Contract start date.
</ParamField>

<ParamField type="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.
</ParamField>

<ParamField type="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.
</ParamField>

<ParamField type="string">
  Minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.
</ParamField>

<ParamField type="number">
  Fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice).
</ParamField>

<ParamField type="number">
  Contract value used in reporting to compare against the actual invoiced price.
</ParamField>

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Whether to include the plan's signup fee when creating this contract.
</ParamField>

<ParamField type="boolean">
  Whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.
</ParamField>

<ParamField type="string">
  Date of the next automatic invoice generation for this contract.
</ParamField>

<ParamField type="boolean">
  Whether the customer has accepted the plan's terms and conditions.
</ParamField>

<ParamField type="string">
  Date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.
</ParamField>

<ParamField type="integer">
  Minimum number of days' notice required before cancellation takes effect.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the final invoice when the contract is cancelled mid-cycle.
</ParamField>

<ParamField type="boolean">
  Whether to cascade cancellation to contracts of team members under this customer.
</ParamField>

<ParamField type="integer">
  Reason for cancellation. See `eCancellationReason?` enum above.
</ParamField>

<ParamField type="string">
  Free-text notes about the cancellation.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for checks. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for mail. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for parcels. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for publicity. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="string">
  Free-text delivery instructions for this contract's mail handling.
</ParamField>

<ParamField type="string">
  Date by which identity verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Date by which address verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Date/time value for start date local.
</ParamField>

<ParamField type="string">
  Date/time value for renewal date local.
</ParamField>

<ParamField type="string">
  Date/time value for next auto invoice local.
</ParamField>

<ParamField type="string">
  Date/time value for price plan terms accepted on local.
</ParamField>

<ParamField type="string">
  Date/time value for cancellation date local.
</ParamField>

<ParamField type="string">
  Date/time value for contract term local.
</ParamField>

<ParamField type="string">
  Date/time value for invoiced period local.
</ParamField>

<ParamField type="string">
  PO box number.
</ParamField>

### Children

<ParamField type="object[]">
  Scheduled future price changes for this contract. Each entry sets a new Price to apply on a given date

  <Expandable>
    <ParamField type="number">
      The new contract price to apply on the scheduled date.
    </ParamField>

    <ParamField type="string">
      Date on which the system will automatically update the contract price to the value in Price.
    </ParamField>
  </Expandable>
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkercontracts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "IssuedById": 0,
      "CoworkerId": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0,
      "ContractSchedules": [
          {
              "Price": null,
              "ApplyOn": "2025-01-15T10:30:00Z"
          }
      ]
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        IssuedById: 0,
        CoworkerId: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0,
        ContractSchedules: [object Object]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/coworkercontracts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'IssuedById': 0,
          'CoworkerId': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0,
          'ContractSchedules': [object Object]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkercontract was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerContract 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PriceWithProductsAndDeposits: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PriceWithProductsAndDeposits"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerDiscountCode
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerdiscountcodes

POST /api/billing/coworkerdiscountcodes
Create a new CoworkerDiscountCode record.

A **CoworkerDiscountCode** assigns a `DiscountCode` to a specific customer, allowing the system to track per-customer redemption history and enforce individual validity windows.

Use `ValidFrom` and `ExpiresOn` to set customer-specific validity dates. These are distinct from the discount code's own `ValidFrom`/`ValidTo` and `ExpirationType`/`ExpiresIn` fields — the system enforces whichever constraint is more restrictive.

When the discount is part of the referral programme, `RefererGuid` identifies the referring customer. `BookingUniqueId` links the assignment to the specific booking where the code was originally applied.

## Authentication

<Note>
  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 **`CoworkerDiscountCode-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the customer this discount code is assigned to.
</ParamField>

<ParamField type="integer">
  ID of the location this assignment belongs to.
</ParamField>

<ParamField type="integer">
  ID of the discount code assigned to this customer.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes about this discount code assignment.
</ParamField>

<ParamField type="string">
  Customer-specific date from which this discount code assignment becomes valid.
</ParamField>

<ParamField type="string">
  Customer-specific date after which this discount code assignment expires.
</ParamField>

<ParamField type="string">
  Unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
</ParamField>

<ParamField type="string">
  Unique identifier of the booking to which this discount code was applied.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "DiscountCodeId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        DiscountCodeId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerdiscountcode was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerDiscountCode 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerExtraService
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerextraservices

POST /api/billing/coworkerextraservices
Create a new CoworkerExtraService record.

A **CoworkerExtraService** records a charge or credit assigned to a customer. It covers three use cases:

* **Booking charges** — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via `BookingId` and track the resource, time range, and price.
* **Time credit** — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the `ChargePeriod` of the linked extra service (minutes, days, uses, etc.). `TotalUses` and `RemainingUses` track the allowance.
* **Printing credit** — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has `IsPrintingCredit = true`. `TotalUses` and `RemainingUses` track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When `IsFromTariff` is `true`, the record was provisioned by a customer's contract (CoworkerContract) and is linked via `CoworkerContractUniqueId`.

## Authentication

<Note>
  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 **`CoworkerExtraService-Create`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
</ParamField>

<ParamField type="integer">
  Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths). Defaults to `eChargePeriod.Minutes`.
</ParamField>

### Optional Fields

<ParamField type="string">
  Internal notes.
</ParamField>

<ParamField type="boolean">
  Whether this charge or credit is free (no cost to the customer).
</ParamField>

<ParamField type="number">
  Price charged for this extra service.
</ParamField>

<ParamField type="string">
  Date from which this credit becomes usable.
</ParamField>

<ParamField type="string">
  Date when this credit expires and can no longer be used.
</ParamField>

<ParamField type="string">
  Payment due date for the charge.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Invoice the customer directly instead of the team or company paying member.
</ParamField>

<ParamField type="integer">
  ID of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Start time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  End time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Name of the resource booked (e.g., meeting room name).
</ParamField>

<ParamField type="string">
  Links this credit back to the customer contract that provisioned it.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "ExtraServiceId": 0,
      "TotalUses": 0,
      "ChargePeriod": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        ExtraServiceId: 0,
        TotalUses: 0,
        ChargePeriod: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerextraservice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraService 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ChargePeriod: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ChargePeriod"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerExtraServiceUseHistory
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerextraserviceusehistories

POST /api/billing/coworkerextraserviceusehistories
Create a new CoworkerExtraServiceUseHistory record.

A **CoworkerExtraServiceUseHistory** is an audit record of how a customer's extra service credits have been consumed. Each record links a `CoworkerExtraService` allowance to the booking that spent it.

Use this entity to review extra service credit consumption across bookings — for example, to verify how many credits a customer used for a specific meeting room reservation or resource booking.

All fields are read-only; this entity is a ledger view and cannot be modified directly.

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker extra service linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the booking linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerExtraServiceId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerExtraServiceId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerextraserviceusehistory was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraServiceUseHistory 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerInvoiceHistory
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerinvoicehistories

POST /api/billing/coworkerinvoicehistories
Create a new CoworkerInvoiceHistory record.

A **CoworkerInvoiceHistory** records a history entry for a customer invoice. Each entry captures an activity or event that occurred on that invoice, such as the invoice being sent, an e-invoicing action, a payment receipt, or a payment error.

Use `IsProblem` to flag entries that represent errors or issues (e.g. a failed payment attempt). Set `Notify` to trigger a notification when the history entry is created.

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

<ParamField type="string">
  Short title of the history entry (e.g. 'Invoice sent', 'Payment received').
</ParamField>

<ParamField type="string">
  Detailed description of the activity or event recorded by this history entry.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).
</ParamField>

<ParamField type="boolean">
  Whether to send a notification when this history entry is created.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0,
      "Name": "",
      "Description": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerInvoiceId: 0,
        Name: '',
        Description: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerInvoiceId': 0,
          'Name': '',
          'Description': ''
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoicehistory was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoiceHistory 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerInvoicePaymentToken
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerinvoicepaymenttokens

POST /api/billing/coworkerinvoicepaymenttokens
Create a new CoworkerInvoicePaymentToken record.

A **CoworkerInvoicePaymentToken** is an internal record of the token used to process the payment for a customer invoice.

Each token links a `CoworkerInvoice` to the payment provider and the provider-specific token string used to authorise or capture the payment. Use the `Notes` field to store any additional context about the token.

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-Create`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer">
  Payment provider used to process the invoice. See `eRegularPaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Provider-specific token used to authorise or capture the payment.
</ParamField>

<ParamField type="string">
  Additional notes about the payment token.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerInvoiceId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoicepaymenttoken was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoicePaymentToken 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerLedgerEntry
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerledgerentries

POST /api/billing/coworkerledgerentries
Create a new CoworkerLedgerEntry record.

A **CoworkerLedgerEntry** is an individual financial transaction line in a customer's ledger. Ledger entries record debits, credits, and the running balance between a location and a customer.

Each entry can be linked to a `CoworkerInvoice` and carries a `PaymentGatewayName` that identifies which payment provider processed the transaction.

The ledger balance reflects the net financial position between the location and the customer:

* A **positive** balance means the customer owes money (unpaid invoices).
* A **negative** balance means the customer has credited payments that will be applied to future invoices.
* A balance of **0** means the account is settled with no outstanding invoices or credits.

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-Create`** role.
</Note>

## Enums

<Accordion title="ePaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | PayPalStandard             |
  | 2     | PaypalStandardSubscription |
  | 3     | GoCardless                 |
  | 4     | Stripe                     |
  | 5     | AuthorizeNetDirect         |
  | 6     | UsaEPay                    |
  | 7     | AuthorizeNetSubscription   |
  | 8     | Adyen                      |
  | 9     | MultiGateway               |
  | 11    | Manual                     |
  | 12    | Forte                      |
  | 13    | PayPalAdaptive             |
  | 14    | GoCardlessPro              |
  | 15    | CreditCard                 |
  | 16    | EPay                       |
  | 17    | Braintree                  |
  | 18    | MidTrans                   |
  | 19    | EziDebit                   |
  | 20    | LiqPay                     |
  | 21    | RazorPay                   |
  | 22    | SquareCash                 |
  | 23    | SquareCreditCard           |
  | 24    | StripeACH                  |
  | 25    | StripeDirectDebit          |
  | 26    | IZettleCreditCard          |
  | 27    | PeachPayments              |
  | 28    | Klarna                     |
  | 29    | StripeTerminal             |
  | 30    | PayPalStandardRest         |
  | 401   | HostedPaymentPage1         |
  | 402   | HostedPaymentPage2         |
  | 403   | HostedPaymentPage3         |
  | 500   | Xero                       |
  | 501   | Quickbooks                 |
  | 989   | ManualDirectDebit          |
  | 990   | BadDebt                    |
  | 991   | CreditCardManual1          |
  | 992   | CreditCardManual2          |
  | 993   | CreditCardManual3          |
  | 994   | Credit                     |
  | 995   | Gift                       |
  | 996   | Bank                       |
  | 997   | Cash                       |
  | 998   | Check                      |
  | 999   | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Free-text description of this coworker ledger entry.
</ParamField>

<ParamField type="string">
  Ledger entry code.
</ParamField>

<ParamField type="number">
  Debit amount.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Account balance after this transaction. Read-only.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

<ParamField type="integer">
  Payment gateway name. See `ePaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Payment method number.
</ParamField>

<ParamField type="string">
  Transaction date.
</ParamField>

<ParamField type="boolean">
  Whether this entry has been billed.
</ParamField>

<ParamField type="string">
  Transaction date in the location's local time.
</ParamField>

<ParamField type="string">
  Connected transaction GUID.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "CoworkerId": 0,
      "Description": "",
      "Code": "",
      "Debit": 0,
      "Credit": 0,
      "Balance": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        CoworkerId: 0,
        Description: '',
        Code: '',
        Debit: 0,
        Credit: 0,
        Balance: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'CoworkerId': 0,
          'Description': '',
          'Code': '',
          'Debit': 0,
          'Credit': 0,
          'Balance': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerledgerentry was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerLedgerEntry 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerPaymentMethod
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerpaymentmethods

POST /api/billing/coworkerpaymentmethods
Create a new CoworkerPaymentMethod record.

A **CoworkerPaymentMethod** is a tokenised payment method stored against a customer and a location, used when charging invoices issued to that customer by that location.

Currently supported providers are **Stripe** (card and ACH/BACS) and **GoCardless** (direct debit mandates). The `RegularPaymentProvider` field identifies the provider; valid values for this entity are `Stripe` (2), `StripeACH` (11), `StripeBACS` (13), and `GoCardless` (12).

* For Stripe methods, `MethodId` holds the Stripe payment method ID and `CustomerId` holds the Stripe customer ID.
* For GoCardless mandates, `MandateId` holds the GoCardless mandate ID and `CustomerId` holds the GoCardless customer ID.
* `CardNumber` stores a masked card number for display purposes only.

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-Create`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  Customer this payment method belongs to.
</ParamField>

<ParamField type="integer">
  Location that issued or will charge invoices using this payment method.
</ParamField>

### Optional Fields

<ParamField type="integer">
  Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12).. See `eRegularPaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Provider payment method ID (e.g. Stripe payment method ID).
</ParamField>

<ParamField type="string">
  Provider customer ID (e.g. Stripe or GoCardless customer ID).
</ParamField>

<ParamField type="string">
  GoCardless mandate ID. Only populated for GoCardless payment methods..
</ParamField>

<ParamField type="string">
  Masked card number for display purposes only.
</ParamField>

<ParamField type="string">
  Optional notes about this payment method.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0
  }'
  ```

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

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerpaymentmethod was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerPaymentMethod 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerProduct
Source: https://learn.nexudus.com/rest-api/billing/post-coworkerproducts

POST /api/billing/coworkerproducts
Create a new CoworkerProduct record.

A **CoworkerProduct** is a record of a product sold to a customer as a one-off or on a recurrent basis.

`RepeatCycle` can only be set to `PricePlan` if the customer has a contract set as their main contract. In general, it is best to use `ContractProduct` instead of adding CoworkerProducts repeating based on `PricePlan`.

`InvoiceThisCoworker` indicates this customer should be invoiced for this product instead of the paying member of their team.

`ActivateNow` releases any benefits (credits or passes) even before the product is invoiced and paid.

`ProductApplyProRating` indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (`RenewalDate`) of the customer's main contract.

Properties ending in `UniqueId` link the sale to the originating record using its GUID `UniqueId` property (not the integer ID). Only one of these will be populated per record:

| UniqueId property          | Source entity    |
| -------------------------- | ---------------- |
| `CoworkerContractUniqueId` | CoworkerContract |
| `ContractDepositUniqueId`  | ContractDeposit  |
| `ContractProductUniqueId`  | ContractProduct  |
| `BookingUniqueId`          | Booking          |
| `CoworkerDeliveryUniqueId` | CoworkerDelivery |

## Authentication

<Note>
  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 **`CoworkerProduct-Create`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="integer">
  Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. Defaults to `eRecurrentChargePattern.PricePlan`.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Discount amount.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this coworker product.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
</ParamField>

<ParamField type="boolean">
  Invoice this customer for this product instead of the paying member of their team.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="integer">
  Number of repeat units.
</ParamField>

<ParamField type="string">
  Invoice on date.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="string">
  Sale date.
</ParamField>

<ParamField type="string">
  Due date.
</ParamField>

<ParamField type="boolean">
  Whether it has been invoiced.
</ParamField>

<ParamField type="boolean">
  Whether mrm reminded is enabled.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating.
</ParamField>

<ParamField type="string">
  ID of the proposal unique associated with this record.
</ParamField>

<ParamField type="integer">
  Coworker invoice ID.
</ParamField>

<ParamField type="string">
  Coworker invoice number.
</ParamField>

<ParamField type="boolean">
  Whether coworker invoice is paid.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/coworkerproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "ProductId": 0,
      "Quantity": 0,
      "RepeatCycle": 0,
      "CreditAmount": 0,
      "DiscountAmount": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        ProductId: 0,
        Quantity: 0,
        RepeatCycle: 0,
        CreditAmount: 0,
        DiscountAmount: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/coworkerproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'ProductId': 0,
          'Quantity': 0,
          'RepeatCycle': 0,
          'CreditAmount': 0,
          'DiscountAmount': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}
```


# Create CoworkerTimePass
Source: https://learn.nexudus.com/rest-api/billing/post-coworkertimepasses

POST /api/billing/coworkertimepasses
Create a new CoworkerTimePass record.

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

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

## Request Body

### Required Fields

<ParamField type="integer">
  The customer who owns this time pass.
</ParamField>

<ParamField type="integer">
  The business (location) this time pass belongs to.
</ParamField>

<ParamField type="integer">
  The time pass definition this is an instance of.
</ParamField>

<ParamField type="integer">
  Number of time passes to create at once.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes for this time pass.
</ParamField>

<ParamField type="string">
  Purchase order reference.
</ParamField>

<ParamField type="boolean">
  Whether this time pass has been used.
</ParamField>

<ParamField type="boolean">
  Whether this time pass is free of charge.
</ParamField>

<ParamField type="number">
  Custom price for this time pass.
</ParamField>

<ParamField type="string">
  Expiration date for this time pass.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a tariff time pass allocation.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a customer product purchase.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a customer contract.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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
  }'
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkertimepass was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create DiscountCode
Source: https://learn.nexudus.com/rest-api/billing/post-discountcodes

POST /api/billing/discountcodes
Create a new DiscountCode record.

A **DiscountCode** represents a discount registered in the system. Each discount code belongs to a `Business` (location) and defines a percentage or fixed-amount discount that can be applied to different item types: price plans (tariffs), bookings, products, and/or events.

Use the boolean flags (`DiscountPricePlans`, `DiscountBookings`, `DiscountProducts`, `DiscountEvents`) to control which item categories the discount applies to. For each enabled category, associate the specific eligible items via the corresponding ID list (e.g. `Tariffs`, `ResourceTypes`, `Products`, `EventCategories`). Use the `Added*` and `Removed*` list variants for incremental updates without replacing the full list.

A discount can specify either `DiscountPercentage` (e.g. 10 for 10% off) or `DiscountAmount` (a fixed monetary amount off), but not both.

Discount codes can be assigned to individual customers via `CoworkerDiscountCode`. Availability can be further restricted by validity dates (`ValidFrom`/`ValidTo`), publish window (`PublishFrom`/`PublishTo`), usage caps (`MaxUses`, `MaxUsesPerUser`), audience (`OnlyForContacts`, `OnlyForMembers`), and expiration rules (`ExpirationType`, `ExpiresIn`).

## Authentication

<Note>
  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 **`DiscountCode-Create`** role.
</Note>

## Enums

<Accordion title="eDiscountExpirePeriod">
  | Value | Name  |
  | ----- | ----- |
  | 1     | Day   |
  | 2     | Week  |
  | 3     | Month |
  | 4     | Year  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  The unique alphanumeric code customers enter to apply the discount.
</ParamField>

<ParamField type="string">
  Human-readable description of what this discount code is for.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether this discount code is currently active and can be redeemed.
</ParamField>

<ParamField type="string">
  Date from which this discount code is visible/published to customers.
</ParamField>

<ParamField type="string">
  Date until which this discount code is visible/published to customers.
</ParamField>

<ParamField type="number">
  Percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.
</ParamField>

<ParamField type="number">
  Fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.
</ParamField>

<ParamField type="boolean">
  Whether this discount code is used as part of the referral program.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.
</ParamField>

<ParamField type="integer[]">
  List of resource types linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to products. When true, use Products to restrict to specific products.
</ParamField>

<ParamField type="integer[]">
  List of products linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="integer">
  Maximum number of times a single customer can redeem this discount code.
</ParamField>

<ParamField type="integer">
  Maximum total number of times this discount code can be redeemed across all customers.
</ParamField>

<ParamField type="boolean">
  When true, only contacts (non-member customers) can use this discount code.
</ParamField>

<ParamField type="boolean">
  When true, only members (customers with an active plan) can use this discount code.
</ParamField>

<ParamField type="string">
  Start date from which this discount code can be redeemed.
</ParamField>

<ParamField type="string">
  End date after which this discount code can no longer be redeemed.
</ParamField>

<ParamField type="integer">
  Unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer. See `eDiscountExpirePeriod?` enum above.
</ParamField>

<ParamField type="integer">
  Number of ExpirationType periods after assignment until the discount expires for a customer.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/discountcodes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Code": "",
      "Description": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Code: '',
        Description: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the discountcode was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "DiscountCode 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Code: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Code"
    }
  ],
  "WasSuccessful": false
}
```


# Create ExtraServicePrice
Source: https://learn.nexudus.com/rest-api/billing/post-extraserviceprices

POST /api/billing/extraserviceprices
Create a new ExtraServicePrice record.

An **ExtraServicePrice** provides an overriding price for an `ExtraService` (resource price) for members on a specific `Tariff` (plan).

When a member whose active plan matches `TariffId` books a resource priced by the linked extra service, the `Price` (and optional `MaximumPrice`) from this record are used instead of the default extra service price.

In most cases it is preferred to create additional `ExtraService` records connected to the same `ResourceTypes` and restricted to specific plans via `ExtraService.Tariffs`, rather than using ExtraServicePrice overrides. Use ExtraServicePrice only when you need a simple price override without duplicating the full extra service configuration.

## Authentication

<Note>
  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 **`ExtraServicePrice-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Overriding price charged to members on the specified tariff.
</ParamField>

### Optional Fields

<ParamField type="number">
  Optional maximum price cap for time-based extra services on the specified tariff.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/extraserviceprices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ExtraServiceId": 0,
      "TariffId": 0,
      "Price": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ExtraServiceId: 0,
        TariffId: 0,
        Price: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/extraserviceprices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ExtraServiceId': 0,
          'TariffId': 0,
          'Price': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraserviceprice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServicePrice 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Price: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Price"
    }
  ],
  "WasSuccessful": false
}
```


# Create ExtraService
Source: https://learn.nexudus.com/rest-api/billing/post-extraservices

POST /api/billing/extraservices
Create a new ExtraService record.

An **ExtraService** serves two distinct purposes:

1. **Resource-type pricing rule** — defines how one or more resource types are billed. A single resource type can have multiple extra services — for example, one per charge period (hourly, half-day, full-day) or one per customer segment.
2. **Printing credit** — when `IsPrintingCredit` is `true`, the extra service represents a printing allowance rather than booking time. In this case `ChargePeriod` must always be `5` (Uses) and `Price` should be set to `1`.

CRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates)

Restrictions available on each extra service include:

* **Charge period** — hourly, daily, etc. (`ChargePeriod`). For printing credit, always use `5` (Uses).
* **Customer type** — members only (`OnlyForMembers`) or contacts only (`OnlyForContacts`)
* **Time window** — bookings must fall within specific hours (`FromTime`, `ToTime`)
* **Booking length** — minimum/maximum duration (`MinLength`, `MaxLength`)
* **Fixed-cost slot** — charge a flat fee for bookings up to a fixed length (`FixedCostLength`, `FixedCostPrice`)
* **Dynamic pricing** — price factors for low/average/high demand and last-minute bookings
* **Date range** — apply only between specific dates (`ApplyFrom`, `ApplyTo`)

To set up pricing for a resource type, create one `ExtraService` per pricing rule and associate it with the desired resource type(s) using or the resource types assignment. The `ResourceTypeNames` field on an extra service shows which resource types it currently applies to.

To create a **printing credit** extra service, set ``IsPrintingCredit` true`, ``ChargePeriod` 5`, and \`\`Price` 1`. Resource type assignment is not required for printing credit extra services.

### Setting up hourly pricing

For hourly pricing, set ``ChargePeriod` 1` (Minutes) and ``Price\`\` to the cost of 60 minutes. The system interprets a charge period of 1 minute as hourly billing when the price represents a full hour.

Example — create a \$50/hour meeting room pricing rule:

## Authentication

<Note>
  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 **`ExtraService-Create`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eLastMinuteDiscountType — LastMinuteAdjustmentType values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Disabled |
  | 2     | Fixed    |
  | 3     | Gradual  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Extra service name.
</ParamField>

<ParamField type="integer">
  Display order. Defaults to `0`.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

<ParamField type="integer">
  Charge period. Defaults to `eChargePeriod.Minutes`.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Last-minute discount type. Defaults to `eLastMinuteDiscountType.Gradual`.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this extra service.
</ParamField>

<ParamField type="string">
  Invoice line display text.
</ParamField>

<ParamField type="boolean">
  Whether the price is visible on the portal and app. Defaults to `true`.
</ParamField>

<ParamField type="integer[]">
  List of resource types linked to this record.
</ParamField>

<ParamField type="number">
  Credit price.
</ParamField>

<ParamField type="number">
  Maximum price cap.
</ParamField>

<ParamField type="boolean">
  Use as the default price for matched resource types if more than one price applies.
</ParamField>

<ParamField type="boolean">
  Use per-night pricing.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  Start time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  End time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  Minimum booking length (minutes).
</ParamField>

<ParamField type="integer">
  Maximum booking length (minutes).
</ParamField>

<ParamField type="boolean">
  Only apply within the resource's available times.
</ParamField>

<ParamField type="integer">
  Fixed cost booking length threshold (minutes).
</ParamField>

<ParamField type="number">
  Fixed cost price applied once the threshold is reached.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="boolean">
  Only available for contacts.
</ParamField>

<ParamField type="boolean">
  Only available for members.
</ParamField>

<ParamField type="boolean">
  Price uses booking credits.
</ParamField>

<ParamField type="boolean">
  Price uses printing credits.
</ParamField>

<ParamField type="boolean">
  Apply charge to visitors.
</ParamField>

<ParamField type="number">
  Price factor for low demand periods.
</ParamField>

<ParamField type="number">
  Price factor for average demand periods.
</ParamField>

<ParamField type="number">
  Price factor for high demand periods.
</ParamField>

<ParamField type="number">
  Price factor for last-minute bookings.
</ParamField>

<ParamField type="integer">
  Last-minute period threshold (minutes before booking).
</ParamField>

<ParamField type="string">
  Date from which this price applies.
</ParamField>

<ParamField type="string">
  Date until which this price applies.
</ParamField>

<ParamField type="string">
  Comma-separated names of associated resource types.
</ParamField>

<ParamField type="integer[]">
  List of teams linked to this record.
</ParamField>

### Children

<ParamField type="object[]">
  The days and times this extra service price is available for booking. The year, month and day component of FromTime/ToTime is always 1976-01-01.

  <Expandable>
    <ParamField type="integer">
      The day of week value for this extra service time slot.
    </ParamField>

    <ParamField type="string">
      Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
    </ParamField>

    <ParamField type="string">
      End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
    </ParamField>

    <ParamField type="boolean">
      Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
    </ParamField>
  </Expandable>
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/extraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "DisplayOrder": 0,
      "Price": 0,
      "ChargePeriod": 0,
      "CurrencyId": 0,
      "LastMinuteAdjustmentType": 0,
      "TimeSlots": [
          {
              "DayOfWeek": 0,
              "FromTime": "2025-01-15T10:30:00Z",
              "ToTime": "2025-01-15T10:30:00Z",
              "Available": null
          }
      ]
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        DisplayOrder: 0,
        Price: 0,
        ChargePeriod: 0,
        CurrencyId: 0,
        LastMinuteAdjustmentType: 0,
        TimeSlots: [object Object]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/extraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'DisplayOrder': 0,
          'Price': 0,
          'ChargePeriod': 0,
          'CurrencyId': 0,
          'LastMinuteAdjustmentType': 0,
          'TimeSlots': [object Object]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraservice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraService 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Run command for ExtraServices
Source: https://learn.nexudus.com/rest-api/billing/post-extraservices-run-command

POST /api/billing/extraservices/runcommand
Execute a command on one or more ExtraService records.

Executes a command on one or more ExtraService records. Use the [Commands endpoint](/rest-api/billing/get-extraservices-commands) to discover available commands and their required parameters.

## Authentication

<Note>
  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 **`ExtraService-Update`** role.
</Note>

## Request Body

<ParamField type="string">
  The command key to execute. Obtain available keys from the [Commands endpoint](/rest-api/billing/get-extraservices-commands).
</ParamField>

<ParamField type="integer[]">
  List of ExtraService record Ids to execute the command on.
</ParamField>

<ParamField type="object[]">
  If the command requires parameters, provide them as an array of objects with `Name` and `Value` fields.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/extraservices/runcommand" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Key": "COMMAND_KEY_1",
      "Ids": [87654321, 87654322],
      "Parameters": [
        {
          "Name": "Parameter name",
          "Value": "Parameter value"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices/runcommand',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Key: 'COMMAND_KEY_1',
        Ids: [87654321, 87654322],
        Parameters: [
          {
            Name: 'Parameter name',
            Value: 'Parameter value'
          }
        ]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/extraservices/runcommand',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Key': 'COMMAND_KEY_1',
          'Ids': [87654321, 87654322],
          'Parameters': [
              {
                  'Name': 'Parameter name',
                  'Value': 'Parameter value'
              }
          ]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the command was executed.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains details about the command execution result.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the command was executed successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```


# Create ExtraServiceTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/post-extraservicetimeslots

POST /api/billing/extraservicetimeslots
Create a new ExtraServiceTimeSlot record.

An **ExtraServiceTimeSlot** defines the days and times during which an `ExtraService` (resource pricing rule) is available for booking. Each time slot specifies a day of the week and a from/to time window.

The year, month, and day components of `FromTime` and `ToTime` are always `1976-01-01` — only the time-of-day portion is meaningful.

When no time slots are defined for an extra service, the price applies at all times. Adding time slots restricts the price to the specified windows only.

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-Create`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="string">
  End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="integer">
  The day of week value for this extra service time slot.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ExtraServiceId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ExtraServiceId: 0,
        FromTime: '2025-01-15T10:30:00Z',
        ToTime: '2025-01-15T10:30:00Z',
        DayOfWeek: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ExtraServiceId': 0,
          'FromTime': '2025-01-15T10:30:00Z',
          'ToTime': '2025-01-15T10:30:00Z',
          'DayOfWeek': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraservicetimeslot was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServiceTimeSlot 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}
```


# Create FinancialAccount
Source: https://learn.nexudus.com/rest-api/billing/post-financialaccounts

POST /api/billing/financialaccounts
Create a new FinancialAccount record.

A **FinancialAccount** represents a bookkeeping account used for categorising revenue and payments.

Financial accounts can be assigned to Products, EventProducts, TimePasses, ExtraServices (resource prices), Tariffs and Charges to control how income is tracked and reported.

Each account has a `Code` (typically matching an external accounting system reference), a `Name`, and an `AccountType` that determines where it appears:

| AccountType | Value | Purpose                                      |
| ----------- | ----- | -------------------------------------------- |
| Sales       | 1     | Revenue from products, services and bookings |
| Payments    | 2     | Incoming payment receipts                    |
| Deposits    | 3     | Security deposits held against contracts     |

**Important:** Changing a financial account's details or reassigning it to different items has no effect on existing invoices. The financial account recorded on each invoice line is captured at the time the invoice is issued and is never updated retroactively.

## Authentication

<Note>
  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 **`FinancialAccount-Create`** role.
</Note>

## Enums

<Accordion title="eFinancialAccountType — AccountType values">
  | Value | Name     |
  | ----- | -------- |
  | 0     | None     |
  | 1     | Sales    |
  | 2     | Payments |
  | 3     | Deposits |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Display name for this financial account.
</ParamField>

<ParamField type="string">
  Short reference code, typically matching the account code in an external accounting system.
</ParamField>

<ParamField type="integer">
  Category of the account: Sales (1), Payments (2) or Deposits (3). Defaults to `eFinancialAccountType.Sales`.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional free-text description of the account's purpose.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/financialaccounts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "Code": "",
      "AccountType": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        Code: '',
        AccountType: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/financialaccounts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'Code': '',
          'AccountType': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the financialaccount was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FinancialAccount 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create PaymentGateway
Source: https://learn.nexudus.com/rest-api/billing/post-paymentgateways

POST /api/billing/paymentgateways
Create a new PaymentGateway record.

A **PaymentGateway** represents a connection to one of the supported payment gateways used to process card payments.

Each gateway can be associated to one or more locations (`Business` entity) via the `DefaultPaymentGatewayId` property on the business. A gateway is configured with a specific `PaymentGatewayType` (e.g. `stripe`, `braintree`, `adyen`) and the corresponding credentials (`AccessToken`, `ConfigurationXml`).

An optional `TransactionFee` can be set to track per-transaction costs, and a `FinancialAccountId` and `TaxRateId` can be linked for accounting purposes.

## Authentication

<Note>
  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 **`PaymentGateway-Create`** role.
</Note>

## Enums

<Accordion title="ePaymentGatewayType — PaymentGatewayType values">
  | Value | Name                               |
  | ----- | ---------------------------------- |
  | 0     | None                               |
  | 1     | test                               |
  | 2     | authorize\_net                     |
  | 3     | beanstream                         |
  | 4     | braintree                          |
  | 6     | first\_data\_e4                    |
  | 7     | jetpay\_v2                         |
  | 8     | merchant\_e\_solutions             |
  | 9     | netbilling                         |
  | 10    | payment\_express                   |
  | 12    | sage                               |
  | 13    | stripe                             |
  | 14    | trans\_first                       |
  | 15    | usa\_epay                          |
  | 17    | blue\_pay                          |
  | 18    | cyber\_source                      |
  | 19    | elavon                             |
  | 20    | first\_data\_e4\_v27               |
  | 21    | litle                              |
  | 22    | mercury                            |
  | 23    | nmi                                |
  | 24    | payflow\_pro                       |
  | 25    | quantum                            |
  | 26    | secure\_net                        |
  | 27    | trust\_commerce                    |
  | 28    | worldpay                           |
  | 29    | wirecard                           |
  | 30    | paymill                            |
  | 31    | merchant\_warrior                  |
  | 32    | nab\_transact                      |
  | 33    | secure\_pay\_au                    |
  | 34    | eway                               |
  | 35    | migs                               |
  | 36    | pin                                |
  | 37    | ogone                              |
  | 38    | realex                             |
  | 39    | moneris                            |
  | 40    | psi\_gate                          |
  | 41    | epay                               |
  | 42    | hdfc                               |
  | 43    | net\_pay                           |
  | 44    | redsys                             |
  | 45    | iridium                            |
  | 46    | barclays\_epdq\_extra\_plus        |
  | 49    | paypal                             |
  | 50    | payex                              |
  | 51    | openpay                            |
  | 52    | hps                                |
  | 53    | checkout                           |
  | 54    | checkout\_v2                       |
  | 55    | worldpay\_us                       |
  | 56    | conekta                            |
  | 57    | orbital                            |
  | 59    | barclaycard\_smartpay              |
  | 60    | trans\_first\_transaction\_express |
  | 63    | forte                              |
  | 65    | citrus\_pay                        |
  | 66    | payu\_latam                        |
  | 67    | global\_collect                    |
  | 68    | cayan                              |
  | 69    | clearhaus                          |
  | 70    | sage\_pay                          |
  | 71    | safe\_charge                       |
  | 72    | mercado\_pago                      |
  | 73    | payeezy                            |
  | 200   | acapture                           |
  | 201   | adyen                              |
  | 203   | banco\_sabadell                    |
  | 208   | blue\_snap                         |
  | 209   | borgun                             |
  | 210   | bpoint                             |
  | 212   | bridge\_pay                        |
  | 213   | card\_connect                      |
  | 214   | card\_stream                       |
  | 215   | cardprocess                        |
  | 217   | cecabank                           |
  | 218   | cenpos                             |
  | 224   | creditcall                         |
  | 225   | credorax                           |
  | 226   | ct\_payment                        |
  | 227   | culqi                              |
  | 229   | data\_cash                         |
  | 230   | diamond\_mind                      |
  | 231   | dibs                               |
  | 232   | digitzs                            |
  | 234   | element                            |
  | 237   | eway\_rapid                        |
  | 238   | ezic                               |
  | 239   | fat\_zebra                         |
  | 242   | first\_giving                      |
  | 243   | first\_pay                         |
  | 244   | flo2cash                           |
  | 245   | flo2cash\_simple                   |
  | 247   | global                             |
  | 249   | global\_iris                       |
  | 250   | global\_transport                  |
  | 253   | iats\_payments                     |
  | 255   | iveri                              |
  | 256   | ixopay                             |
  | 257   | jabstry                            |
  | 258   | jetpay                             |
  | 260   | kushki                             |
  | 261   | latitude19                         |
  | 263   | maxipago                           |
  | 266   | merchant\_partners                 |
  | 272   | mundipagg                          |
  | 274   | ncr\_secure\_pay                   |
  | 280   | optimal\_payments                  |
  | 282   | pay\_conex                         |
  | 283   | pay\_junction\_v2                  |
  | 288   | paymentez                          |
  | 291   | paystation                         |
  | 294   | pro\_pay                           |
  | 296   | qbms                               |
  | 298   | quickpay                           |
  | 299   | quickpay\_v10                      |
  | 300   | qvalent                            |
  | 303   | s5                                 |
  | 309   | securion\_pay                      |
  | 312   | tns                                |
  | 317   | vanco                              |
  | 318   | visanet\_peru                      |
  | 319   | wepay                              |
  | 320   | stripe\_payment\_intents           |
  | 321   | stripeACH                          |
  | 323   | quickbooks                         |
  | 324   | monei                              |
  | 401   | HostedPaymentPage1                 |
  | 402   | HostedPaymentPage2                 |
  | 403   | HostedPaymentPage3                 |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Display name for this payment gateway configuration.
</ParamField>

<ParamField type="integer">
  The payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required. Defaults to `ePaymentGatewayType.test`.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether attempt3d secure is enabled.
</ParamField>

<ParamField type="string">
  Provider-specific configuration in XML format (e.g. merchant ID, additional keys).
</ParamField>

<ParamField type="number">
  Fee charged per transaction processed through this gateway.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/paymentgateways" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "PaymentGatewayType": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        PaymentGatewayType: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the paymentgateway was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "PaymentGateway 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProductBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/post-productbookingcredits

POST /api/billing/productbookingcredits
Create a new ProductBookingCredit record.

A **ProductBookingCredit** represents an amount of credit linked to a `Product`. When a customer purchases the product, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ExpirationType` and `ExpiresIn` to control when the released credit expires.

## Authentication

<Note>
  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 **`ProductBookingCredit-Create`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="string">
  Credit name.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of elegible resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of elegible products linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of elegible tariffs linked to this record.
</ParamField>

<ParamField type="integer">
  The expire time in months value for this product booking credit.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Number of periods (of `ExpirationType`) until the released credit expires.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="integer[]">
  List of elegible passes linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/productbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Name": "",
      "ProductId": 0,
      "Credit": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Name: '',
        ProductId: 0,
        Credit: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/productbookingcredits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Name': '',
          'ProductId': 0,
          'Credit': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the productbookingcredit was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductBookingCredit 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProductExtraService
Source: https://learn.nexudus.com/rest-api/billing/post-productextraservices

POST /api/billing/productextraservices
Create a new ProductExtraService record.

A **ProductExtraService** links an `ExtraService` to a `Product`. The meaning of `UsesIncluded` depends on the type of the linked extra service:

* **Booking time** (ExtraService with `IsPrintingCredit = false`) — customers receive an allowance of booking time for the resource type(s) associated with that extra service. For example, a product called "Hot Desk Bundle" might include 2 hours of meeting room usage — achieved by linking a "Meeting Room Hourly" extra service with \`\`UsesIncluded` 120`.
* **Printing credit** (ExtraService with `IsPrintingCredit = true`) — customers receive a number of print jobs/pages. `UsesIncluded` is the number of printing credits included. The linked extra service must have `ChargePeriod = 5` (Uses) and `Price = 1`.

Always check `IsPrintingCredit` on the linked extra service before interpreting `UsesIncluded`.

For booking-time extra services, the unit of `UsesIncluded` is determined by the **ChargePeriod** of the linked `ExtraService`:

| ExtraService ChargePeriod | UsesIncluded unit |
| ------------------------- | ----------------- |
| 1 (Minutes)               | Minutes           |
| 2 (Days)                  | Days              |
| 3 (Weeks)                 | Weeks             |
| 4 (Months)                | Months            |
| 5 (Uses)                  | Individual uses   |
| 6 (FourWeekMonths)        | 4-week periods    |

So \`\`UsesIncluded` 60` on a minutes extra service means 60 minutes of booking time included. On a daily extra service it means 60 full days.

## Authentication

<Note>
  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 **`ProductExtraService-Create`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ExtraServiceChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Uses included.
</ParamField>

### Optional Fields

<ParamField type="integer">
  The expire time in months value for this product extra service.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product extra service.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Expires in.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/productextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProductId": 0,
      "ExtraServiceId": 0,
      "UsesIncluded": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProductId: 0,
        ExtraServiceId: 0,
        UsesIncluded: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/productextraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProductId': 0,
          'ExtraServiceId': 0,
          'UsesIncluded': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the productextraservice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductExtraService 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Run command for ProductExtraServices
Source: https://learn.nexudus.com/rest-api/billing/post-productextraservices-run-command

POST /api/billing/productextraservices/runcommand
Execute a command on one or more ProductExtraService records.

Executes a command on one or more ProductExtraService records. Use the [Commands endpoint](/rest-api/billing/get-productextraservices-commands) to discover available commands and their required parameters.

## Authentication

<Note>
  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 **`ProductExtraService-Update`** role.
</Note>

## Request Body

<ParamField type="string">
  The command key to execute. Obtain available keys from the [Commands endpoint](/rest-api/billing/get-productextraservices-commands).
</ParamField>

<ParamField type="integer[]">
  List of ProductExtraService record Ids to execute the command on.
</ParamField>

<ParamField type="object[]">
  If the command requires parameters, provide them as an array of objects with `Name` and `Value` fields.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/productextraservices/runcommand" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Key": "COMMAND_KEY_1",
      "Ids": [87654321, 87654322],
      "Parameters": [
        {
          "Name": "Parameter name",
          "Value": "Parameter value"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices/runcommand',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Key: 'COMMAND_KEY_1',
        Ids: [87654321, 87654322],
        Parameters: [
          {
            Name: 'Parameter name',
            Value: 'Parameter value'
          }
        ]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/productextraservices/runcommand',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Key': 'COMMAND_KEY_1',
          'Ids': [87654321, 87654322],
          'Parameters': [
              {
                  'Name': 'Parameter name',
                  'Value': 'Parameter value'
              }
          ]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the command was executed.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains details about the command execution result.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the command was executed successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```


# Create Product
Source: https://learn.nexudus.com/rest-api/billing/post-products

POST /api/billing/products
Create a new Product record.

A **Product** represents an item that can be sold to customers. Products can be sold via contracts (`ContractProduct` entity), added to bookings (`BookingProduct` entity), or purchased directly (`CoworkerProduct` entity).

Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using `ContractProduct` to associate the sale directly with a specific contract rather than relying on the customer's `MainContract`.

Use `AvailableAs` to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The `SystemProductType` field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other).

Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.

## Authentication

<Note>
  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 **`Product-Create`** role.
</Note>

## Enums

<Accordion title="eProductType — SystemProductType values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | None            |
  | 1     | DayPass         |
  | 2     | CreditBundle    |
  | 3     | Stationery      |
  | 4     | BookingFeature  |
  | 5     | BookingProducts |
  | 99    | Other           |
</Accordion>

<Accordion title="eRecurrentProductOptions — AvailableAs values">
  | Value | Name              |
  | ----- | ----------------- |
  | 0     | None              |
  | 1     | RecurrentOrOneOff |
  | 2     | OnlyRecurrent     |
  | 3     | OnlyOneOff        |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Product name.
</ParamField>

<ParamField type="integer">
  Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.
</ParamField>

<ParamField type="string">
  Product description.
</ParamField>

<ParamField type="integer">
  Display order. Defaults to `0`.
</ParamField>

<ParamField type="number">
  Product price.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).
</ParamField>

### Optional Fields

<ParamField type="string">
  Custom text shown on the invoice line instead of the product name.
</ParamField>

<ParamField type="string">
  SKU code.
</ParamField>

<ParamField type="string">
  Comma-separated tags for categorising and filtering.
</ParamField>

<ParamField type="boolean">
  Whether the product is visible to customers on the members portal and mobile app. Defaults to `true`.
</ParamField>

<ParamField type="boolean">
  Whether the product is visible to customers in the NexKiosk app.
</ParamField>

<ParamField type="boolean">
  Whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.
</ParamField>

<ParamField type="string">
  Additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.
</ParamField>

<ParamField type="boolean">
  Whether to show the price of this product in AI channel recommendations and responses based on users' budget preferences.
</ParamField>

<ParamField type="number">
  Override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used).
</ParamField>

<ParamField type="boolean">
  Sync to Square Point of Sale.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="boolean">
  Restrict purchase to contacts (customers without an active contract).
</ParamField>

<ParamField type="boolean">
  Restrict purchase to customers with an active contract (members).
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether the product is archived. Archived products cannot be sold but existing charges remain active.
</ParamField>

<ParamField type="boolean">
  Mark the product as featured or highlighted.
</ParamField>

<ParamField type="boolean">
  Enable stock tracking for this product. When enabled, each sale reduces the stock count.
</ParamField>

<ParamField type="boolean">
  Allow sales to continue even when stock reaches zero.
</ParamField>

<ParamField type="integer">
  Stock level at which a low-stock alert is triggered.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the price when the product is added or removed part-way through a billing period.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current image file.
</ParamField>

<ParamField type="boolean">
  Whether to invoice the customer directly rather than their company or team.
</ParamField>

<ParamField type="boolean">
  Sync to NexKiosk.
</ParamField>

<ParamField type="boolean">
  Automatically create a delivery record for the customer when this product is purchased.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/products" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "SystemProductType": 0,
      "Description": "",
      "DisplayOrder": 0,
      "Price": 0,
      "CurrencyId": 0,
      "AvailableAs": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        SystemProductType: 0,
        Description: '',
        DisplayOrder: 0,
        Price: 0,
        CurrencyId: 0,
        AvailableAs: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/products',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'SystemProductType': 0,
          'Description': '',
          'DisplayOrder': 0,
          'Price': 0,
          'CurrencyId': 0,
          'AvailableAs': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the product was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Product 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Run command for Products
Source: https://learn.nexudus.com/rest-api/billing/post-products-run-command

POST /api/billing/products/runcommand
Execute a command on one or more Product records.

Executes a command on one or more Product records. Use the [Commands endpoint](/rest-api/billing/get-products-commands) to discover available commands and their required parameters.

## Authentication

<Note>
  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 **`Product-Update`** role.
</Note>

## Request Body

<ParamField type="string">
  The command key to execute. Obtain available keys from the [Commands endpoint](/rest-api/billing/get-products-commands).
</ParamField>

<ParamField type="integer[]">
  List of Product record Ids to execute the command on.
</ParamField>

<ParamField type="object[]">
  If the command requires parameters, provide them as an array of objects with `Name` and `Value` fields.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/products/runcommand" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Key": "COMMAND_KEY_1",
      "Ids": [87654321, 87654322],
      "Parameters": [
        {
          "Name": "Parameter name",
          "Value": "Parameter value"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products/runcommand',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Key: 'COMMAND_KEY_1',
        Ids: [87654321, 87654322],
        Parameters: [
          {
            Name: 'Parameter name',
            Value: 'Parameter value'
          }
        ]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/products/runcommand',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Key': 'COMMAND_KEY_1',
          'Ids': [87654321, 87654322],
          'Parameters': [
              {
                  'Name': 'Parameter name',
                  'Value': 'Parameter value'
              }
          ]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the command was executed.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains details about the command execution result.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the command was executed successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```


# Create ProductTimePass
Source: https://learn.nexudus.com/rest-api/billing/post-producttimepasses

POST /api/billing/producttimepasses
Create a new ProductTimePass record.

A **ProductTimePass** links a `TimePass` to a `Product` so that customers purchasing the product automatically receive an amount of check-in time. The nature of that time depends on the type of the linked `TimePass`:

* **Day Pass** (TimePass with `MinutesIncluded` = null) — `PassesIncluded` is the number of calendar days. The customer can check in any number of times during each calendar day they hold.
* **Time Pass** (TimePass with `MinutesIncluded` set) — `PassesIncluded` is the number of pass instances (each worth `MinutesIncluded` minutes). Multiply `PassesIncluded` by `MinutesIncluded` to get total hours. For example, `PassesIncluded = 10` with a 60-minute time pass gives the customer 10 hours of check-in time to use across different dates.

## Authentication

<Note>
  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 **`ProductTimePass-Create`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  Passes included.
</ParamField>

### Optional Fields

<ParamField type="integer">
  The expire time in months value for this product time pass.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product time pass.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Expires in.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/producttimepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProductId": 0,
      "TimePassId": 0,
      "PassesIncluded": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProductId: 0,
        TimePassId: 0,
        PassesIncluded: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the producttimepass was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductTimePass 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProposalContract
Source: https://learn.nexudus.com/rest-api/billing/post-proposalcontracts

POST /api/billing/proposalcontracts
Create a new ProposalContract record.

A **ProposalContract** links a contract configuration to a proposal, defining the pricing plan and terms that will be applied if the proposal is accepted by the customer.

## Authentication

<Note>
  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 **`ProposalContract-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Billing day of month.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="string">
  Contract start date.
</ParamField>

<ParamField type="integer">
  Cancellation limit in days.
</ParamField>

<ParamField type="string">
  Contract term end date.
</ParamField>

<ParamField type="string">
  Cancellation date.
</ParamField>

<ParamField type="integer">
  ID of the discount code linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/proposalcontracts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/proposalcontracts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalcontract was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContract 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProposalContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/post-proposalcontractschedules

POST /api/billing/proposalcontractschedules
Create a new ProposalContractSchedule record.

A **ProposalContractSchedule** defines the billing schedule for a contract within a proposal, specifying payment frequency, amounts, and timing.

## Authentication

<Note>
  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 **`ProposalContractSchedule-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the proposal contract linked to this record.
</ParamField>

<ParamField type="string">
  Date to apply.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal contract schedule.
</ParamField>

<ParamField type="number">
  Scheduled price.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalContractId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z"
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalContractId: 0,
        ApplyOn: '2025-01-15T10:30:00Z'
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalContractId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalcontractschedule was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContractSchedule 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProposalProduct
Source: https://learn.nexudus.com/rest-api/billing/post-proposalproducts

POST /api/billing/proposalproducts
Create a new ProposalProduct record.

A **ProposalProduct** links a product to a proposal, defining additional items or services included in the offer with their pricing and recurrence settings.

## Authentication

<Note>
  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 **`ProposalProduct-Create`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="integer">
  Repeat cycle pattern. Defaults to `eRecurrentChargePattern.PricePlan`.
</ParamField>

### Optional Fields

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="boolean">
  Whether this is a deposit.
</ParamField>

<ParamField type="boolean">
  Whether this is a contract product.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="string">
  Invoice on date.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="integer">
  Number of repeat units.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating.
</ParamField>

<ParamField type="string">
  Optional notes or comments about this proposal product.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/proposalproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "ProductId": 0,
      "Quantity": 0,
      "RepeatCycle": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        ProductId: 0,
        Quantity: 0,
        RepeatCycle: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/proposalproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'ProductId': 0,
          'Quantity': 0,
          'RepeatCycle': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}
```


# Create Proposal
Source: https://learn.nexudus.com/rest-api/billing/post-proposals

POST /api/billing/proposals
Create a new Proposal record.

A **Proposal** bundles one or more contracts (`ProposalContract` records) that are presented to a customer for review and acceptance. Each `ProposalContract` carries the same properties as a `CoworkerContract` and becomes one when the proposal is accepted.

When a Proposal is created, a `ProposalContract` is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (`TariffId`, `Desks`, `Variants`, `Price`, `StartDate`, `CancellationLimitDays`, `ContractTerm`, `CancellationDate`, `ExpirationDate`, `BillingDay`, `Quantity`) become read-only — they are all `createOnly`. Subsequent edits to those values must be made via the associated `ProposalContract`. Additional `ProposalContract` records can also be added.

Proposals support three optional attachments:

* **DocumentToSendId** — a `DocumentTemplate` entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
* **DocumentToSignId** — a `DocumentTemplate` entity used to generate a document for e-signature.
* **ProposalFile** — a file shown as a downloadable link before the proposal is accepted.

Set `DoNotIssueInvoice` to control whether the first invoice is issued automatically when the proposal is accepted.

## Authentication

<Note>
  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 **`Proposal-Create`** role.
</Note>

## Enums

<Accordion title="eProposalStatus — ProposalStatus values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Draft    |
  | 2     | Sent     |
  | 3     | Accepted |
  | 4     | Rejected |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the issued by linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the responsible linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Proposal reference.
</ParamField>

<ParamField type="integer">
  Proposal status. Defaults to `eProposalStatus.Draft`.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal.
</ParamField>

<ParamField type="integer">
  ID of the document to send linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the document to sign linked to this record.
</ParamField>

<ParamField type="string">
  The document to sign html value for this proposal.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the document to sign binary document.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current document to sign binary document file.
</ParamField>

<ParamField type="string">
  The document to send html value for this proposal.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the document to send binary document.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current document to send binary document file.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the proposal file.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current proposal file file.
</ParamField>

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="number">
  Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  ID of the discount code linked to this record.
</ParamField>

<ParamField type="string">
  Date/time value for start date local.
</ParamField>

<ParamField type="string">
  Date/time value for sent on local.
</ParamField>

<ParamField type="boolean">
  If true, the first invoice is not issued automatically when the proposal is accepted.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/proposals" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "IssuedById": 0,
      "ResponsibleId": 0,
      "CoworkerId": 0,
      "Reference": "",
      "ProposalStatus": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        IssuedById: 0,
        ResponsibleId: 0,
        CoworkerId: 0,
        Reference: '',
        ProposalStatus: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/proposals',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'IssuedById': 0,
          'ResponsibleId': 0,
          'CoworkerId': 0,
          'Reference': '',
          'ProposalStatus': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposal was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Proposal 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Reference: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Reference"
    }
  ],
  "WasSuccessful": false
}
```


# Create ProposalSchedule
Source: https://learn.nexudus.com/rest-api/billing/post-proposalschedules

POST /api/billing/proposalschedules
Create a new ProposalSchedule record.

A **ProposalSchedule** defines the overall timeline and milestones for a proposal, including validity period and follow-up dates.

## Authentication

<Note>
  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 **`ProposalSchedule-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="string">
  Date to apply.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal schedule.
</ParamField>

<ParamField type="number">
  Scheduled price.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/proposalschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z"
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        ApplyOn: '2025-01-15T10:30:00Z'
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/proposalschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalschedule was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalSchedule 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Create ResourceProduct
Source: https://learn.nexudus.com/rest-api/billing/post-resourceproducts

POST /api/billing/resourceproducts
Create a new ResourceProduct record.

A **ResourceProduct** links a product to a resource, enabling products to be offered as add-ons when booking that resource (e.g. catering, AV equipment, room setup).

## Authentication

<Note>
  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 **`ResourceProduct-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the resource linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether to invoice in minutes.
</ParamField>

<ParamField type="boolean">
  Whether to request quantity.
</ParamField>

<ParamField type="boolean">
  Whether the resource product is visible.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/resourceproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ResourceId": 0,
      "ProductId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ResourceId: 0,
        ProductId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/resourceproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ResourceId': 0,
          'ProductId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the resourceproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ResourceProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/post-tariffbookingcredits

POST /api/billing/tariffbookingcredits
Create a new TariffBookingCredit record.

A **TariffBookingCredit** represents an amount of credit linked to a plan (`Tariff`). When a customer's contract on that plan renews, the credit is automatically released as a `CoworkerBookingCredit` on the customer's account.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ServiceRenewalTime` to control how often the credit is renewed (e.g. weekly, monthly).

## Authentication

<Note>
  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 **`TariffBookingCredit-Create`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="string">
  Credit name.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="integer">
  Service renewal time period.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of elegible resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of elegible products linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of elegible tariffs linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="integer[]">
  List of elegible passes linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Name": "",
      "TariffId": 0,
      "Credit": 0,
      "ServiceRenewalTime": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Name: '',
        TariffId: 0,
        Credit: 0,
        ServiceRenewalTime: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Name': '',
          'TariffId': 0,
          'Credit': 0,
          'ServiceRenewalTime': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffbookingcredit was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffBookingCredit 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffDefaultDueDate
Source: https://learn.nexudus.com/rest-api/billing/post-tariffdefaultduedates

POST /api/billing/tariffdefaultduedates
Create a new TariffDefaultDueDate record.

A **TariffDefaultDueDate** configures the default invoice due date settings for a pricing plan (tariff). This controls when invoices generated for customers on this plan are due for payment.

## Authentication

<Note>
  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 **`TariffDefaultDueDate-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer">
  Day of month to auto collect.
</ParamField>

<ParamField type="integer">
  Days after invoice to auto collect.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffdefaultduedate was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffDefaultDueDate 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffExtraService
Source: https://learn.nexudus.com/rest-api/billing/post-tariffextraservices

POST /api/billing/tariffextraservices
Create a new TariffExtraService record.

A **TariffExtraService** links an extra service (booking rate) to a pricing plan (tariff), defining an included allowance of booking time or printing credits for customers on that plan. The `UsesIncluded` value specifies how much is included.

## Authentication

<Note>
  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 **`TariffExtraService-Create`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Number of uses included.
</ParamField>

<ParamField type="integer">
  Service renewal time period.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ExtraServiceId": 0,
      "UsesIncluded": 0,
      "ServiceRenewalTime": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ExtraServiceId: 0,
        UsesIncluded: 0,
        ServiceRenewalTime: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tariffextraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ExtraServiceId': 0,
          'UsesIncluded': 0,
          'ServiceRenewalTime': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffextraservice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffExtraService 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ServiceRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ServiceRenewalTime"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffProduct
Source: https://learn.nexudus.com/rest-api/billing/post-tariffproducts

POST /api/billing/tariffproducts
Create a new TariffProduct record.

A **TariffProduct** links a product to a pricing plan (tariff), making the product automatically included or available as part of that plan's offering.

## Authentication

<Note>
  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 **`TariffProduct-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ProductId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ProductId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tariffproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ProductId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create Tariff
Source: https://learn.nexudus.com/rest-api/billing/post-tariffs

POST /api/billing/tariffs
Create a new Tariff record.

A **Tariff** (also called a Plan) is a membership plan that customers can sign up to in exchange for access to a coworking space and other benefits. Tariffs are the foundation for contracts — every time a customer signs up to a plan, Nexudus generates a `CoworkerContract` for that member based on the plan's settings.

Plans define billing frequency (in months or weeks via `InvoiceEvery` / `InvoiceEveryWeeks`), pricing, cancellation rules, and limits on check-ins, booking minutes, visitor passes, and hours. Members are invoiced at the end of each billing cycle. Plans can include benefits such as day passes, booking credits, and money credits — these are configured through `CoworkerExtraService` and `Product` entities linked to the contract.

Use `SystemTariffType` to categorise the plan (e.g. FullTimeHotDesk, VirtualOffice, Storage). Use `Visible` to control whether the plan appears on the members portal. Plans can optionally require identity checks before activation, enforce contract terms, support pausing, and define delivery handling preferences for virtual office mail.

When you edit a plan, changes impact all members signed up to that plan. To customise settings for an individual member, edit their `CoworkerContract` instead.

## Authentication

<Note>
  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 **`Tariff-Create`** role.
</Note>

## Enums

<Accordion title="eTariffType — SystemTariffType values">
  | Value | Name                  |
  | ----- | --------------------- |
  | 1     | FullTimePrivateOffice |
  | 2     | PartTimePrivateOffice |
  | 3     | FullTimeDedicatedDesk |
  | 4     | PartTimeDedicatedDesk |
  | 5     | FullTimeHotDesk       |
  | 6     | PartTimeHotDesk       |
  | 7     | FullTimeOther         |
  | 8     | PartTimeOther         |
  | 9     | Storage               |
  | 10    | VirtualOffice         |
  | 11    | Virtual               |
  | 99    | Other                 |
</Accordion>

<Accordion title="eTariffBookingDueDateStrategy — BookingDueDateStrategy values">
  | Value | Name                |
  | ----- | ------------------- |
  | 1     | RenewalDate         |
  | 2     | BookingEndDate      |
  | 3     | BookingCreationDate |
  | 4     | NextNthOfMonth      |
</Accordion>

<Accordion title="eIdentityCheckProvider — AddressIdentityCheckProvider values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Manual         |
  | 2     | StripeIdentity |
</Accordion>

<Accordion title="eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Never         |
  | 2     | Every3Months  |
  | 3     | Every6Months  |
  | 4     | Every12Months |
  | 5     | Every24Months |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Plan name.
</ParamField>

<ParamField type="integer">
  Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other. Defaults to `eTariffType.FullTimePrivateOffice`.
</ParamField>

<ParamField type="number">
  Recurring price charged per billing cycle.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Number of days' notice required before a contract can be cancelled.
</ParamField>

<ParamField type="integer">
  Display order on the members portal (lower numbers appear first).
</ParamField>

<ParamField type="integer">
  Billing cycle length in months. Set to 0 if billing by weeks instead.
</ParamField>

<ParamField type="integer">
  Billing cycle length in weeks. Set to 0 if billing by months instead.
</ParamField>

<ParamField type="integer">
  Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth. Defaults to `eTariffBookingDueDateStrategy.RenewalDate`.
</ParamField>

<ParamField type="integer">
  Provider used for address identity checks: Manual or StripeIdentity. Defaults to `eIdentityCheckProvider.Manual`.
</ParamField>

<ParamField type="integer">
  How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months. Defaults to `eIdentityCheckRepeatPattern.Never`.
</ParamField>

<ParamField type="integer">
  Provider used for identity checks: Manual or StripeIdentity. Defaults to `eIdentityCheckProvider.Manual`.
</ParamField>

<ParamField type="integer">
  How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months. Defaults to `eIdentityCheckRepeatPattern.Never`.
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for mail deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for parcel deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for check deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for publicity deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for other deliveries (virtual office).
</ParamField>

### Optional Fields

<ParamField type="integer">
  Day of the month on which invoices are generated for members on this plan.
</ParamField>

<ParamField type="boolean">
  Whether the plan is visible to customers on the members portal and mobile app.
</ParamField>

<ParamField type="boolean">
  Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
</ParamField>

<ParamField type="string">
  Custom notes provided to the AI assistant when describing this plan.
</ParamField>

<ParamField type="boolean">
  Whether to show the plan price to the AI assistant.
</ParamField>

<ParamField type="number">
  Custom price shown to the AI assistant instead of the actual price.
</ParamField>

<ParamField type="boolean">
  Whether this plan uses time passes for check-in access.
</ParamField>

<ParamField type="string">
  Plan description shown to customers.
</ParamField>

<ParamField type="string">
  Custom text shown on the invoice line instead of the plan name.
</ParamField>

<ParamField type="number">
  One-off fee charged when a customer first signs up to this plan.
</ParamField>

<ParamField type="integer">
  Standard tax rate applied to charges on this plan.
</ParamField>

<ParamField type="integer">
  Reduced tax rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Tax-exempt rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Financial account used for revenue tracking.
</ParamField>

<ParamField type="string">
  Terms and conditions text that members must accept when signing up.
</ParamField>

<ParamField type="string">
  URL to upload a new contract document template.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the uploaded contract document file.
</ParamField>

<ParamField type="string">
  Group name used to visually group plans together on the members portal.
</ParamField>

<ParamField type="boolean">
  Prevents members from cancelling this plan through the members portal.
</ParamField>

<ParamField type="integer">
  Maximum number of members that can be signed up to this plan at any time.
</ParamField>

<ParamField type="integer">
  Minimum number of days a contract must be active before it can be cancelled.
</ParamField>

<ParamField type="integer">
  Default minimum contract term in months for new sign-ups.
</ParamField>

<ParamField type="integer">
  Number of days after contract cancellation before the member account is deactivated.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins included per billing cycle.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per day.
</ParamField>

<ParamField type="integer">
  Maximum number of hours included per billing cycle.
</ParamField>

<ParamField type="integer">
  Maximum number of hours allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of hours allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum booking minutes allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum booking minutes allowed per month.
</ParamField>

<ParamField type="number">
  Discount percentage for extra services.
</ParamField>

<ParamField type="number">
  Discount percentage for time passes.
</ParamField>

<ParamField type="number">
  Discount percentage for charges.
</ParamField>

<ParamField type="integer">
  Number of days after which the contract is automatically cancelled if not paid.
</ParamField>

<ParamField type="integer">
  Number of billing cycles to invoice in advance.
</ParamField>

<ParamField type="integer">
  Day of the month used to align billing cycles when prorating.
</ParamField>

<ParamField type="integer">
  Number of days before the prorate day to start prorating.
</ParamField>

<ParamField type="boolean">
  Whether to prorate the final invoice when a contract is cancelled mid-cycle.
</ParamField>

<ParamField type="integer">
  Number of days to extend a contract after payment is received.
</ParamField>

<ParamField type="boolean">
  Whether to exclude this plan's charges from member invoices.
</ParamField>

<ParamField type="boolean">
  Whether to automatically generate invoices at the end of each billing cycle.
</ParamField>

<ParamField type="integer">
  Raise invoice every N months.
</ParamField>

<ParamField type="integer">
  Raise invoice every N weeks.
</ParamField>

<ParamField type="number">
  Minimum total amount charged per billing cycle regardless of usage.
</ParamField>

<ParamField type="boolean">
  Whether time pass charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether extra service charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether event charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether the plan is archived and no longer available for new sign-ups.
</ParamField>

<ParamField type="boolean">
  Whether the plan is starred (highlighted) on the members portal.
</ParamField>

<ParamField type="boolean">
  Whether new sign-ups are kept on hold until manually approved.
</ParamField>

<ParamField type="boolean">
  Whether members can pause their contract on this plan.
</ParamField>

<ParamField type="integer">
  Maximum number of times a contract can be paused per year.
</ParamField>

<ParamField type="integer">
  Maximum number of billing cycles a contract can be paused for.
</ParamField>

<ParamField type="integer">
  Day of the month used when BookingDueDateStrategy is NextNthOfMonth.
</ParamField>

<ParamField type="boolean">
  Whether this is a virtual office plan with mail handling features.
</ParamField>

<ParamField type="boolean">
  Whether to keep the contract on hold until all required identity checks are completed.
</ParamField>

<ParamField type="boolean">
  Whether to request an address identity check from members signing up to this plan.
</ParamField>

<ParamField type="string">
  Instructions shown to members when completing the address identity check.
</ParamField>

<ParamField type="boolean">
  Whether to keep the contract paused if the address identity check reveals a mismatch.
</ParamField>

<ParamField type="boolean">
  Whether to request an identity (ID document) check from members signing up to this plan.
</ParamField>

<ParamField type="string">
  Instructions shown to members when completing the identity check.
</ParamField>

<ParamField type="boolean">
  Whether to request an AML check from members signing up to this plan.
</ParamField>

<ParamField type="boolean">
  Whether to enable AML checks against the OpenSanctions dataset.
</ParamField>

<ParamField type="boolean">
  Whether to enable AML checks against the Pappers dataset.
</ParamField>

<ParamField type="string">
  Which OpenSanctions dataset to check against for AML screening (e.g. 'default').
</ParamField>

<ParamField type="number">
  Score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7.
</ParamField>

<ParamField type="boolean">
  Whether to email the onboarding form to new members signing up to this plan.
</ParamField>

<ParamField type="integer">
  ID of the onboarding form page sent to new members.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail stored for collection (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail forwarding (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail recycling (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail shredding (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail scanning (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for returning mail to sender (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for check deposits (virtual office).
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail collection (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of days deliveries are stored before being returned (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of company name aliases allowed for mail handling (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of mail recipients allowed (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of forwarding addresses allowed (virtual office).
</ParamField>

<ParamField type="boolean">
  Whether to automatically transfer mail handling products to the member's contract.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffs" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "SystemTariffType": 0,
      "Price": 0,
      "CurrencyId": 0,
      "CancellationPeriod": 0,
      "DisplayOrder": 0,
      "InvoiceEvery": 0,
      "InvoiceEveryWeeks": 0,
      "BookingDueDateStrategy": 0,
      "AddressIdentityCheckProvider": 0,
      "AddressIdentityCheckRepeatPattern": 0,
      "IdentityCheckProvider": 0,
      "IdentityCheckRepeatPattern": 0,
      "DeliveryPreferencesMail": 0,
      "DeliveryPreferencesParcels": 0,
      "DeliveryPreferencesChecks": 0,
      "DeliveryPreferencesPublicity": 0,
      "DeliveryPreferencesOther": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        SystemTariffType: 0,
        Price: 0,
        CurrencyId: 0,
        CancellationPeriod: 0,
        DisplayOrder: 0,
        InvoiceEvery: 0,
        InvoiceEveryWeeks: 0,
        BookingDueDateStrategy: 0,
        AddressIdentityCheckProvider: 0,
        AddressIdentityCheckRepeatPattern: 0,
        IdentityCheckProvider: 0,
        IdentityCheckRepeatPattern: 0,
        DeliveryPreferencesMail: 0,
        DeliveryPreferencesParcels: 0,
        DeliveryPreferencesChecks: 0,
        DeliveryPreferencesPublicity: 0,
        DeliveryPreferencesOther: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tariffs',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'SystemTariffType': 0,
          'Price': 0,
          'CurrencyId': 0,
          'CancellationPeriod': 0,
          'DisplayOrder': 0,
          'InvoiceEvery': 0,
          'InvoiceEveryWeeks': 0,
          'BookingDueDateStrategy': 0,
          'AddressIdentityCheckProvider': 0,
          'AddressIdentityCheckRepeatPattern': 0,
          'IdentityCheckProvider': 0,
          'IdentityCheckRepeatPattern': 0,
          'DeliveryPreferencesMail': 0,
          'DeliveryPreferencesParcels': 0,
          'DeliveryPreferencesChecks': 0,
          'DeliveryPreferencesPublicity': 0,
          'DeliveryPreferencesOther': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariff was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Tariff 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffSignupProduct
Source: https://learn.nexudus.com/rest-api/billing/post-tariffsignupproducts

POST /api/billing/tariffsignupproducts
Create a new TariffSignupProduct record.

A **TariffSignupProduct** links a product to a pricing plan (tariff) as a one-time sign-up charge. Products linked this way are automatically added to a customer's first invoice when they join the plan.

## Authentication

<Note>
  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 **`TariffSignupProduct-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="number">
  Signup product price override.
</ParamField>

<ParamField type="boolean">
  Whether the signup product is refundable.
</ParamField>

<ParamField type="boolean">
  Whether invoice during online checkout is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ProductId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ProductId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ProductId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffsignupproduct was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffSignupProduct 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create TariffTimePass
Source: https://learn.nexudus.com/rest-api/billing/post-tarifftimepasses

POST /api/billing/tarifftimepasses
Create a new TariffTimePass record.

A **TariffTimePass** links a time pass to a pricing plan (tariff), defining an included allowance of time passes for customers on that plan. The renewal time controls how often the allowance resets.

## Authentication

<Note>
  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 **`TariffTimePass-Create`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — PassRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  Number of passes included.
</ParamField>

<ParamField type="integer">
  Pass renewal time period.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "TimePassId": 0,
      "PassesIncluded": 0,
      "PassRenewalTime": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        TimePassId: 0,
        PassesIncluded: 0,
        PassRenewalTime: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'TimePassId': 0,
          'PassesIncluded': 0,
          'PassRenewalTime': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tarifftimepass was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffTimePass 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PassRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PassRenewalTime"
    }
  ],
  "WasSuccessful": false
}
```


# Create TimePass
Source: https://learn.nexudus.com/rest-api/billing/post-timepasses

POST /api/billing/timepasses
Create a new TimePass record.

Passes allow customers to check in to a coworking space. There are two kinds:

* **Day Pass** — valid for a single calendar day. Created with `MinutesIncluded` omitted (null). The customer can check in any number of times during that day.
* **Time Pass** — valid across multiple days up to a fixed amount of time. Created with \`\`MinutesIncluded` <minutes>` set. The customer can check in until the included minutes are exhausted.

## Authentication

<Note>
  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 **`TimePass-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Time pass name.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

### Optional Fields

<ParamField type="string">
  Invoice line display text.
</ParamField>

<ParamField type="integer">
  Minutes included.
</ParamField>

<ParamField type="boolean">
  Counts towards plan limits.
</ParamField>

<ParamField type="boolean">
  Use as pay-as-you-go for members.
</ParamField>

<ParamField type="boolean">
  Use as pay-as-you-go for contacts.
</ParamField>

<ParamField type="integer">
  Use priority.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of businesses linked to this record.
</ParamField>

<ParamField type="string">
  Kisi group ID.
</ParamField>

<ParamField type="string">
  DoorGuard group ID.
</ParamField>

<ParamField type="string">
  ID of the access control group associated with this record.
</ParamField>

<ParamField type="boolean">
  Allow network check-in.
</ParamField>

<ParamField type="boolean">
  Only available for contacts.
</ParamField>

<ParamField type="boolean">
  Only available for members.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether this time pass is archived and hidden from active lists.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/timepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "Price": 0,
      "CurrencyId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        Price: 0,
        CurrencyId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/timepasses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'Price': 0,
          'CurrencyId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepass was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePass 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Run command for TimePasses
Source: https://learn.nexudus.com/rest-api/billing/post-timepasses-run-command

POST /api/billing/timepasses/runcommand
Execute a command on one or more TimePass records.

Executes a command on one or more TimePass records. Use the [Commands endpoint](/rest-api/billing/get-timepasses-commands) to discover available commands and their required parameters.

## Authentication

<Note>
  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 **`TimePass-Update`** role.
</Note>

## Request Body

<ParamField type="string">
  The command key to execute. Obtain available keys from the [Commands endpoint](/rest-api/billing/get-timepasses-commands).
</ParamField>

<ParamField type="integer[]">
  List of TimePass record Ids to execute the command on.
</ParamField>

<ParamField type="object[]">
  If the command requires parameters, provide them as an array of objects with `Name` and `Value` fields.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/timepasses/runcommand" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Key": "COMMAND_KEY_1",
      "Ids": [87654321, 87654322],
      "Parameters": [
        {
          "Name": "Parameter name",
          "Value": "Parameter value"
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses/runcommand',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Key: 'COMMAND_KEY_1',
        Ids: [87654321, 87654322],
        Parameters: [
          {
            Name: 'Parameter name',
            Value: 'Parameter value'
          }
        ]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/timepasses/runcommand',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Key': 'COMMAND_KEY_1',
          'Ids': [87654321, 87654322],
          'Parameters': [
              {
                  'Name': 'Parameter name',
                  'Value': 'Parameter value'
              }
          ]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the command was executed.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains details about the command execution result.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the command was executed successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```


# Create TimePassPrice
Source: https://learn.nexudus.com/rest-api/billing/post-timepassprices

POST /api/billing/timepassprices
Create a new TimePassPrice record.

A **TimePassPrice** defines a pricing tier for a time pass, allowing different prices based on quantity purchased or customer segment.

## Authentication

<Note>
  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 **`TimePassPrice-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/timepassprices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TimePassId": 0,
      "TariffId": 0,
      "Price": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TimePassId: 0,
        TariffId: 0,
        Price: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepassprice was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassPrice 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Price: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Price"
    }
  ],
  "WasSuccessful": false
}
```


# Create TimePassTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/post-timepasstimeslots

POST /api/billing/timepasstimeslots
Create a new TimePassTimeSlot record.

A **TimePassTimeSlot** defines the days and times during which a time pass can be used. Each time slot specifies a day of the week and a from/to time window that restricts when the pass is valid.

## Authentication

<Note>
  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 **`TimePassTimeSlot-Create`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Start time.
</ParamField>

<ParamField type="string">
  End time.
</ParamField>

<ParamField type="integer">
  The day of week value for this time pass time slot.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TimePassId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TimePassId: 0,
        FromTime: '2025-01-15T10:30:00Z',
        ToTime: '2025-01-15T10:30:00Z',
        DayOfWeek: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TimePassId': 0,
          'FromTime': '2025-01-15T10:30:00Z',
          'ToTime': '2025-01-15T10:30:00Z',
          'DayOfWeek': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepasstimeslot was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassTimeSlot 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}
```


# Update BasketSession
Source: https://learn.nexudus.com/rest-api/billing/put-basketsessions

PUT /api/billing/basketsessions
Update an existing BasketSession record.

Updates an existing BasketSession record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`BasketSession-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the BasketSession record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Unique session identifier linking the basket to the customer's browser session.
</ParamField>

### Optional Fields

<ParamField type="string">
  JSON-serialised basket contents including selected products, quantities, and pricing.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/basketsessions" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "SessionId": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/basketsessions',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        SessionId: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/basketsessions',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'SessionId': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the basketsession was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BasketSession was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "SessionId: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "SessionId"
    }
  ],
  "WasSuccessful": false
}
```


# Update BusinessCharge
Source: https://learn.nexudus.com/rest-api/billing/put-businesscharges

PUT /api/billing/businesscharges
Update an existing BusinessCharge record.

Updates an existing BusinessCharge record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`BusinessCharge-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the BusinessCharge record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Human-readable description of what this charge is for.
</ParamField>

<ParamField type="string">
  URL that Nexudus will call back once the charge is processed or its status changes.
</ParamField>

<ParamField type="number">
  Percentage discount to apply to the charge amount (0–100).
</ParamField>

<ParamField type="number">
  Total amount of the charge before tax.
</ParamField>

<ParamField type="number">
  Tax amount applied to this charge.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the application linked to this record.
</ParamField>

<ParamField type="string">
  Date by which the charge must be paid.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/businesscharges" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Description": "",
      "CallBackUrl": "",
      "PercentageDiscount": 0,
      "TotalAmount": 0,
      "TaxAmount": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/businesscharges',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Description: '',
        CallBackUrl: '',
        PercentageDiscount: 0,
        TotalAmount: 0,
        TaxAmount: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/businesscharges',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Description': '',
          'CallBackUrl': '',
          'PercentageDiscount': 0,
          'TotalAmount': 0,
          'TaxAmount': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the businesscharge was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BusinessCharge was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```


# Update Charge
Source: https://learn.nexudus.com/rest-api/billing/put-charges

PUT /api/billing/charges
Update an existing Charge record.

Updates an existing Charge record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Charge-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Charge record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="number">
  Discount amount.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Total amount.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this charge.
</ParamField>

<ParamField type="string">
  Display text on invoice line.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="string">
  Due date.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="boolean">
  Whether the charge has been invoiced.
</ParamField>

<ParamField type="string">
  Sale date.
</ParamField>

<ParamField type="boolean">
  Whether from team member is enabled.
</ParamField>

<ParamField type="string">
  The coworker extra service name value for this charge.
</ParamField>

<ParamField type="string">
  The coworker time pass name value for this charge.
</ParamField>

<ParamField type="string">
  The coworker product name value for this charge.
</ParamField>

<ParamField type="string">
  The tariff name value for this charge.
</ParamField>

<ParamField type="string">
  ID of the coworker product unique associated with this record.
</ParamField>

<ParamField type="string">
  ID of the booking unique associated with this record.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/charges" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "Quantity": 0,
      "DiscountAmount": 0,
      "CreditAmount": 0,
      "TotalAmount": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        Quantity: 0,
        DiscountAmount: 0,
        CreditAmount: 0,
        TotalAmount: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/charges',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'Quantity': 0,
          'DiscountAmount': 0,
          'CreditAmount': 0,
          'TotalAmount': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the charge was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Charge was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "DiscountAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DiscountAmount"
    }
  ],
  "WasSuccessful": false
}
```


# Update ContractContact
Source: https://learn.nexudus.com/rest-api/billing/put-contractcontacts

PUT /api/billing/contractcontacts
Update an existing ContractContact record.

Updates an existing ContractContact record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ContractContact-Edit`** role.
</Note>

## Enums

<Accordion title="eContractContactType — ContractContactType values">
  | Value | Name               |
  | ----- | ------------------ |
  | 0     | None               |
  | 1     | Director           |
  | 2     | CompanyAlias       |
  | 3     | NominatedRecipient |
</Accordion>

<Accordion title="eAmlCheckStatus — AmlCheckStatus values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | NotStarted      |
  | 1     | Pending         |
  | 2     | Clear           |
  | 3     | PotentialMatch  |
  | 4     | ConfirmedMatch  |
  | 5     | Error           |
  | 6     | ManuallyCleared |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ContractContact record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="string">
  Full name of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="integer">
  Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company).
</ParamField>

<ParamField type="integer">
  The AML check status for this contact.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Email address of the contact. Used when the contact is not linked to a coworker record.
</ParamField>

<ParamField type="string">
  Date of birth. Used for identity verification purposes.
</ParamField>

<ParamField type="string">
  Street address.
</ParamField>

<ParamField type="string">
  Post code.
</ParamField>

<ParamField type="string">
  City name.
</ParamField>

<ParamField type="string">
  State or province.
</ParamField>

<ParamField type="integer">
  ID of the country linked to this record.
</ParamField>

<ParamField type="string">
  Phone number.
</ParamField>

<ParamField type="string">
  Optional notes or comments about this contract contact.
</ParamField>

<ParamField type="string">
  The date when the AML check was performed.
</ParamField>

<ParamField type="number">
  The score from the open sanctions check.
</ParamField>

<ParamField type="string">
  The response from the open sanctions check as JSON string.
</ParamField>

<ParamField type="string">
  The response from the Pappers AML check as TEXT string.
</ParamField>

<ParamField type="string">
  The status from the Pappers AML check.
</ParamField>

<ParamField type="string">
  Notes related to the AML check. Customers cannot see this field, it's for internal use only.
</ParamField>

<ParamField type="string">
  The user who cleared the AML check.
</ParamField>

<ParamField type="string">
  The date when the AML check was cleared.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/contractcontacts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "FullName": "",
      "ContractContactType": 0,
      "AmlCheckStatus": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractcontacts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        FullName: '',
        ContractContactType: 0,
        AmlCheckStatus: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/contractcontacts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'FullName': '',
          'ContractContactType': 0,
          'AmlCheckStatus': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractcontact was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractContact was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FullName: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FullName"
    }
  ],
  "WasSuccessful": false
}
```


# Update ContractDeposit
Source: https://learn.nexudus.com/rest-api/billing/put-contractdeposits

PUT /api/billing/contractdeposits
Update an existing ContractDeposit record.

Updates an existing ContractDeposit record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ContractDeposit-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ContractDeposit record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or internal comments about this deposit.
</ParamField>

<ParamField type="number">
  Deposit amount to charge. When set, overrides the default price of the linked product.
</ParamField>

<ParamField type="boolean">
  When true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ParamField>

<ParamField type="boolean">
  Whether invoice during online checkout is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/contractdeposits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ProductId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ProductId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ProductId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractdeposit was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractDeposit was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ContractPausedPeriod
Source: https://learn.nexudus.com/rest-api/billing/put-contractpausedperiods

PUT /api/billing/contractpausedperiods
Update an existing ContractPausedPeriod record.

Updates an existing ContractPausedPeriod record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ContractPausedPeriod-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ContractPausedPeriod record to update.
</ParamField>

<ParamField type="integer">
  ID of the customer contract being frozen.
</ParamField>

<ParamField type="string">
  UTC date when the freeze starts. Always falls on the first day of a billing cycle.
</ParamField>

<ParamField type="string">
  UTC date when the freeze ends. Always falls on the first day of the billing cycle when the plan is due to restart.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or reason for this freeze period.
</ParamField>

<ParamField type="string">
  Location-timezone equivalent of PauseFrom.
</ParamField>

<ParamField type="string">
  Location-timezone equivalent of PauseUntil.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/contractpausedperiods" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "PauseFrom": "2025-01-15T10:30:00Z",
      "PauseUntil": "2025-01-15T10:30:00Z",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractpausedperiods',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        PauseFrom: '2025-01-15T10:30:00Z',
        PauseUntil: '2025-01-15T10:30:00Z',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/contractpausedperiods',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'PauseFrom': '2025-01-15T10:30:00Z',
          'PauseUntil': '2025-01-15T10:30:00Z',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractpausedperiod was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractPausedPeriod was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PauseFrom: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PauseFrom"
    }
  ],
  "WasSuccessful": false
}
```


# Update ContractProduct
Source: https://learn.nexudus.com/rest-api/billing/put-contractproducts

PUT /api/billing/contractproducts
Update an existing ContractProduct record.

Updates an existing ContractProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ContractProduct-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ContractProduct record to update.
</ParamField>

<ParamField type="integer">
  Contract to add this product to.
</ParamField>

<ParamField type="integer">
  Product to bill on each contract invoice.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this contract product.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/contractproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ProductId": 0,
      "Quantity": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ProductId: 0,
        Quantity: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/contractproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ProductId': 0,
          'Quantity': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/put-contractschedules

PUT /api/billing/contractschedules
Update an existing ContractSchedule record.

Updates an existing ContractSchedule record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ContractSchedule-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ContractSchedule record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker contract linked to this record.
</ParamField>

<ParamField type="string">
  Date on which the system will automatically update the contract price to the value in Price.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or internal comments about this scheduled price change.
</ParamField>

<ParamField type="number">
  The new contract price to apply on the scheduled date.
</ParamField>

<ParamField type="string">
  Date/time value for apply on local.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/contractschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerContractId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractschedules',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerContractId: 0,
        ApplyOn: '2025-01-15T10:30:00Z',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/contractschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerContractId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the contractschedule was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ContractSchedule was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerbookingcredits

PUT /api/billing/coworkerbookingcredits
Update an existing CoworkerBookingCredit record.

Updates an existing CoworkerBookingCredit record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerBookingCredit-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerBookingCredit record to update.
</ParamField>

<ParamField type="integer">
  ID of the customer this credit is assigned to.
</ParamField>

<ParamField type="integer">
  ID of the location issuing the credit.
</ParamField>

<ParamField type="number">
  Total credit amount originally assigned.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional description or label for this credit.
</ParamField>

<ParamField type="integer[]">
  Resource types this credit can be used for. If empty, the credit is valid for all resource types.
</ParamField>

<ParamField type="integer[]">
  Resource type IDs to add to ElegibleResourceTypes.
</ParamField>

<ParamField type="integer[]">
  Resource type IDs to remove from ElegibleResourceTypes.
</ParamField>

<ParamField type="integer[]">
  Products this credit can be used for. If empty, applies to all products.
</ParamField>

<ParamField type="integer[]">
  Product IDs to add to ElegibleProducts.
</ParamField>

<ParamField type="integer[]">
  Product IDs to remove from ElegibleProducts.
</ParamField>

<ParamField type="integer[]">
  Plans (tariffs) this credit is restricted to. If empty, applies to customers on any plan.
</ParamField>

<ParamField type="integer[]">
  Plan IDs to add to ElegibleTariffs.
</ParamField>

<ParamField type="integer[]">
  Plan IDs to remove from ElegibleTariffs.
</ParamField>

<ParamField type="string">
  Date from which this credit is valid.
</ParamField>

<ParamField type="string">
  Date on which this credit expires.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  Event categories this credit can be used for. If empty, applies to all event categories.
</ParamField>

<ParamField type="integer[]">
  Event category IDs to add to EventCategories.
</ParamField>

<ParamField type="integer[]">
  Event category IDs to remove from EventCategories.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="boolean">
  Whether to use the credit price instead of the standard booking price when this credit is applied.
</ParamField>

<ParamField type="string">
  Unique ID of the contract that originated this credit.
</ParamField>

<ParamField type="integer[]">
  Time passes this credit can be used for. If empty, applies to all passes.
</ParamField>

<ParamField type="integer[]">
  Pass IDs to add to ElegiblePasses.
</ParamField>

<ParamField type="integer[]">
  Pass IDs to remove from ElegiblePasses.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "TotalCredit": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        TotalCredit: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcredits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'TotalCredit': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerbookingcredit was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerBookingCredit was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RemainingCredit: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RemainingCredit"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerBookingCreditUseHistory
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerbookingcreditusehistories

PUT /api/billing/coworkerbookingcreditusehistories
Update an existing CoworkerBookingCreditUseHistory record.

Updates an existing CoworkerBookingCreditUseHistory record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerBookingCreditUseHistory-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerBookingCreditUseHistory record to update.
</ParamField>

<ParamField type="integer">
  ID of the booking credit that was consumed.
</ParamField>

<ParamField type="number">
  Amount of credit consumed by this entry.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional description or note for this credit use entry.
</ParamField>

<ParamField type="integer">
  ID of the booking this credit was applied to, if the credit was used for a booking.
</ParamField>

<ParamField type="integer">
  ID of the invoice line this credit was applied to, if the credit was used against an invoice.
</ParamField>

<ParamField type="integer">
  ID of the event attendance record this credit was applied to, if the credit was used for an event.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerBookingCreditId": 0,
      "CreditUsed": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerBookingCreditId: 0,
        CreditUsed: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerBookingCreditId': 0,
          'CreditUsed': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerbookingcreditusehistory was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerBookingCreditUseHistory was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "CreditUsed: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CreditUsed"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerContract
Source: https://learn.nexudus.com/rest-api/billing/put-coworkercontracts

PUT /api/billing/coworkercontracts
Update an existing CoworkerContract record.

Updates an existing CoworkerContract record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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-Edit`** role.
</Note>

## Enums

<Accordion title="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                    |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerContract record to update.
</ParamField>

<ParamField type="integer">
  ID of the issued by linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Day of month on which billing occurs.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the next tariff linked to this record.
</ParamField>

<ParamField type="string">
  Free-text notes for this contract.
</ParamField>

<ParamField type="string">
  Contract start date.
</ParamField>

<ParamField type="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.
</ParamField>

<ParamField type="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.
</ParamField>

<ParamField type="string">
  Minimum contract length end date. Defines the earliest date at which the contract can be cancelled without penalty.
</ParamField>

<ParamField type="number">
  Fixed price override for this contract. If null, the contract uses the plan's default price (TariffPrice).
</ParamField>

<ParamField type="number">
  Contract value used in reporting to compare against the actual invoiced price.
</ParamField>

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added desks value for this coworker contract.
</ParamField>

<ParamField type="integer[]">
  The removed desks value for this coworker contract.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added variants value for this coworker contract.
</ParamField>

<ParamField type="integer[]">
  The removed variants value for this coworker contract.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Whether to include the plan's signup fee when creating this contract.
</ParamField>

<ParamField type="boolean">
  Whether to invoice multiple billing cycles in advance on the first invoice, as configured by Tariff.AdvanceInvoiceCycles.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the first invoice based on the contract start date relative to the billing cycle.
</ParamField>

<ParamField type="string">
  Date of the next automatic invoice generation for this contract.
</ParamField>

<ParamField type="boolean">
  Whether the customer has accepted the plan's terms and conditions.
</ParamField>

<ParamField type="string">
  Date on which the contract will be cancelled. Nexudus stops invoicing when InvoicedPeriod reaches this date.
</ParamField>

<ParamField type="integer">
  Minimum number of days' notice required before cancellation takes effect.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the final invoice when the contract is cancelled mid-cycle.
</ParamField>

<ParamField type="boolean">
  Whether to cascade cancellation to contracts of team members under this customer.
</ParamField>

<ParamField type="integer">
  Reason for cancellation. See `eCancellationReason?` enum above.
</ParamField>

<ParamField type="string">
  Free-text notes about the cancellation.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for checks. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for mail. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for parcels. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="integer">
  Delivery handling preference for publicity. See `eDeliveryHandlingPreference?` enum above.
</ParamField>

<ParamField type="string">
  Free-text delivery instructions for this contract's mail handling.
</ParamField>

<ParamField type="string">
  Date by which identity verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Date by which address verification checks must be completed for this contract.
</ParamField>

<ParamField type="string">
  Date/time value for start date local.
</ParamField>

<ParamField type="string">
  Date/time value for renewal date local.
</ParamField>

<ParamField type="string">
  Date/time value for next auto invoice local.
</ParamField>

<ParamField type="string">
  Date/time value for price plan terms accepted on local.
</ParamField>

<ParamField type="string">
  Date/time value for cancellation date local.
</ParamField>

<ParamField type="string">
  Date/time value for contract term local.
</ParamField>

<ParamField type="string">
  Date/time value for invoiced period local.
</ParamField>

<ParamField type="string">
  PO box number.
</ParamField>

### Children

<ParamField type="object[]">
  Scheduled future price changes for this contract. Each entry sets a new Price to apply on a given date

  <Expandable>
    <ParamField type="number">
      The new contract price to apply on the scheduled date.
    </ParamField>

    <ParamField type="string">
      Date on which the system will automatically update the contract price to the value in Price.
    </ParamField>
  </Expandable>
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkercontracts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "IssuedById": 0,
      "CoworkerId": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0,
      "Id": 87654321,
      "ContractSchedules": [
          {
              "Price": null,
              "ApplyOn": "2025-01-15T10:30:00Z"
          }
      ]
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkercontracts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        IssuedById: 0,
        CoworkerId: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0,
        Id: 87654321,
        ContractSchedules: [object Object]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkercontracts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'IssuedById': 0,
          'CoworkerId': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0,
          'Id': 87654321,
          'ContractSchedules': [object Object]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkercontract was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerContract was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PriceWithProductsAndDeposits: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PriceWithProductsAndDeposits"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerDiscountCode
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerdiscountcodes

PUT /api/billing/coworkerdiscountcodes
Update an existing CoworkerDiscountCode record.

Updates an existing CoworkerDiscountCode record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerDiscountCode-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerDiscountCode record to update.
</ParamField>

<ParamField type="integer">
  ID of the customer this discount code is assigned to.
</ParamField>

<ParamField type="integer">
  ID of the location this assignment belongs to.
</ParamField>

<ParamField type="integer">
  ID of the discount code assigned to this customer.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes about this discount code assignment.
</ParamField>

<ParamField type="string">
  Customer-specific date from which this discount code assignment becomes valid.
</ParamField>

<ParamField type="string">
  Customer-specific date after which this discount code assignment expires.
</ParamField>

<ParamField type="string">
  Unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
</ParamField>

<ParamField type="string">
  Unique identifier of the booking to which this discount code was applied.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerdiscountcodes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "DiscountCodeId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        DiscountCodeId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerdiscountcodes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'DiscountCodeId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerdiscountcode was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerDiscountCode was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerExtraService
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerextraservices

PUT /api/billing/coworkerextraservices
Update an existing CoworkerExtraService record.

Updates an existing CoworkerExtraService record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerExtraService-Edit`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerExtraService record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.
</ParamField>

<ParamField type="integer">
  Unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).
</ParamField>

### Optional Fields

<ParamField type="string">
  Internal notes.
</ParamField>

<ParamField type="boolean">
  Whether this charge or credit is free (no cost to the customer).
</ParamField>

<ParamField type="number">
  Price charged for this extra service.
</ParamField>

<ParamField type="string">
  Date from which this credit becomes usable.
</ParamField>

<ParamField type="string">
  Date when this credit expires and can no longer be used.
</ParamField>

<ParamField type="string">
  Payment due date for the charge.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Invoice the customer directly instead of the team or company paying member.
</ParamField>

<ParamField type="integer">
  ID of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Start time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  End time of the booking that generated this charge.
</ParamField>

<ParamField type="string">
  Name of the resource booked (e.g., meeting room name).
</ParamField>

<ParamField type="string">
  Links this credit back to the customer contract that provisioned it.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "ExtraServiceId": 0,
      "TotalUses": 0,
      "ChargePeriod": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        ExtraServiceId: 0,
        TotalUses: 0,
        ChargePeriod: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerextraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'ExtraServiceId': 0,
          'TotalUses': 0,
          'ChargePeriod': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerextraservice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraService was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ChargePeriod: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ChargePeriod"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerExtraServiceUseHistory
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerextraserviceusehistories

PUT /api/billing/coworkerextraserviceusehistories
Update an existing CoworkerExtraServiceUseHistory record.

Updates an existing CoworkerExtraServiceUseHistory record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerExtraServiceUseHistory-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerExtraServiceUseHistory record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker extra service linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the booking linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerExtraServiceId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerExtraServiceId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerExtraServiceId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerextraserviceusehistory was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerExtraServiceUseHistory was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerInvoiceHistory
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerinvoicehistories

PUT /api/billing/coworkerinvoicehistories
Update an existing CoworkerInvoiceHistory record.

Updates an existing CoworkerInvoiceHistory record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerInvoiceHistory-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerInvoiceHistory record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

<ParamField type="string">
  Short title of the history entry (e.g. 'Invoice sent', 'Payment received').
</ParamField>

<ParamField type="string">
  Detailed description of the activity or event recorded by this history entry.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).
</ParamField>

<ParamField type="boolean">
  Whether to send a notification when this history entry is created.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0,
      "Name": "",
      "Description": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerInvoiceId: 0,
        Name: '',
        Description: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerInvoiceId': 0,
          'Name': '',
          'Description': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoicehistory was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoiceHistory was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerInvoiceLine
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerinvoicelines

PUT /api/billing/coworkerinvoicelines
Update an existing CoworkerInvoiceLine record.

Updates an existing CoworkerInvoiceLine record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerInvoiceLine-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerInvoiceLine record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

<ParamField type="string">
  Line item description shown internally.
</ParamField>

<ParamField type="integer">
  Number of units for this line item.
</ParamField>

<ParamField type="number">
  Line subtotal before tax (unit price x quantity).
</ParamField>

<ParamField type="number">
  Tax amount calculated for this line.
</ParamField>

<ParamField type="number">
  Tax rate percentage applied to this line.
</ParamField>

<ParamField type="number">
  Credit amount applied to this line.
</ParamField>

### Optional Fields

<ParamField type="string">
  Override text displayed on the printed/emailed invoice instead of the description.
</ParamField>

<ParamField type="string">
  Name of the tax category applied to this line.
</ParamField>

<ParamField type="string">
  Code of the financial account (revenue category) for this line.
</ParamField>

<ParamField type="string">
  Name of the financial account (revenue category) for this line.
</ParamField>

<ParamField type="string">
  ID of the issued by unique associated with this record.
</ParamField>

<ParamField type="string">
  ID of the cancelled coworker invoice line unique associated with this record.
</ParamField>

<ParamField type="string">
  Date/time value for created on local.
</ParamField>

<ParamField type="string">
  Date/time value for refunded on local.
</ParamField>

<ParamField type="string">
  Date/time value for sale date local.
</ParamField>

<ParamField type="string">
  Purchase order reference for this line.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0,
      "Description": "",
      "Quantity": 0,
      "SubTotal": 0,
      "TaxAmount": 0,
      "TaxRate": 0,
      "CreditAmount": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerInvoiceId: 0,
        Description: '',
        Quantity: 0,
        SubTotal: 0,
        TaxAmount: 0,
        TaxRate: 0,
        CreditAmount: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerInvoiceId': 0,
          'Description': '',
          'Quantity': 0,
          'SubTotal': 0,
          'TaxAmount': 0,
          'TaxRate': 0,
          'CreditAmount': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoiceline was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoiceLine was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerInvoicePaymentToken
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerinvoicepaymenttokens

PUT /api/billing/coworkerinvoicepaymenttokens
Update an existing CoworkerInvoicePaymentToken record.

Updates an existing CoworkerInvoicePaymentToken record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerInvoicePaymentToken-Edit`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerInvoicePaymentToken record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer">
  Payment provider used to process the invoice. See `eRegularPaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Provider-specific token used to authorise or capture the payment.
</ParamField>

<ParamField type="string">
  Additional notes about the payment token.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerInvoiceId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerInvoiceId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicepaymenttokens',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerInvoiceId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoicepaymenttoken was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoicePaymentToken was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerInvoice
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerinvoices

PUT /api/billing/coworkerinvoices
Update an existing CoworkerInvoice record.

Updates an existing CoworkerInvoice record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerInvoice-Edit`** role.
</Note>

## Enums

<Accordion title="eStorecoveInvoiceStatus — StorecoveInvoiceStatus values">
  | Value | Name             |
  | ----- | ---------------- |
  | 1     | None             |
  | 2     | TransferFailed   |
  | 3     | Processing       |
  | 4     | ProcessingFailed |
  | 5     | Processed        |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerInvoice record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Unique invoice number assigned when the invoice is finalised.
</ParamField>

<ParamField type="string">
  Name of the person or company being billed.
</ParamField>

<ParamField type="string">
  Billing address on the invoice.
</ParamField>

<ParamField type="string">
  Billing city on the invoice.
</ParamField>

<ParamField type="string">
  Billing post code on the invoice.
</ParamField>

<ParamField type="integer">
  ID of the bill to country linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Status of e-invoicing transfer via Storecove.
</ParamField>

### Optional Fields

<ParamField type="string">
  Reference code used to match payments to this invoice.
</ParamField>

<ParamField type="string">
  Billing phone number on the invoice.
</ParamField>

<ParamField type="string">
  Billing fax number on the invoice.
</ParamField>

<ParamField type="string">
  Billing state or region on the invoice.
</ParamField>

<ParamField type="string">
  Bank account number on the invoice for payment.
</ParamField>

<ParamField type="string">
  Tax identification number of the billed party.
</ParamField>

<ParamField type="string">
  Customer purchase order number for this invoice.
</ParamField>

<ParamField type="string">
  Date by which payment is due.
</ParamField>

<ParamField type="string">
  Start date of the billing period covered by this invoice.
</ParamField>

<ParamField type="string">
  End date of the billing period covered by this invoice.
</ParamField>

<ParamField type="number">
  The transaction total amount value for this coworker invoice.
</ParamField>

<ParamField type="integer">
  ID of the transaction currency linked to this record.
</ParamField>

<ParamField type="number">
  The transaction exchange rate value for this coworker invoice.
</ParamField>

<ParamField type="boolean">
  Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
</ParamField>

<ParamField type="string">
  Date the invoice was marked as fully paid.
</ParamField>

<ParamField type="boolean">
  Whether billed is enabled.
</ParamField>

<ParamField type="boolean">
  Whether to skip automatic application of available credit to this invoice.
</ParamField>

<ParamField type="string">
  Date/time value for created on local.
</ParamField>

<ParamField type="string">
  Date/time value for due date local.
</ParamField>

<ParamField type="string">
  Date/time value for invoice from date local.
</ParamField>

<ParamField type="string">
  Date/time value for invoice to date local.
</ParamField>

<ParamField type="string">
  Date/time value for paid on local.
</ParamField>

<ParamField type="string">
  Date/time value for refunded on local.
</ParamField>

<ParamField type="string">
  Date/time value for last payment attempt local.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerinvoices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "InvoiceNumber": "",
      "BillToName": "",
      "BillToAddress": "",
      "BillToCity": "",
      "BillToPostCode": "",
      "BillToCountryId": 0,
      "CurrencyId": 0,
      "StorecoveInvoiceStatus": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        InvoiceNumber: '',
        BillToName: '',
        BillToAddress: '',
        BillToCity: '',
        BillToPostCode: '',
        BillToCountryId: 0,
        CurrencyId: 0,
        StorecoveInvoiceStatus: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerinvoices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'InvoiceNumber': '',
          'BillToName': '',
          'BillToAddress': '',
          'BillToCity': '',
          'BillToPostCode': '',
          'BillToCountryId': 0,
          'CurrencyId': 0,
          'StorecoveInvoiceStatus': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerinvoice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerInvoice was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "InvoiceNumber: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "InvoiceNumber"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerLedgerEntry
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerledgerentries

PUT /api/billing/coworkerledgerentries
Update an existing CoworkerLedgerEntry record.

Updates an existing CoworkerLedgerEntry record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerLedgerEntry-Edit`** role.
</Note>

## Enums

<Accordion title="ePaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | PayPalStandard             |
  | 2     | PaypalStandardSubscription |
  | 3     | GoCardless                 |
  | 4     | Stripe                     |
  | 5     | AuthorizeNetDirect         |
  | 6     | UsaEPay                    |
  | 7     | AuthorizeNetSubscription   |
  | 8     | Adyen                      |
  | 9     | MultiGateway               |
  | 11    | Manual                     |
  | 12    | Forte                      |
  | 13    | PayPalAdaptive             |
  | 14    | GoCardlessPro              |
  | 15    | CreditCard                 |
  | 16    | EPay                       |
  | 17    | Braintree                  |
  | 18    | MidTrans                   |
  | 19    | EziDebit                   |
  | 20    | LiqPay                     |
  | 21    | RazorPay                   |
  | 22    | SquareCash                 |
  | 23    | SquareCreditCard           |
  | 24    | StripeACH                  |
  | 25    | StripeDirectDebit          |
  | 26    | IZettleCreditCard          |
  | 27    | PeachPayments              |
  | 28    | Klarna                     |
  | 29    | StripeTerminal             |
  | 30    | PayPalStandardRest         |
  | 401   | HostedPaymentPage1         |
  | 402   | HostedPaymentPage2         |
  | 403   | HostedPaymentPage3         |
  | 500   | Xero                       |
  | 501   | Quickbooks                 |
  | 989   | ManualDirectDebit          |
  | 990   | BadDebt                    |
  | 991   | CreditCardManual1          |
  | 992   | CreditCardManual2          |
  | 993   | CreditCardManual3          |
  | 994   | Credit                     |
  | 995   | Gift                       |
  | 996   | Bank                       |
  | 997   | Cash                       |
  | 998   | Check                      |
  | 999   | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerLedgerEntry record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Free-text description of this coworker ledger entry.
</ParamField>

<ParamField type="string">
  Ledger entry code.
</ParamField>

<ParamField type="number">
  Debit amount.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Account balance after this transaction. Read-only.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the coworker invoice linked to this record.
</ParamField>

<ParamField type="integer">
  Payment gateway name. See `ePaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Payment method number.
</ParamField>

<ParamField type="string">
  Transaction date.
</ParamField>

<ParamField type="boolean">
  Whether this entry has been billed.
</ParamField>

<ParamField type="string">
  Transaction date in the location's local time.
</ParamField>

<ParamField type="string">
  Connected transaction GUID.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "CoworkerId": 0,
      "Description": "",
      "Code": "",
      "Debit": 0,
      "Credit": 0,
      "Balance": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        CoworkerId: 0,
        Description: '',
        Code: '',
        Debit: 0,
        Credit: 0,
        Balance: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'CoworkerId': 0,
          'Description': '',
          'Code': '',
          'Debit': 0,
          'Credit': 0,
          'Balance': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerledgerentry was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerLedgerEntry was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerPaymentMethod
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerpaymentmethods

PUT /api/billing/coworkerpaymentmethods
Update an existing CoworkerPaymentMethod record.

Updates an existing CoworkerPaymentMethod record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerPaymentMethod-Edit`** role.
</Note>

## Enums

<Accordion title="eRegularPaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | MultiGateway               |
  | 2     | Stripe                     |
  | 3     | Forte                      |
  | 4     | AuthorizeNetSubscription   |
  | 5     | PaypalStandardSubscription |
  | 6     | PayPalAdaptive             |
  | 7     | EPay                       |
  | 8     | Braintree                  |
  | 9     | EziDebit                   |
  | 10    | LiqPay                     |
  | 11    | StripeACH                  |
  | 12    | GoCardless                 |
  | 13    | StripeBACS                 |
  | 94    | CreditNote                 |
  | 95    | GiftCard                   |
  | 96    | BankTransfer               |
  | 97    | Cash                       |
  | 98    | Check                      |
  | 99    | Other                      |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerPaymentMethod record to update.
</ParamField>

<ParamField type="integer">
  Customer this payment method belongs to.
</ParamField>

<ParamField type="integer">
  Location that issued or will charge invoices using this payment method.
</ParamField>

### Optional Fields

<ParamField type="integer">
  Payment provider for this method. For this entity, valid values are Stripe (2), StripeACH (11), StripeBACS (13), and GoCardless (12).. See `eRegularPaymentProvider?` enum above.
</ParamField>

<ParamField type="string">
  Provider payment method ID (e.g. Stripe payment method ID).
</ParamField>

<ParamField type="string">
  Provider customer ID (e.g. Stripe or GoCardless customer ID).
</ParamField>

<ParamField type="string">
  GoCardless mandate ID. Only populated for GoCardless payment methods..
</ParamField>

<ParamField type="string">
  Masked card number for display purposes only.
</ParamField>

<ParamField type="string">
  Optional notes about this payment method.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerpaymentmethods" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerpaymentmethods',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerpaymentmethod was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerPaymentMethod was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerProduct
Source: https://learn.nexudus.com/rest-api/billing/put-coworkerproducts

PUT /api/billing/coworkerproducts
Update an existing CoworkerProduct record.

Updates an existing CoworkerProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CoworkerProduct-Edit`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerProduct record to update.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="integer">
  Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="number">
  Discount amount.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this coworker product.
</ParamField>

<ParamField type="string">
  Purchase order.
</ParamField>

<ParamField type="boolean">
  Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
</ParamField>

<ParamField type="boolean">
  Invoice this customer for this product instead of the paying member of their team.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="integer">
  Number of repeat units.
</ParamField>

<ParamField type="string">
  Invoice on date.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="string">
  Sale date.
</ParamField>

<ParamField type="string">
  Due date.
</ParamField>

<ParamField type="boolean">
  Whether it has been invoiced.
</ParamField>

<ParamField type="boolean">
  Whether mrm reminded is enabled.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating.
</ParamField>

<ParamField type="string">
  ID of the proposal unique associated with this record.
</ParamField>

<ParamField type="integer">
  Coworker invoice ID.
</ParamField>

<ParamField type="string">
  Coworker invoice number.
</ParamField>

<ParamField type="boolean">
  Whether coworker invoice is paid.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CoworkerId": 0,
      "BusinessId": 0,
      "ProductId": 0,
      "Quantity": 0,
      "RepeatCycle": 0,
      "CreditAmount": 0,
      "DiscountAmount": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        ProductId: 0,
        Quantity: 0,
        RepeatCycle: 0,
        CreditAmount: 0,
        DiscountAmount: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'ProductId': 0,
          'Quantity': 0,
          'RepeatCycle': 0,
          'CreditAmount': 0,
          'DiscountAmount': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkerproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}
```


# Update CoworkerTimePass
Source: https://learn.nexudus.com/rest-api/billing/put-coworkertimepasses

PUT /api/billing/coworkertimepasses
Update an existing CoworkerTimePass record.

Updates an existing CoworkerTimePass record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CoworkerTimePass record to update.
</ParamField>

<ParamField type="integer">
  The customer who owns this time pass.
</ParamField>

<ParamField type="integer">
  The business (location) this time pass belongs to.
</ParamField>

<ParamField type="integer">
  The time pass definition this is an instance of.
</ParamField>

<ParamField type="integer">
  Number of time passes to create at once.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes for this time pass.
</ParamField>

<ParamField type="string">
  Purchase order reference.
</ParamField>

<ParamField type="boolean">
  Whether this time pass has been used.
</ParamField>

<ParamField type="boolean">
  Whether this time pass is free of charge.
</ParamField>

<ParamField type="number">
  Custom price for this time pass.
</ParamField>

<ParamField type="string">
  Expiration date for this time pass.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a tariff time pass allocation.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a customer product purchase.
</ParamField>

<ParamField type="string">
  Unique identifier linking this time pass to a customer contract.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "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,
      "Id": 87654321
  }'
  ```

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

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      '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,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the coworkertimepass was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerTimePass was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update DiscountCode
Source: https://learn.nexudus.com/rest-api/billing/put-discountcodes

PUT /api/billing/discountcodes
Update an existing DiscountCode record.

Updates an existing DiscountCode record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`DiscountCode-Edit`** role.
</Note>

## Enums

<Accordion title="eDiscountExpirePeriod">
  | Value | Name  |
  | ----- | ----- |
  | 1     | Day   |
  | 2     | Week  |
  | 3     | Month |
  | 4     | Year  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the DiscountCode record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  The unique alphanumeric code customers enter to apply the discount.
</ParamField>

<ParamField type="string">
  Human-readable description of what this discount code is for.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether this discount code is currently active and can be redeemed.
</ParamField>

<ParamField type="string">
  Date from which this discount code is visible/published to customers.
</ParamField>

<ParamField type="string">
  Date until which this discount code is visible/published to customers.
</ParamField>

<ParamField type="number">
  Percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.
</ParamField>

<ParamField type="number">
  Fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.
</ParamField>

<ParamField type="boolean">
  Whether this discount code is used as part of the referral program.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added tariffs value for this discount code.
</ParamField>

<ParamField type="integer[]">
  The removed tariffs value for this discount code.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.
</ParamField>

<ParamField type="integer[]">
  List of resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added resource types value for this discount code.
</ParamField>

<ParamField type="integer[]">
  The removed resource types value for this discount code.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to products. When true, use Products to restrict to specific products.
</ParamField>

<ParamField type="integer[]">
  List of products linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added products value for this discount code.
</ParamField>

<ParamField type="integer[]">
  The removed products value for this discount code.
</ParamField>

<ParamField type="boolean">
  Whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added event categories value for this discount code.
</ParamField>

<ParamField type="integer[]">
  The removed event categories value for this discount code.
</ParamField>

<ParamField type="integer">
  Maximum number of times a single customer can redeem this discount code.
</ParamField>

<ParamField type="integer">
  Maximum total number of times this discount code can be redeemed across all customers.
</ParamField>

<ParamField type="boolean">
  When true, only contacts (non-member customers) can use this discount code.
</ParamField>

<ParamField type="boolean">
  When true, only members (customers with an active plan) can use this discount code.
</ParamField>

<ParamField type="string">
  Start date from which this discount code can be redeemed.
</ParamField>

<ParamField type="string">
  End date after which this discount code can no longer be redeemed.
</ParamField>

<ParamField type="integer">
  Unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer. See `eDiscountExpirePeriod?` enum above.
</ParamField>

<ParamField type="integer">
  Number of ExpirationType periods after assignment until the discount expires for a customer.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/discountcodes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Code": "",
      "Description": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/discountcodes',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Code: '',
        Description: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/discountcodes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Code': '',
          'Description': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the discountcode was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "DiscountCode was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Code: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Code"
    }
  ],
  "WasSuccessful": false
}
```


# Update ExtraServicePrice
Source: https://learn.nexudus.com/rest-api/billing/put-extraserviceprices

PUT /api/billing/extraserviceprices
Update an existing ExtraServicePrice record.

Updates an existing ExtraServicePrice record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ExtraServicePrice-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ExtraServicePrice record to update.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Overriding price charged to members on the specified tariff.
</ParamField>

### Optional Fields

<ParamField type="number">
  Optional maximum price cap for time-based extra services on the specified tariff.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/extraserviceprices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ExtraServiceId": 0,
      "TariffId": 0,
      "Price": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraserviceprices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ExtraServiceId: 0,
        TariffId: 0,
        Price: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/extraserviceprices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ExtraServiceId': 0,
          'TariffId': 0,
          'Price': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraserviceprice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServicePrice was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Price: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Price"
    }
  ],
  "WasSuccessful": false
}
```


# Update ExtraService
Source: https://learn.nexudus.com/rest-api/billing/put-extraservices

PUT /api/billing/extraservices
Update an existing ExtraService record.

Updates an existing ExtraService record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ExtraService-Edit`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eLastMinuteDiscountType — LastMinuteAdjustmentType values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Disabled |
  | 2     | Fixed    |
  | 3     | Gradual  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ExtraService record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Extra service name.
</ParamField>

<ParamField type="integer">
  Display order.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

<ParamField type="integer">
  Charge period.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Last-minute discount type.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this extra service.
</ParamField>

<ParamField type="string">
  Invoice line display text.
</ParamField>

<ParamField type="boolean">
  Whether the price is visible on the portal and app.
</ParamField>

<ParamField type="integer[]">
  List of resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added resource types value for this extra service.
</ParamField>

<ParamField type="integer[]">
  The removed resource types value for this extra service.
</ParamField>

<ParamField type="number">
  Credit price.
</ParamField>

<ParamField type="number">
  Maximum price cap.
</ParamField>

<ParamField type="boolean">
  Use as the default price for matched resource types if more than one price applies.
</ParamField>

<ParamField type="boolean">
  Use per-night pricing.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  Start time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  End time restriction (minutes from midnight).
</ParamField>

<ParamField type="integer">
  Minimum booking length (minutes).
</ParamField>

<ParamField type="integer">
  Maximum booking length (minutes).
</ParamField>

<ParamField type="boolean">
  Only apply within the resource's available times.
</ParamField>

<ParamField type="integer">
  Fixed cost booking length threshold (minutes).
</ParamField>

<ParamField type="number">
  Fixed cost price applied once the threshold is reached.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added tariffs value for this extra service.
</ParamField>

<ParamField type="integer[]">
  The removed tariffs value for this extra service.
</ParamField>

<ParamField type="boolean">
  Only available for contacts.
</ParamField>

<ParamField type="boolean">
  Only available for members.
</ParamField>

<ParamField type="boolean">
  Price uses booking credits.
</ParamField>

<ParamField type="boolean">
  Price uses printing credits.
</ParamField>

<ParamField type="boolean">
  Apply charge to visitors.
</ParamField>

<ParamField type="number">
  Price factor for low demand periods.
</ParamField>

<ParamField type="number">
  Price factor for average demand periods.
</ParamField>

<ParamField type="number">
  Price factor for high demand periods.
</ParamField>

<ParamField type="number">
  Price factor for last-minute bookings.
</ParamField>

<ParamField type="integer">
  Last-minute period threshold (minutes before booking).
</ParamField>

<ParamField type="string">
  Date from which this price applies.
</ParamField>

<ParamField type="string">
  Date until which this price applies.
</ParamField>

<ParamField type="string">
  Comma-separated names of associated resource types.
</ParamField>

<ParamField type="integer[]">
  List of teams linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added teams value for this extra service.
</ParamField>

<ParamField type="integer[]">
  The removed teams value for this extra service.
</ParamField>

### Children

<ParamField type="object[]">
  The days and times this extra service price is available for booking. The year, month and day component of FromTime/ToTime is always 1976-01-01.

  <Expandable>
    <ParamField type="integer">
      The day of week value for this extra service time slot.
    </ParamField>

    <ParamField type="string">
      Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
    </ParamField>

    <ParamField type="string">
      End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
    </ParamField>

    <ParamField type="boolean">
      Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
    </ParamField>
  </Expandable>
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/extraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "DisplayOrder": 0,
      "Price": 0,
      "ChargePeriod": 0,
      "CurrencyId": 0,
      "LastMinuteAdjustmentType": 0,
      "Id": 87654321,
      "TimeSlots": [
          {
              "DayOfWeek": 0,
              "FromTime": "2025-01-15T10:30:00Z",
              "ToTime": "2025-01-15T10:30:00Z",
              "Available": null
          }
      ]
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        DisplayOrder: 0,
        Price: 0,
        ChargePeriod: 0,
        CurrencyId: 0,
        LastMinuteAdjustmentType: 0,
        Id: 87654321,
        TimeSlots: [object Object]
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/extraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'DisplayOrder': 0,
          'Price': 0,
          'ChargePeriod': 0,
          'CurrencyId': 0,
          'LastMinuteAdjustmentType': 0,
          'Id': 87654321,
          'TimeSlots': [object Object]
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraservice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraService was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ExtraServiceTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/put-extraservicetimeslots

PUT /api/billing/extraservicetimeslots
Update an existing ExtraServiceTimeSlot record.

Updates an existing ExtraServiceTimeSlot record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ExtraServiceTimeSlot-Edit`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ExtraServiceTimeSlot record to update.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="string">
  Start time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="string">
  End time of the availability window. Only the time-of-day component is used; the date component is always 1976-01-01..
</ParamField>

<ParamField type="integer">
  The day of week value for this extra service time slot.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether the extra service is available for booking during this time slot. When false, the slot acts as an explicit block..
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/extraservicetimeslots" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ExtraServiceId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ExtraServiceId: 0,
        FromTime: '2025-01-15T10:30:00Z',
        ToTime: '2025-01-15T10:30:00Z',
        DayOfWeek: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/extraservicetimeslots',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ExtraServiceId': 0,
          'FromTime': '2025-01-15T10:30:00Z',
          'ToTime': '2025-01-15T10:30:00Z',
          'DayOfWeek': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the extraservicetimeslot was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ExtraServiceTimeSlot was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}
```


# Update FinancialAccount
Source: https://learn.nexudus.com/rest-api/billing/put-financialaccounts

PUT /api/billing/financialaccounts
Update an existing FinancialAccount record.

Updates an existing FinancialAccount record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`FinancialAccount-Edit`** role.
</Note>

## Enums

<Accordion title="eFinancialAccountType — AccountType values">
  | Value | Name     |
  | ----- | -------- |
  | 0     | None     |
  | 1     | Sales    |
  | 2     | Payments |
  | 3     | Deposits |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the FinancialAccount record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Display name for this financial account.
</ParamField>

<ParamField type="string">
  Short reference code, typically matching the account code in an external accounting system.
</ParamField>

<ParamField type="integer">
  Category of the account: Sales (1), Payments (2) or Deposits (3).
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional free-text description of the account's purpose.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/financialaccounts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "Code": "",
      "AccountType": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/financialaccounts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        Code: '',
        AccountType: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/financialaccounts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'Code': '',
          'AccountType': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the financialaccount was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FinancialAccount was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update Invoice
Source: https://learn.nexudus.com/rest-api/billing/put-invoices

PUT /api/billing/invoices
Update an existing Invoice record.

Updates an existing Invoice record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Invoice-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Invoice record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Name of the person or organisation being billed, captured at invoice time.
</ParamField>

<ParamField type="string">
  Billing street address, captured at invoice time.
</ParamField>

<ParamField type="string">
  Billing city, captured at invoice time.
</ParamField>

<ParamField type="string">
  Billing postal/ZIP code, captured at invoice time.
</ParamField>

<ParamField type="integer">
  ID of the bill to country linked to this record.
</ParamField>

### Optional Fields

<ParamField type="string">
  Tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
</ParamField>

<ParamField type="string">
  Billing phone number, captured at invoice time.
</ParamField>

<ParamField type="string">
  Billing fax number, captured at invoice time.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/invoices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "BillToName": "",
      "BillToAddress": "",
      "BillToCity": "",
      "BillToPostCode": "",
      "BillToCountryId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/invoices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        BillToName: '',
        BillToAddress: '',
        BillToCity: '',
        BillToPostCode: '',
        BillToCountryId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/invoices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'BillToName': '',
          'BillToAddress': '',
          'BillToCity': '',
          'BillToPostCode': '',
          'BillToCountryId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the invoice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Invoice was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "InvoiceNumber: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "InvoiceNumber"
    }
  ],
  "WasSuccessful": false
}
```


# Update PaymentGateway
Source: https://learn.nexudus.com/rest-api/billing/put-paymentgateways

PUT /api/billing/paymentgateways
Update an existing PaymentGateway record.

Updates an existing PaymentGateway record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`PaymentGateway-Edit`** role.
</Note>

## Enums

<Accordion title="ePaymentGatewayType — PaymentGatewayType values">
  | Value | Name                               |
  | ----- | ---------------------------------- |
  | 0     | None                               |
  | 1     | test                               |
  | 2     | authorize\_net                     |
  | 3     | beanstream                         |
  | 4     | braintree                          |
  | 6     | first\_data\_e4                    |
  | 7     | jetpay\_v2                         |
  | 8     | merchant\_e\_solutions             |
  | 9     | netbilling                         |
  | 10    | payment\_express                   |
  | 12    | sage                               |
  | 13    | stripe                             |
  | 14    | trans\_first                       |
  | 15    | usa\_epay                          |
  | 17    | blue\_pay                          |
  | 18    | cyber\_source                      |
  | 19    | elavon                             |
  | 20    | first\_data\_e4\_v27               |
  | 21    | litle                              |
  | 22    | mercury                            |
  | 23    | nmi                                |
  | 24    | payflow\_pro                       |
  | 25    | quantum                            |
  | 26    | secure\_net                        |
  | 27    | trust\_commerce                    |
  | 28    | worldpay                           |
  | 29    | wirecard                           |
  | 30    | paymill                            |
  | 31    | merchant\_warrior                  |
  | 32    | nab\_transact                      |
  | 33    | secure\_pay\_au                    |
  | 34    | eway                               |
  | 35    | migs                               |
  | 36    | pin                                |
  | 37    | ogone                              |
  | 38    | realex                             |
  | 39    | moneris                            |
  | 40    | psi\_gate                          |
  | 41    | epay                               |
  | 42    | hdfc                               |
  | 43    | net\_pay                           |
  | 44    | redsys                             |
  | 45    | iridium                            |
  | 46    | barclays\_epdq\_extra\_plus        |
  | 49    | paypal                             |
  | 50    | payex                              |
  | 51    | openpay                            |
  | 52    | hps                                |
  | 53    | checkout                           |
  | 54    | checkout\_v2                       |
  | 55    | worldpay\_us                       |
  | 56    | conekta                            |
  | 57    | orbital                            |
  | 59    | barclaycard\_smartpay              |
  | 60    | trans\_first\_transaction\_express |
  | 63    | forte                              |
  | 65    | citrus\_pay                        |
  | 66    | payu\_latam                        |
  | 67    | global\_collect                    |
  | 68    | cayan                              |
  | 69    | clearhaus                          |
  | 70    | sage\_pay                          |
  | 71    | safe\_charge                       |
  | 72    | mercado\_pago                      |
  | 73    | payeezy                            |
  | 200   | acapture                           |
  | 201   | adyen                              |
  | 203   | banco\_sabadell                    |
  | 208   | blue\_snap                         |
  | 209   | borgun                             |
  | 210   | bpoint                             |
  | 212   | bridge\_pay                        |
  | 213   | card\_connect                      |
  | 214   | card\_stream                       |
  | 215   | cardprocess                        |
  | 217   | cecabank                           |
  | 218   | cenpos                             |
  | 224   | creditcall                         |
  | 225   | credorax                           |
  | 226   | ct\_payment                        |
  | 227   | culqi                              |
  | 229   | data\_cash                         |
  | 230   | diamond\_mind                      |
  | 231   | dibs                               |
  | 232   | digitzs                            |
  | 234   | element                            |
  | 237   | eway\_rapid                        |
  | 238   | ezic                               |
  | 239   | fat\_zebra                         |
  | 242   | first\_giving                      |
  | 243   | first\_pay                         |
  | 244   | flo2cash                           |
  | 245   | flo2cash\_simple                   |
  | 247   | global                             |
  | 249   | global\_iris                       |
  | 250   | global\_transport                  |
  | 253   | iats\_payments                     |
  | 255   | iveri                              |
  | 256   | ixopay                             |
  | 257   | jabstry                            |
  | 258   | jetpay                             |
  | 260   | kushki                             |
  | 261   | latitude19                         |
  | 263   | maxipago                           |
  | 266   | merchant\_partners                 |
  | 272   | mundipagg                          |
  | 274   | ncr\_secure\_pay                   |
  | 280   | optimal\_payments                  |
  | 282   | pay\_conex                         |
  | 283   | pay\_junction\_v2                  |
  | 288   | paymentez                          |
  | 291   | paystation                         |
  | 294   | pro\_pay                           |
  | 296   | qbms                               |
  | 298   | quickpay                           |
  | 299   | quickpay\_v10                      |
  | 300   | qvalent                            |
  | 303   | s5                                 |
  | 309   | securion\_pay                      |
  | 312   | tns                                |
  | 317   | vanco                              |
  | 318   | visanet\_peru                      |
  | 319   | wepay                              |
  | 320   | stripe\_payment\_intents           |
  | 321   | stripeACH                          |
  | 323   | quickbooks                         |
  | 324   | monei                              |
  | 401   | HostedPaymentPage1                 |
  | 402   | HostedPaymentPage2                 |
  | 403   | HostedPaymentPage3                 |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the PaymentGateway record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Display name for this payment gateway configuration.
</ParamField>

<ParamField type="integer">
  The payment provider to use (e.g. stripe, braintree, adyen). Determines which credentials are required.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether attempt3d secure is enabled.
</ParamField>

<ParamField type="string">
  Provider-specific configuration in XML format (e.g. merchant ID, additional keys).
</ParamField>

<ParamField type="number">
  Fee charged per transaction processed through this gateway.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/paymentgateways" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "PaymentGatewayType": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/paymentgateways',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        PaymentGatewayType: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/paymentgateways',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'PaymentGatewayType': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the paymentgateway was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "PaymentGateway was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProductBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/put-productbookingcredits

PUT /api/billing/productbookingcredits
Update an existing ProductBookingCredit record.

Updates an existing ProductBookingCredit record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProductBookingCredit-Edit`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProductBookingCredit record to update.
</ParamField>

<ParamField type="string">
  Credit name.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of elegible resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible resource types value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible resource types value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  List of elegible products linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible products value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible products value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  List of elegible tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible tariffs value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible tariffs value for this product booking credit.
</ParamField>

<ParamField type="integer">
  The expire time in months value for this product booking credit.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added event categories value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed event categories value for this product booking credit.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Number of periods (of `ExpirationType`) until the released credit expires.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="integer[]">
  List of elegible passes linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible passes value for this product booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible passes value for this product booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/productbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Name": "",
      "ProductId": 0,
      "Credit": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productbookingcredits',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Name: '',
        ProductId: 0,
        Credit: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/productbookingcredits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Name': '',
          'ProductId': 0,
          'Credit': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the productbookingcredit was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductBookingCredit was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProductExtraService
Source: https://learn.nexudus.com/rest-api/billing/put-productextraservices

PUT /api/billing/productextraservices
Update an existing ProductExtraService record.

Updates an existing ProductExtraService record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProductExtraService-Edit`** role.
</Note>

## Enums

<Accordion title="eChargePeriod — ExtraServiceChargePeriod values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Minutes        |
  | 2     | Days           |
  | 3     | Weeks          |
  | 4     | Months         |
  | 5     | Uses           |
  | 6     | FourWeekMonths |
</Accordion>

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProductExtraService record to update.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Uses included.
</ParamField>

### Optional Fields

<ParamField type="integer">
  The expire time in months value for this product extra service.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product extra service.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Expires in.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/productextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProductId": 0,
      "ExtraServiceId": 0,
      "UsesIncluded": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/productextraservices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProductId: 0,
        ExtraServiceId: 0,
        UsesIncluded: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/productextraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProductId': 0,
          'ExtraServiceId': 0,
          'UsesIncluded': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the productextraservice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductExtraService was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update Product
Source: https://learn.nexudus.com/rest-api/billing/put-products

PUT /api/billing/products
Update an existing Product record.

Updates an existing Product record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Product-Edit`** role.
</Note>

## Enums

<Accordion title="eProductType — SystemProductType values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | None            |
  | 1     | DayPass         |
  | 2     | CreditBundle    |
  | 3     | Stationery      |
  | 4     | BookingFeature  |
  | 5     | BookingProducts |
  | 99    | Other           |
</Accordion>

<Accordion title="eRecurrentProductOptions — AvailableAs values">
  | Value | Name              |
  | ----- | ----------------- |
  | 0     | None              |
  | 1     | RecurrentOrOneOff |
  | 2     | OnlyRecurrent     |
  | 3     | OnlyOneOff        |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Product record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Product name.
</ParamField>

<ParamField type="integer">
  Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.
</ParamField>

<ParamField type="string">
  Product description.
</ParamField>

<ParamField type="integer">
  Display order.
</ParamField>

<ParamField type="number">
  Product price.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).
</ParamField>

### Optional Fields

<ParamField type="string">
  Custom text shown on the invoice line instead of the product name.
</ParamField>

<ParamField type="string">
  SKU code.
</ParamField>

<ParamField type="string">
  Comma-separated tags for categorising and filtering.
</ParamField>

<ParamField type="boolean">
  Whether the product is visible to customers on the members portal and mobile app.
</ParamField>

<ParamField type="boolean">
  Whether the product is visible to customers in the NexKiosk app.
</ParamField>

<ParamField type="boolean">
  Whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.
</ParamField>

<ParamField type="string">
  Additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.
</ParamField>

<ParamField type="boolean">
  Whether to show the price of this product in AI channel recommendations and responses based on users' budget preferences.
</ParamField>

<ParamField type="number">
  Override price to show in AI channel recommendations and responses based on users' budget preferences (if not set, the regular Price value is used).
</ParamField>

<ParamField type="boolean">
  Sync to Square Point of Sale.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="boolean">
  Restrict purchase to contacts (customers without an active contract).
</ParamField>

<ParamField type="boolean">
  Restrict purchase to customers with an active contract (members).
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added tariffs value for this product.
</ParamField>

<ParamField type="integer[]">
  The removed tariffs value for this product.
</ParamField>

<ParamField type="boolean">
  Whether the product is archived. Archived products cannot be sold but existing charges remain active.
</ParamField>

<ParamField type="boolean">
  Mark the product as featured or highlighted.
</ParamField>

<ParamField type="boolean">
  Enable stock tracking for this product. When enabled, each sale reduces the stock count.
</ParamField>

<ParamField type="boolean">
  Allow sales to continue even when stock reaches zero.
</ParamField>

<ParamField type="integer">
  Stock level at which a low-stock alert is triggered.
</ParamField>

<ParamField type="boolean">
  Whether to pro-rate the price when the product is added or removed part-way through a billing period.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current image file.
</ParamField>

<ParamField type="boolean">
  Whether to invoice the customer directly rather than their company or team.
</ParamField>

<ParamField type="boolean">
  Sync to NexKiosk.
</ParamField>

<ParamField type="boolean">
  Automatically create a delivery record for the customer when this product is purchased.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/products" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "SystemProductType": 0,
      "Description": "",
      "DisplayOrder": 0,
      "Price": 0,
      "CurrencyId": 0,
      "AvailableAs": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/products',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        SystemProductType: 0,
        Description: '',
        DisplayOrder: 0,
        Price: 0,
        CurrencyId: 0,
        AvailableAs: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/products',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'SystemProductType': 0,
          'Description': '',
          'DisplayOrder': 0,
          'Price': 0,
          'CurrencyId': 0,
          'AvailableAs': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the product was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Product was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProductTimePass
Source: https://learn.nexudus.com/rest-api/billing/put-producttimepasses

PUT /api/billing/producttimepasses
Update an existing ProductTimePass record.

Updates an existing ProductTimePass record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProductTimePass-Edit`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProductTimePass record to update.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  Passes included.
</ParamField>

### Optional Fields

<ParamField type="integer">
  The expire time in months value for this product time pass.
</ParamField>

<ParamField type="integer">
  The expire time in weeks value for this product time pass.
</ParamField>

<ParamField type="integer">
  Expiration type. See `eRecurrentChargePattern?` enum above.
</ParamField>

<ParamField type="integer">
  Expires in.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/producttimepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProductId": 0,
      "TimePassId": 0,
      "PassesIncluded": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/producttimepasses',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProductId: 0,
        TimePassId: 0,
        PassesIncluded: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/producttimepasses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProductId': 0,
          'TimePassId': 0,
          'PassesIncluded': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the producttimepass was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProductTimePass was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProposalContract
Source: https://learn.nexudus.com/rest-api/billing/put-proposalcontracts

PUT /api/billing/proposalcontracts
Update an existing ProposalContract record.

Updates an existing ProposalContract record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProposalContract-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProposalContract record to update.
</ParamField>

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Billing day of month.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added desks value for this proposal contract.
</ParamField>

<ParamField type="integer[]">
  The removed desks value for this proposal contract.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added variants value for this proposal contract.
</ParamField>

<ParamField type="integer[]">
  The removed variants value for this proposal contract.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="string">
  Contract start date.
</ParamField>

<ParamField type="integer">
  Cancellation limit in days.
</ParamField>

<ParamField type="string">
  Contract term end date.
</ParamField>

<ParamField type="string">
  Cancellation date.
</ParamField>

<ParamField type="integer">
  ID of the discount code linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/proposalcontracts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/proposalcontracts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalcontract was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContract was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProposalContractSchedule
Source: https://learn.nexudus.com/rest-api/billing/put-proposalcontractschedules

PUT /api/billing/proposalcontractschedules
Update an existing ProposalContractSchedule record.

Updates an existing ProposalContractSchedule record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProposalContractSchedule-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProposalContractSchedule record to update.
</ParamField>

<ParamField type="integer">
  ID of the proposal contract linked to this record.
</ParamField>

<ParamField type="string">
  Date to apply.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal contract schedule.
</ParamField>

<ParamField type="number">
  Scheduled price.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/proposalcontractschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalContractId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalContractId: 0,
        ApplyOn: '2025-01-15T10:30:00Z',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalContractId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalcontractschedule was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalContractSchedule was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProposalProduct
Source: https://learn.nexudus.com/rest-api/billing/put-proposalproducts

PUT /api/billing/proposalproducts
Update an existing ProposalProduct record.

Updates an existing ProposalProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProposalProduct-Edit`** role.
</Note>

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | PricePlan      |
  | 2     | Day            |
  | 3     | Week           |
  | 4     | Month          |
  | 5     | Year           |
  | 6     | LastDayOfMonth |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProposalProduct record to update.
</ParamField>

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

<ParamField type="integer">
  Number of units.
</ParamField>

<ParamField type="integer">
  Repeat cycle pattern.
</ParamField>

### Optional Fields

<ParamField type="number">
  Price override.
</ParamField>

<ParamField type="boolean">
  Whether this is a deposit.
</ParamField>

<ParamField type="boolean">
  Whether this is a contract product.
</ParamField>

<ParamField type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField type="string">
  Invoice on date.
</ParamField>

<ParamField type="string">
  Repeat from date.
</ParamField>

<ParamField type="string">
  Repeat until date.
</ParamField>

<ParamField type="integer">
  Number of repeat units.
</ParamField>

<ParamField type="boolean">
  Apply pro-rating.
</ParamField>

<ParamField type="string">
  Optional notes or comments about this proposal product.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/proposalproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "ProductId": 0,
      "Quantity": 0,
      "RepeatCycle": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        ProductId: 0,
        Quantity: 0,
        RepeatCycle: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/proposalproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'ProductId': 0,
          'Quantity': 0,
          'RepeatCycle': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}
```


# Update Proposal
Source: https://learn.nexudus.com/rest-api/billing/put-proposals

PUT /api/billing/proposals
Update an existing Proposal record.

Updates an existing Proposal record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Proposal-Edit`** role.
</Note>

## Enums

<Accordion title="eProposalStatus — ProposalStatus values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Draft    |
  | 2     | Sent     |
  | 3     | Accepted |
  | 4     | Rejected |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Proposal record to update.
</ParamField>

<ParamField type="integer">
  ID of the issued by linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the responsible linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Proposal reference.
</ParamField>

<ParamField type="integer">
  Proposal status.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal.
</ParamField>

<ParamField type="integer">
  ID of the document to send linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the document to sign linked to this record.
</ParamField>

<ParamField type="string">
  The document to sign html value for this proposal.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the document to sign binary document.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current document to sign binary document file.
</ParamField>

<ParamField type="string">
  The document to send html value for this proposal.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the document to send binary document.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current document to send binary document file.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the proposal file.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current proposal file file.
</ParamField>

<ParamField type="integer[]">
  List of desks linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added desks value for this proposal.
</ParamField>

<ParamField type="integer[]">
  The removed desks value for this proposal.
</ParamField>

<ParamField type="integer[]">
  List of variants linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added variants value for this proposal.
</ParamField>

<ParamField type="integer[]">
  The removed variants value for this proposal.
</ParamField>

<ParamField type="number">
  Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="string">
  Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField type="integer">
  ID of the discount code linked to this record.
</ParamField>

<ParamField type="string">
  Date/time value for start date local.
</ParamField>

<ParamField type="string">
  Date/time value for sent on local.
</ParamField>

<ParamField type="boolean">
  If true, the first invoice is not issued automatically when the proposal is accepted.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/proposals" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "IssuedById": 0,
      "ResponsibleId": 0,
      "CoworkerId": 0,
      "Reference": "",
      "ProposalStatus": 0,
      "TariffId": 0,
      "BillingDay": 0,
      "Quantity": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        IssuedById: 0,
        ResponsibleId: 0,
        CoworkerId: 0,
        Reference: '',
        ProposalStatus: 0,
        TariffId: 0,
        BillingDay: 0,
        Quantity: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/proposals',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'IssuedById': 0,
          'ResponsibleId': 0,
          'CoworkerId': 0,
          'Reference': '',
          'ProposalStatus': 0,
          'TariffId': 0,
          'BillingDay': 0,
          'Quantity': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposal was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Proposal was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Reference: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Reference"
    }
  ],
  "WasSuccessful": false
}
```


# Update ProposalSchedule
Source: https://learn.nexudus.com/rest-api/billing/put-proposalschedules

PUT /api/billing/proposalschedules
Update an existing ProposalSchedule record.

Updates an existing ProposalSchedule record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ProposalSchedule-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ProposalSchedule record to update.
</ParamField>

<ParamField type="integer">
  ID of the proposal linked to this record.
</ParamField>

<ParamField type="string">
  Date to apply.
</ParamField>

### Optional Fields

<ParamField type="string">
  Optional notes or comments about this proposal schedule.
</ParamField>

<ParamField type="number">
  Scheduled price.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/proposalschedules" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ProposalId": 0,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalschedules',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ProposalId: 0,
        ApplyOn: '2025-01-15T10:30:00Z',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/proposalschedules',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ProposalId': 0,
          'ApplyOn': '2025-01-15T10:30:00Z',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the proposalschedule was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ProposalSchedule was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}
```


# Update ResourceProduct
Source: https://learn.nexudus.com/rest-api/billing/put-resourceproducts

PUT /api/billing/resourceproducts
Update an existing ResourceProduct record.

Updates an existing ResourceProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`ResourceProduct-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the ResourceProduct record to update.
</ParamField>

<ParamField type="integer">
  ID of the resource linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether to invoice in minutes.
</ParamField>

<ParamField type="boolean">
  Whether to request quantity.
</ParamField>

<ParamField type="boolean">
  Whether the resource product is visible.
</ParamField>

<ParamField type="number">
  Price override.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/resourceproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ResourceId": 0,
      "ProductId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/resourceproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ResourceId: 0,
        ProductId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/resourceproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ResourceId': 0,
          'ProductId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the resourceproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ResourceProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffBookingCredit
Source: https://learn.nexudus.com/rest-api/billing/put-tariffbookingcredits

PUT /api/billing/tariffbookingcredits
Update an existing TariffBookingCredit record.

Updates an existing TariffBookingCredit record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffBookingCredit-Edit`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffBookingCredit record to update.
</ParamField>

<ParamField type="string">
  Credit name.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Credit amount.
</ParamField>

<ParamField type="integer">
  Service renewal time period.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of elegible resource types linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible resource types value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible resource types value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  List of elegible products linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible products value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible products value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  List of elegible tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible tariffs value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible tariffs value for this tariff booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField type="boolean">
  Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField type="integer[]">
  List of event categories linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added event categories value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed event categories value for this tariff booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField type="integer[]">
  List of elegible passes linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added elegible passes value for this tariff booking credit.
</ParamField>

<ParamField type="integer[]">
  The removed elegible passes value for this tariff booking credit.
</ParamField>

<ParamField type="boolean">
  Whether this universal credit applies to other charges.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffbookingcredits" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "Name": "",
      "TariffId": 0,
      "Credit": 0,
      "ServiceRenewalTime": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        Name: '',
        TariffId: 0,
        Credit: 0,
        ServiceRenewalTime: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffbookingcredits',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'Name': '',
          'TariffId': 0,
          'Credit': 0,
          'ServiceRenewalTime': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffbookingcredit was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffBookingCredit was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffDefaultDueDate
Source: https://learn.nexudus.com/rest-api/billing/put-tariffdefaultduedates

PUT /api/billing/tariffdefaultduedates
Update an existing TariffDefaultDueDate record.

Updates an existing TariffDefaultDueDate record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffDefaultDueDate-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffDefaultDueDate record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

### Optional Fields

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added tariffs value for this tariff default due date.
</ParamField>

<ParamField type="integer[]">
  The removed tariffs value for this tariff default due date.
</ParamField>

<ParamField type="integer">
  Day of month to auto collect.
</ParamField>

<ParamField type="integer">
  Days after invoice to auto collect.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffdefaultduedates" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffdefaultduedates',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffdefaultduedate was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffDefaultDueDate was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffExtraService
Source: https://learn.nexudus.com/rest-api/billing/put-tariffextraservices

PUT /api/billing/tariffextraservices
Update an existing TariffExtraService record.

Updates an existing TariffExtraService record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffExtraService-Edit`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — ServiceRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffExtraService record to update.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the extra service linked to this record.
</ParamField>

<ParamField type="integer">
  Number of uses included.
</ParamField>

<ParamField type="integer">
  Service renewal time period.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffextraservices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ExtraServiceId": 0,
      "UsesIncluded": 0,
      "ServiceRenewalTime": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffextraservices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ExtraServiceId: 0,
        UsesIncluded: 0,
        ServiceRenewalTime: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffextraservices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ExtraServiceId': 0,
          'UsesIncluded': 0,
          'ServiceRenewalTime': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffextraservice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffExtraService was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "ServiceRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ServiceRenewalTime"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffProduct
Source: https://learn.nexudus.com/rest-api/billing/put-tariffproducts

PUT /api/billing/tariffproducts
Update an existing TariffProduct record.

Updates an existing TariffProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffProduct-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffProduct record to update.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ProductId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ProductId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ProductId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update Tariff
Source: https://learn.nexudus.com/rest-api/billing/put-tariffs

PUT /api/billing/tariffs
Update an existing Tariff record.

Updates an existing Tariff record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Tariff-Edit`** role.
</Note>

## Enums

<Accordion title="eTariffType — SystemTariffType values">
  | Value | Name                  |
  | ----- | --------------------- |
  | 1     | FullTimePrivateOffice |
  | 2     | PartTimePrivateOffice |
  | 3     | FullTimeDedicatedDesk |
  | 4     | PartTimeDedicatedDesk |
  | 5     | FullTimeHotDesk       |
  | 6     | PartTimeHotDesk       |
  | 7     | FullTimeOther         |
  | 8     | PartTimeOther         |
  | 9     | Storage               |
  | 10    | VirtualOffice         |
  | 11    | Virtual               |
  | 99    | Other                 |
</Accordion>

<Accordion title="eTariffBookingDueDateStrategy — BookingDueDateStrategy values">
  | Value | Name                |
  | ----- | ------------------- |
  | 1     | RenewalDate         |
  | 2     | BookingEndDate      |
  | 3     | BookingCreationDate |
  | 4     | NextNthOfMonth      |
</Accordion>

<Accordion title="eIdentityCheckProvider — AddressIdentityCheckProvider values">
  | Value | Name           |
  | ----- | -------------- |
  | 1     | Manual         |
  | 2     | StripeIdentity |
</Accordion>

<Accordion title="eIdentityCheckRepeatPattern — AddressIdentityCheckRepeatPattern values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Never         |
  | 2     | Every3Months  |
  | 3     | Every6Months  |
  | 4     | Every12Months |
  | 5     | Every24Months |
</Accordion>

<Accordion title="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                    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Tariff record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Plan name.
</ParamField>

<ParamField type="integer">
  Category of the plan: FullTimePrivateOffice, PartTimePrivateOffice, FullTimeDedicatedDesk, PartTimeDedicatedDesk, FullTimeHotDesk, PartTimeHotDesk, FullTimeOther, PartTimeOther, Storage, VirtualOffice, Virtual, or Other.
</ParamField>

<ParamField type="number">
  Recurring price charged per billing cycle.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

<ParamField type="integer">
  Number of days' notice required before a contract can be cancelled.
</ParamField>

<ParamField type="integer">
  Display order on the members portal (lower numbers appear first).
</ParamField>

<ParamField type="integer">
  Billing cycle length in months. Set to 0 if billing by weeks instead.
</ParamField>

<ParamField type="integer">
  Billing cycle length in weeks. Set to 0 if billing by months instead.
</ParamField>

<ParamField type="integer">
  Strategy for determining when booking charges are due: RenewalDate, BookingEndDate, BookingCreationDate, or NextNthOfMonth.
</ParamField>

<ParamField type="integer">
  Provider used for address identity checks: Manual or StripeIdentity.
</ParamField>

<ParamField type="integer">
  How often to repeat the address identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
</ParamField>

<ParamField type="integer">
  Provider used for identity checks: Manual or StripeIdentity.
</ParamField>

<ParamField type="integer">
  How often to repeat the identity check: Never, Every3Months, Every6Months, Every12Months, or Every24Months.
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for mail deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for parcel deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for check deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for publicity deliveries (virtual office).
</ParamField>

<ParamField type="integer">
  Allowed handling preferences for other deliveries (virtual office).
</ParamField>

### Optional Fields

<ParamField type="integer">
  Day of the month on which invoices are generated for members on this plan.
</ParamField>

<ParamField type="boolean">
  Whether the plan is visible to customers on the members portal and mobile app.
</ParamField>

<ParamField type="boolean">
  Whether this plan is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.
</ParamField>

<ParamField type="string">
  Custom notes provided to the AI assistant when describing this plan.
</ParamField>

<ParamField type="boolean">
  Whether to show the plan price to the AI assistant.
</ParamField>

<ParamField type="number">
  Custom price shown to the AI assistant instead of the actual price.
</ParamField>

<ParamField type="boolean">
  Whether this plan uses time passes for check-in access.
</ParamField>

<ParamField type="string">
  Plan description shown to customers.
</ParamField>

<ParamField type="string">
  Custom text shown on the invoice line instead of the plan name.
</ParamField>

<ParamField type="number">
  One-off fee charged when a customer first signs up to this plan.
</ParamField>

<ParamField type="integer">
  Standard tax rate applied to charges on this plan.
</ParamField>

<ParamField type="integer">
  Reduced tax rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Tax-exempt rate applied when applicable.
</ParamField>

<ParamField type="integer">
  Financial account used for revenue tracking.
</ParamField>

<ParamField type="string">
  Terms and conditions text that members must accept when signing up.
</ParamField>

<ParamField type="string">
  URL to upload a new contract document template.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the uploaded contract document file.
</ParamField>

<ParamField type="string">
  Group name used to visually group plans together on the members portal.
</ParamField>

<ParamField type="boolean">
  Prevents members from cancelling this plan through the members portal.
</ParamField>

<ParamField type="integer">
  Maximum number of members that can be signed up to this plan at any time.
</ParamField>

<ParamField type="integer">
  Minimum number of days a contract must be active before it can be cancelled.
</ParamField>

<ParamField type="integer">
  Default minimum contract term in months for new sign-ups.
</ParamField>

<ParamField type="integer">
  Number of days after contract cancellation before the member account is deactivated.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins included per billing cycle.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of check-ins allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum number of visitor passes allowed per day.
</ParamField>

<ParamField type="integer">
  Maximum number of hours included per billing cycle.
</ParamField>

<ParamField type="integer">
  Maximum number of hours allowed per month.
</ParamField>

<ParamField type="integer">
  Maximum number of hours allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum booking minutes allowed per week.
</ParamField>

<ParamField type="integer">
  Maximum booking minutes allowed per month.
</ParamField>

<ParamField type="number">
  Discount percentage for extra services.
</ParamField>

<ParamField type="number">
  Discount percentage for time passes.
</ParamField>

<ParamField type="number">
  Discount percentage for charges.
</ParamField>

<ParamField type="integer">
  Number of days after which the contract is automatically cancelled if not paid.
</ParamField>

<ParamField type="integer">
  Number of billing cycles to invoice in advance.
</ParamField>

<ParamField type="integer">
  Day of the month used to align billing cycles when prorating.
</ParamField>

<ParamField type="integer">
  Number of days before the prorate day to start prorating.
</ParamField>

<ParamField type="boolean">
  Whether to prorate the final invoice when a contract is cancelled mid-cycle.
</ParamField>

<ParamField type="integer">
  Number of days to extend a contract after payment is received.
</ParamField>

<ParamField type="boolean">
  Whether to exclude this plan's charges from member invoices.
</ParamField>

<ParamField type="boolean">
  Whether to automatically generate invoices at the end of each billing cycle.
</ParamField>

<ParamField type="integer">
  Raise invoice every N months.
</ParamField>

<ParamField type="integer">
  Raise invoice every N weeks.
</ParamField>

<ParamField type="number">
  Minimum total amount charged per billing cycle regardless of usage.
</ParamField>

<ParamField type="boolean">
  Whether time pass charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether extra service charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether event charges count towards the minimum price.
</ParamField>

<ParamField type="boolean">
  Whether the plan is archived and no longer available for new sign-ups.
</ParamField>

<ParamField type="boolean">
  Whether the plan is starred (highlighted) on the members portal.
</ParamField>

<ParamField type="boolean">
  Whether new sign-ups are kept on hold until manually approved.
</ParamField>

<ParamField type="boolean">
  Whether members can pause their contract on this plan.
</ParamField>

<ParamField type="integer">
  Maximum number of times a contract can be paused per year.
</ParamField>

<ParamField type="integer">
  Maximum number of billing cycles a contract can be paused for.
</ParamField>

<ParamField type="integer">
  Day of the month used when BookingDueDateStrategy is NextNthOfMonth.
</ParamField>

<ParamField type="boolean">
  Whether this is a virtual office plan with mail handling features.
</ParamField>

<ParamField type="boolean">
  Whether to keep the contract on hold until all required identity checks are completed.
</ParamField>

<ParamField type="boolean">
  Whether to request an address identity check from members signing up to this plan.
</ParamField>

<ParamField type="string">
  Instructions shown to members when completing the address identity check.
</ParamField>

<ParamField type="boolean">
  Whether to keep the contract paused if the address identity check reveals a mismatch.
</ParamField>

<ParamField type="boolean">
  Whether to request an identity (ID document) check from members signing up to this plan.
</ParamField>

<ParamField type="string">
  Instructions shown to members when completing the identity check.
</ParamField>

<ParamField type="boolean">
  Whether to request an AML check from members signing up to this plan.
</ParamField>

<ParamField type="boolean">
  Whether to enable AML checks against the OpenSanctions dataset.
</ParamField>

<ParamField type="boolean">
  Whether to enable AML checks against the Pappers dataset.
</ParamField>

<ParamField type="string">
  Which OpenSanctions dataset to check against for AML screening (e.g. 'default').
</ParamField>

<ParamField type="number">
  Score threshold for AML checks, between 0 and 1. Matches with a score above this threshold will be considered a positive match. Default is 0.7.
</ParamField>

<ParamField type="boolean">
  Whether to email the onboarding form to new members signing up to this plan.
</ParamField>

<ParamField type="integer">
  ID of the onboarding form page sent to new members.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail stored for collection (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products store value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products store value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail forwarding (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products forward value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products forward value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail recycling (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products recycle value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products recycle value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail shredding (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products shred value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products shred value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail scanning (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products scan value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products scan value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for returning mail to sender (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products return value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products return value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for check deposits (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products deposit value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products deposit value for this tariff.
</ParamField>

<ParamField type="integer[]">
  Product IDs for mail collection (virtual office).
</ParamField>

<ParamField type="integer[]">
  The added products collect value for this tariff.
</ParamField>

<ParamField type="integer[]">
  The removed products collect value for this tariff.
</ParamField>

<ParamField type="integer">
  Maximum number of days deliveries are stored before being returned (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of company name aliases allowed for mail handling (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of mail recipients allowed (virtual office).
</ParamField>

<ParamField type="integer">
  Maximum number of forwarding addresses allowed (virtual office).
</ParamField>

<ParamField type="boolean">
  Whether to automatically transfer mail handling products to the member's contract.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffs" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "SystemTariffType": 0,
      "Price": 0,
      "CurrencyId": 0,
      "CancellationPeriod": 0,
      "DisplayOrder": 0,
      "InvoiceEvery": 0,
      "InvoiceEveryWeeks": 0,
      "BookingDueDateStrategy": 0,
      "AddressIdentityCheckProvider": 0,
      "AddressIdentityCheckRepeatPattern": 0,
      "IdentityCheckProvider": 0,
      "IdentityCheckRepeatPattern": 0,
      "DeliveryPreferencesMail": 0,
      "DeliveryPreferencesParcels": 0,
      "DeliveryPreferencesChecks": 0,
      "DeliveryPreferencesPublicity": 0,
      "DeliveryPreferencesOther": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffs',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        SystemTariffType: 0,
        Price: 0,
        CurrencyId: 0,
        CancellationPeriod: 0,
        DisplayOrder: 0,
        InvoiceEvery: 0,
        InvoiceEveryWeeks: 0,
        BookingDueDateStrategy: 0,
        AddressIdentityCheckProvider: 0,
        AddressIdentityCheckRepeatPattern: 0,
        IdentityCheckProvider: 0,
        IdentityCheckRepeatPattern: 0,
        DeliveryPreferencesMail: 0,
        DeliveryPreferencesParcels: 0,
        DeliveryPreferencesChecks: 0,
        DeliveryPreferencesPublicity: 0,
        DeliveryPreferencesOther: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffs',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'SystemTariffType': 0,
          'Price': 0,
          'CurrencyId': 0,
          'CancellationPeriod': 0,
          'DisplayOrder': 0,
          'InvoiceEvery': 0,
          'InvoiceEveryWeeks': 0,
          'BookingDueDateStrategy': 0,
          'AddressIdentityCheckProvider': 0,
          'AddressIdentityCheckRepeatPattern': 0,
          'IdentityCheckProvider': 0,
          'IdentityCheckRepeatPattern': 0,
          'DeliveryPreferencesMail': 0,
          'DeliveryPreferencesParcels': 0,
          'DeliveryPreferencesChecks': 0,
          'DeliveryPreferencesPublicity': 0,
          'DeliveryPreferencesOther': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariff was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Tariff was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffSignupProduct
Source: https://learn.nexudus.com/rest-api/billing/put-tariffsignupproducts

PUT /api/billing/tariffsignupproducts
Update an existing TariffSignupProduct record.

Updates an existing TariffSignupProduct record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffSignupProduct-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffSignupProduct record to update.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the product linked to this record.
</ParamField>

### Optional Fields

<ParamField type="number">
  Signup product price override.
</ParamField>

<ParamField type="boolean">
  Whether the signup product is refundable.
</ParamField>

<ParamField type="boolean">
  Whether invoice during online checkout is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tariffsignupproducts" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "ProductId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        ProductId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tariffsignupproducts',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'ProductId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tariffsignupproduct was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffSignupProduct was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TariffTimePass
Source: https://learn.nexudus.com/rest-api/billing/put-tarifftimepasses

PUT /api/billing/tarifftimepasses
Update an existing TariffTimePass record.

Updates an existing TariffTimePass record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TariffTimePass-Edit`** role.
</Note>

## Enums

<Accordion title="eTimeSpanWeekMonth — PassRenewalTime values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Week          |
  | 2     | CalendarMonth |
  | 3     | TariffMonth   |
  | 4     | Year          |
  | 5     | Day           |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TariffTimePass record to update.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  Number of passes included.
</ParamField>

<ParamField type="integer">
  Pass renewal time period.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/tarifftimepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TariffId": 0,
      "TimePassId": 0,
      "PassesIncluded": 0,
      "PassRenewalTime": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/tarifftimepasses',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TariffId: 0,
        TimePassId: 0,
        PassesIncluded: 0,
        PassRenewalTime: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/tarifftimepasses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TariffId': 0,
          'TimePassId': 0,
          'PassesIncluded': 0,
          'PassRenewalTime': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the tarifftimepass was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TariffTimePass was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "PassRenewalTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "PassRenewalTime"
    }
  ],
  "WasSuccessful": false
}
```


# Update TimePass
Source: https://learn.nexudus.com/rest-api/billing/put-timepasses

PUT /api/billing/timepasses
Update an existing TimePass record.

Updates an existing TimePass record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TimePass-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TimePass record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  Time pass name.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

<ParamField type="integer">
  ID of the currency linked to this record.
</ParamField>

### Optional Fields

<ParamField type="string">
  Invoice line display text.
</ParamField>

<ParamField type="integer">
  Minutes included.
</ParamField>

<ParamField type="boolean">
  Counts towards plan limits.
</ParamField>

<ParamField type="boolean">
  Use as pay-as-you-go for members.
</ParamField>

<ParamField type="boolean">
  Use as pay-as-you-go for contacts.
</ParamField>

<ParamField type="integer">
  Use priority.
</ParamField>

<ParamField type="integer">
  ID of the tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the reduced tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the exempt tax rate linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the financial account linked to this record.
</ParamField>

<ParamField type="integer[]">
  List of businesses linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added businesses value for this time pass.
</ParamField>

<ParamField type="integer[]">
  The removed businesses value for this time pass.
</ParamField>

<ParamField type="string">
  Kisi group ID.
</ParamField>

<ParamField type="string">
  DoorGuard group ID.
</ParamField>

<ParamField type="string">
  ID of the access control group associated with this record.
</ParamField>

<ParamField type="boolean">
  Allow network check-in.
</ParamField>

<ParamField type="boolean">
  Only available for contacts.
</ParamField>

<ParamField type="boolean">
  Only available for members.
</ParamField>

<ParamField type="integer[]">
  List of tariffs linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added tariffs value for this time pass.
</ParamField>

<ParamField type="integer[]">
  The removed tariffs value for this time pass.
</ParamField>

<ParamField type="boolean">
  Whether this time pass is archived and hidden from active lists.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/timepasses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "Price": 0,
      "CurrencyId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        Price: 0,
        CurrencyId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/timepasses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'Price': 0,
          'CurrencyId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepass was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePass was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update TimePassPrice
Source: https://learn.nexudus.com/rest-api/billing/put-timepassprices

PUT /api/billing/timepassprices
Update an existing TimePassPrice record.

Updates an existing TimePassPrice record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TimePassPrice-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TimePassPrice record to update.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the tariff linked to this record.
</ParamField>

<ParamField type="number">
  Unit price amount.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/timepassprices" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TimePassId": 0,
      "TariffId": 0,
      "Price": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepassprices',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TimePassId: 0,
        TariffId: 0,
        Price: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/timepassprices',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TimePassId': 0,
          'TariffId': 0,
          'Price': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepassprice was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassPrice was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Price: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Price"
    }
  ],
  "WasSuccessful": false
}
```


# Update TimePassTimeSlot
Source: https://learn.nexudus.com/rest-api/billing/put-timepasstimeslots

PUT /api/billing/timepasstimeslots
Update an existing TimePassTimeSlot record.

Updates an existing TimePassTimeSlot record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`TimePassTimeSlot-Edit`** role.
</Note>

## Enums

<Accordion title="DayOfWeek — DayOfWeek values">
  | Value | Name      |
  | ----- | --------- |
  | 0     | Sunday    |
  | 1     | Monday    |
  | 2     | Tuesday   |
  | 3     | Wednesday |
  | 4     | Thursday  |
  | 5     | Friday    |
  | 6     | Saturday  |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the TimePassTimeSlot record to update.
</ParamField>

<ParamField type="integer">
  ID of the time pass linked to this record.
</ParamField>

<ParamField type="string">
  Start time.
</ParamField>

<ParamField type="string">
  End time.
</ParamField>

<ParamField type="integer">
  The day of week value for this time pass time slot.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/timepasstimeslots" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "TimePassId": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "DayOfWeek": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        TimePassId: 0,
        FromTime: '2025-01-15T10:30:00Z',
        ToTime: '2025-01-15T10:30:00Z',
        DayOfWeek: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/timepasstimeslots',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'TimePassId': 0,
          'FromTime': '2025-01-15T10:30:00Z',
          'ToTime': '2025-01-15T10:30:00Z',
          'DayOfWeek': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the timepasstimeslot was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "TimePassTimeSlot was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}
```


# Delete Workspace
Source: https://learn.nexudus.com/rest-api/collaboration/delete-workspaces-by-id

DELETE /api/collaboration/workspaces/{id}
Delete an existing Workspace record by its Id.

Deletes a Workspace record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Workspace-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Workspace record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/collaboration/workspaces/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/collaboration/workspaces/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Workspace was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Search Workspaces
Source: https://learn.nexudus.com/rest-api/collaboration/get-workspaces

GET /api/collaboration/workspaces
Search and list Workspace records with filtering, sorting, and pagination.

A **Workspace** represents a collaborative workspace or project area where team members can share files, communicate, and coordinate work within the platform.

## Authentication

<Note>
  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 **`Workspace-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the administrator linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the name value for this workspace.
</ParamField>

<ParamField type="boolean">
  Filter by whether visible in my spaces is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether visible by everyone is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether this workspace is archived and hidden from active lists.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this workspace.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/collaboration/workspaces?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/collaboration/workspaces',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/collaboration/workspaces?Workspace_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces?' + new URLSearchParams({
      Workspace_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/collaboration/workspaces',
      params={
          'Workspace_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/collaboration/workspaces?from_Workspace_UpdatedOn=2025-01-01T00:00&to_Workspace_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces?' + new URLSearchParams({
      from_Workspace_UpdatedOn: '2025-01-01T00:00',
      to_Workspace_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/collaboration/workspaces',
      params={
          'from_Workspace_UpdatedOn': '2025-01-01T00:00',
          'to_Workspace_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Workspace[]">
  The list of Workspace records matching the query. See the [Get one Workspace](/rest-api/collaboration/get-workspaces-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Workspace. The following fields are **not populated** in the `Records[]` response: `Description`.

  To get all fields, fetch the full record using the [Get one Workspace](/rest-api/collaboration/get-workspaces-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "AdministratorId": 0,
      "Name": "",
      "VisibleInMySpaces": false,
      "VisibleByEveryone": false,
      "Archived": false,
      "Members": [],
      "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": "Workspace Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Workspaces
Source: https://learn.nexudus.com/rest-api/collaboration/get-workspaces-batch

GET /api/collaboration/workspaces/?id=[{id1},{id2},{id3}]
Retrieve multiple Workspace records by their Ids in a single request.

Fetch several Workspace records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Workspace-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Workspace Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/collaboration/workspaces/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/collaboration/workspaces/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Workspace records. Each record has the same structure as the response from the [Get one Workspace](/rest-api/collaboration/get-workspaces-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Workspace. The following fields are **not populated** in the response: `Description`.

  To get all fields, fetch the full record using the [Get one Workspace](/rest-api/collaboration/get-workspaces-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "AdministratorId": 0,
    "Name": "",
    "VisibleInMySpaces": false,
    "VisibleByEveryone": false,
    "Archived": false,
    "Members": [],
    "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": "Workspace Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Workspace
Source: https://learn.nexudus.com/rest-api/collaboration/get-workspaces-by-id

GET /api/collaboration/workspaces/{id}
Retrieve a single Workspace record by its Id.

A **Workspace** represents a collaborative workspace or project area where team members can share files, communicate, and coordinate work within the platform.

## Authentication

<Note>
  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 **`Workspace-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Workspace record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/collaboration/workspaces/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="AdministratorId" type="integer">
  ID of the administrator linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this workspace.
</ResponseField>

<ResponseField name="VisibleInMySpaces" type="boolean">
  Whether visible in my spaces is enabled.
</ResponseField>

<ResponseField name="VisibleByEveryone" type="boolean">
  Whether visible by everyone is enabled.
</ResponseField>

<ResponseField name="Archived" type="boolean">
  Whether this workspace is archived and hidden from active lists.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this workspace.
</ResponseField>

<ResponseField name="Members" type="integer[]">
  List of members linked to this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "AdministratorId": 0,
  "Name": "",
  "VisibleInMySpaces": false,
  "VisibleByEveryone": false,
  "Archived": false,
  "Description": null,
  "Members": [],
  "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": "Workspace Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Create Workspace
Source: https://learn.nexudus.com/rest-api/collaboration/post-workspaces

POST /api/collaboration/workspaces
Create a new Workspace record.

A **Workspace** represents a collaborative workspace or project area where team members can share files, communicate, and coordinate work within the platform.

## Authentication

<Note>
  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 **`Workspace-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the administrator linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this workspace.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether visible in my spaces is enabled.
</ParamField>

<ParamField type="boolean">
  Whether visible by everyone is enabled.
</ParamField>

<ParamField type="boolean">
  Whether this workspace is archived and hidden from active lists.
</ParamField>

<ParamField type="string">
  Free-text description of this workspace.
</ParamField>

<ParamField type="integer[]">
  List of members linked to this record.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/collaboration/workspaces" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "AdministratorId": 0,
      "Name": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        AdministratorId: 0,
        Name: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/collaboration/workspaces',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'AdministratorId': 0,
          'Name': ''
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the workspace was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Workspace 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update Workspace
Source: https://learn.nexudus.com/rest-api/collaboration/put-workspaces

PUT /api/collaboration/workspaces
Update an existing Workspace record.

Updates an existing Workspace record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`Workspace-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the Workspace record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="integer">
  ID of the administrator linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this workspace.
</ParamField>

### Optional Fields

<ParamField type="boolean">
  Whether visible in my spaces is enabled.
</ParamField>

<ParamField type="boolean">
  Whether visible by everyone is enabled.
</ParamField>

<ParamField type="boolean">
  Whether this workspace is archived and hidden from active lists.
</ParamField>

<ParamField type="string">
  Free-text description of this workspace.
</ParamField>

<ParamField type="integer[]">
  List of members linked to this record.
</ParamField>

<ParamField type="integer[]">
  The added members value for this workspace.
</ParamField>

<ParamField type="integer[]">
  The removed members value for this workspace.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/collaboration/workspaces" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "AdministratorId": 0,
      "Name": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/collaboration/workspaces',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        AdministratorId: 0,
        Name: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/collaboration/workspaces',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'AdministratorId': 0,
          'Name': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the workspace was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Workspace was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Delete CommunityGroup
Source: https://learn.nexudus.com/rest-api/community/delete-communitygroups-by-id

DELETE /api/community/communitygroups/{id}
Delete an existing CommunityGroup record by its Id.

Deletes a CommunityGroup record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityGroup-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityGroup record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitygroups/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitygroups/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityGroup was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityMessageLike
Source: https://learn.nexudus.com/rest-api/community/delete-communitymessagelikes-by-id

DELETE /api/community/communitymessagelikes/{id}
Delete an existing CommunityMessageLike record by its Id.

Deletes a CommunityMessageLike record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityMessageLike-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityMessageLike record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitymessagelikes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitymessagelikes/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessageLike was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityMessage
Source: https://learn.nexudus.com/rest-api/community/delete-communitymessages-by-id

DELETE /api/community/communitymessages/{id}
Delete an existing CommunityMessage record by its Id.

Deletes a CommunityMessage record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityMessage-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityMessage record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitymessages/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitymessages/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessage was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityThreadFile
Source: https://learn.nexudus.com/rest-api/community/delete-communitythreadfiles-by-id

DELETE /api/community/communitythreadfiles/{id}
Delete an existing CommunityThreadFile record by its Id.

Deletes a CommunityThreadFile record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityThreadFile-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadFile record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitythreadfiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitythreadfiles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFile was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityThreadFollow
Source: https://learn.nexudus.com/rest-api/community/delete-communitythreadfollows-by-id

DELETE /api/community/communitythreadfollows/{id}
Delete an existing CommunityThreadFollow record by its Id.

Deletes a CommunityThreadFollow record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityThreadFollow-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadFollow record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitythreadfollows/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitythreadfollows/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFollow was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityThreadLike
Source: https://learn.nexudus.com/rest-api/community/delete-communitythreadlikes-by-id

DELETE /api/community/communitythreadlikes/{id}
Delete an existing CommunityThreadLike record by its Id.

Deletes a CommunityThreadLike record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityThreadLike-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadLike record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitythreadlikes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitythreadlikes/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadLike was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityThreadMute
Source: https://learn.nexudus.com/rest-api/community/delete-communitythreadmutes-by-id

DELETE /api/community/communitythreadmutes/{id}
Delete an existing CommunityThreadMute record by its Id.

Deletes a CommunityThreadMute record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityThreadMute-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadMute record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitythreadmutes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitythreadmutes/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadMute was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityThread
Source: https://learn.nexudus.com/rest-api/community/delete-communitythreads-by-id

DELETE /api/community/communitythreads/{id}
Delete an existing CommunityThread record by its Id.

Deletes a CommunityThread record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityThread-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThread record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/communitythreads/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/communitythreads/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThread was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete VideoRoom
Source: https://learn.nexudus.com/rest-api/community/delete-videorooms-by-id

DELETE /api/community/videorooms/{id}
Delete an existing VideoRoom record by its Id.

Deletes a VideoRoom record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`VideoRoom-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the VideoRoom record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/community/videorooms/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/community/videorooms/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "VideoRoom was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Search CommunityGroups
Source: https://learn.nexudus.com/rest-api/community/get-communitygroups

GET /api/community/communitygroups
Search and list CommunityGroup records with filtering, sorting, and pagination.

A **CommunityGroup** is a named subset of customers used to control who can see and contribute to conversations on the Discussion Board. Groups are created by admins and can be assigned to `CommunityThread` conversations to restrict or open participation.

Each group has an access level (`GroupAccess`) that determines visibility:

| Value            | Meaning                                                                   |
| ---------------- | ------------------------------------------------------------------------- |
| `Restricted` (1) | All customers can see the group's conversations but only members can post |
| `Public` (2)     | Any customer with access to Discussion Boards can see and post            |
| `Private` (3)    | Only group members can see or post in the group's conversations           |

Groups can also be auto-generated by the system: if a `Team` has `HasCommunityGroup = true`, a group is created and its GUID stored in `TeamGuid`; if a `Course` has `HasCommunityGroup = true`, a group is created and its GUID stored in `CourseGuid`.

## Authentication

<Note>
  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 **`CommunityGroup-List`** role.
</Note>

## Enums

<Accordion title="eCommunityThreadVisibility — GroupAccess values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Restricted |
  | 2     | Public     |
  | 3     | Private    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the location this group belongs to.
</ParamField>

<ParamField type="string">
  Filter by location name.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user account designated as the group administrator.
</ParamField>

<ParamField type="string">
  Filter by display name of the group.
</ParamField>

<ParamField type="string">
  Filter by short description of the group's purpose shown to customers.
</ParamField>

<ParamField type="integer">
  Filter by access level controlling who can see and post in this group's conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only.
</ParamField>

<ParamField type="string">
  Filter by gUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ParamField>

<ParamField type="string">
  Filter by gUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?CommunityGroup_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      CommunityGroup_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'CommunityGroup_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?from_CommunityGroup_UpdatedOn=2025-01-01T00:00&to_CommunityGroup_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      from_CommunityGroup_UpdatedOn: '2025-01-01T00:00',
      to_CommunityGroup_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'from_CommunityGroup_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityGroup_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityGroup[]">
  The list of CommunityGroup records matching the query. See the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CommunityGroup. The following fields are **not populated** in the `Records[]` response: `Description`.

  To get all fields, fetch the full record using the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "UserId": 0,
      "Name": "",
      "GroupAccess": 0,
      "Members": [],
      "TeamGuid": null,
      "CourseGuid": 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": "CommunityGroup Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityGroups
Source: https://learn.nexudus.com/rest-api/community/get-communitygroups-batch

GET /api/community/communitygroups/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityGroup records by their Ids in a single request.

Fetch several CommunityGroup records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityGroup-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityGroup Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityGroup records. Each record has the same structure as the response from the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CommunityGroup. The following fields are **not populated** in the response: `Description`.

  To get all fields, fetch the full record using the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "UserId": 0,
    "Name": "",
    "GroupAccess": 0,
    "Members": [],
    "TeamGuid": null,
    "CourseGuid": 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": "CommunityGroup Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityGroup
Source: https://learn.nexudus.com/rest-api/community/get-communitygroups-by-id

GET /api/community/communitygroups/{id}
Retrieve a single CommunityGroup record by its Id.

A **CommunityGroup** is a named subset of customers used to control who can see and contribute to conversations on the Discussion Board. Groups are created by admins and can be assigned to `CommunityThread` conversations to restrict or open participation.

Each group has an access level (`GroupAccess`) that determines visibility:

| Value            | Meaning                                                                   |
| ---------------- | ------------------------------------------------------------------------- |
| `Restricted` (1) | All customers can see the group's conversations but only members can post |
| `Public` (2)     | Any customer with access to Discussion Boards can see and post            |
| `Private` (3)    | Only group members can see or post in the group's conversations           |

Groups can also be auto-generated by the system: if a `Team` has `HasCommunityGroup = true`, a group is created and its GUID stored in `TeamGuid`; if a `Course` has `HasCommunityGroup = true`, a group is created and its GUID stored in `CourseGuid`.

## Authentication

<Note>
  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 **`CommunityGroup-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityGroup record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the location this group belongs to.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user account designated as the group administrator.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the group.
</ResponseField>

<ResponseField name="Description" type="string">
  Short description of the group's purpose shown to customers.
</ResponseField>

<ResponseField name="GroupAccess" type="integer">
  Access level controlling who can see and post in this group's conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only. See `eCommunityThreadVisibility` enum values: `1` = Restricted, `2` = Public, `3` = Private.
</ResponseField>

<ResponseField name="Members" type="integer[]">
  IDs of customers who are members of this group.
</ResponseField>

<ResponseField name="TeamGuid" type="string">
  GUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ResponseField>

<ResponseField name="CourseGuid" type="string">
  GUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "UserId": 0,
  "Name": "",
  "Description": null,
  "GroupAccess": 0,
  "Members": [],
  "TeamGuid": null,
  "CourseGuid": 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": "CommunityGroup Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityMessageLikes
Source: https://learn.nexudus.com/rest-api/community/get-communitymessagelikes

GET /api/community/communitymessagelikes
Search and list CommunityMessageLike records with filtering, sorting, and pagination.

A **CommunityMessageLike** records a like placed by a user on an individual `CommunityMessage` reply in a Discussion Board conversation. Each record represents a single like from one user on one message.

## Authentication

<Note>
  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 **`CommunityMessageLike-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the message that was liked.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user who liked the message.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessagelikes?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessagelikes',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessagelikes?CommunityMessageLike_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes?' + new URLSearchParams({
      CommunityMessageLike_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessagelikes',
      params={
          'CommunityMessageLike_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessagelikes?from_CommunityMessageLike_UpdatedOn=2025-01-01T00:00&to_CommunityMessageLike_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes?' + new URLSearchParams({
      from_CommunityMessageLike_UpdatedOn: '2025-01-01T00:00',
      to_CommunityMessageLike_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessagelikes',
      params={
          'from_CommunityMessageLike_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityMessageLike_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityMessageLike[]">
  The list of CommunityMessageLike records matching the query. See the [Get one CommunityMessageLike](/rest-api/community/get-communitymessagelikes-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "MessageId": 0,
      "UserId": 0,
      "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": "CommunityMessageLike Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityMessageLikes
Source: https://learn.nexudus.com/rest-api/community/get-communitymessagelikes-batch

GET /api/community/communitymessagelikes/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityMessageLike records by their Ids in a single request.

Fetch several CommunityMessageLike records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityMessageLike-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityMessageLike Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessagelikes/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessagelikes/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityMessageLike records. Each record has the same structure as the response from the [Get one CommunityMessageLike](/rest-api/community/get-communitymessagelikes-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "MessageId": 0,
    "UserId": 0,
    "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": "CommunityMessageLike Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityMessageLike
Source: https://learn.nexudus.com/rest-api/community/get-communitymessagelikes-by-id

GET /api/community/communitymessagelikes/{id}
Retrieve a single CommunityMessageLike record by its Id.

A **CommunityMessageLike** records a like placed by a user on an individual `CommunityMessage` reply in a Discussion Board conversation. Each record represents a single like from one user on one message.

## Authentication

<Note>
  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 **`CommunityMessageLike-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityMessageLike record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessagelikes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="MessageId" type="integer">
  ID of the message that was liked.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user who liked the message.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "MessageId": 0,
  "UserId": 0,
  "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": "CommunityMessageLike Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityMessages
Source: https://learn.nexudus.com/rest-api/community/get-communitymessages

GET /api/community/communitymessages
Search and list CommunityMessage records with filtering, sorting, and pagination.

A **CommunityMessage** is an individual reply posted within a `CommunityThread` conversation on the Discussion Board. Admins and customers with a customer account can add messages to any conversation to help others or share information.

Admins can delete any message; customers can only delete their own.

## Authentication

<Note>
  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 **`CommunityMessage-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the conversation this message belongs to.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user account that posted this message.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer profile that posted this message.
</ParamField>

<ParamField type="string">
  Filter by body text of the message.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessages?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessages',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessages?CommunityMessage_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages?' + new URLSearchParams({
      CommunityMessage_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessages',
      params={
          'CommunityMessage_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessages?from_CommunityMessage_UpdatedOn=2025-01-01T00:00&to_CommunityMessage_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages?' + new URLSearchParams({
      from_CommunityMessage_UpdatedOn: '2025-01-01T00:00',
      to_CommunityMessage_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessages',
      params={
          'from_CommunityMessage_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityMessage_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityMessage[]">
  The list of CommunityMessage records matching the query. See the [Get one CommunityMessage](/rest-api/community/get-communitymessages-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CommunityThreadId": 0,
      "UserId": 0,
      "CoworkerId": null,
      "Message": 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": "CommunityMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityMessages
Source: https://learn.nexudus.com/rest-api/community/get-communitymessages-batch

GET /api/community/communitymessages/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityMessage records by their Ids in a single request.

Fetch several CommunityMessage records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityMessage-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityMessage Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessages/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitymessages/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityMessage records. Each record has the same structure as the response from the [Get one CommunityMessage](/rest-api/community/get-communitymessages-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CommunityThreadId": 0,
    "UserId": 0,
    "CoworkerId": null,
    "Message": 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": "CommunityMessage Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityMessage
Source: https://learn.nexudus.com/rest-api/community/get-communitymessages-by-id

GET /api/community/communitymessages/{id}
Retrieve a single CommunityMessage record by its Id.

A **CommunityMessage** is an individual reply posted within a `CommunityThread` conversation on the Discussion Board. Admins and customers with a customer account can add messages to any conversation to help others or share information.

Admins can delete any message; customers can only delete their own.

## Authentication

<Note>
  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 **`CommunityMessage-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityMessage record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitymessages/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CommunityThreadId" type="integer">
  ID of the conversation this message belongs to.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user account that posted this message.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the customer profile that posted this message.
</ResponseField>

<ResponseField name="Message" type="string">
  Body text of the message.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CommunityThreadId": 0,
  "UserId": 0,
  "CoworkerId": null,
  "Message": 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": "CommunityMessage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityThreadFiles
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfiles

GET /api/community/communitythreadfiles
Search and list CommunityThreadFile records with filtering, sorting, and pagination.

A **CommunityThreadFile** is a file or image attached to a `CommunityThread` conversation on the Discussion Board. When starting a conversation, customers can optionally include a picture or file alongside the opening message.

## Authentication

<Note>
  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 **`CommunityThreadFile-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the conversation this file is attached to.
</ParamField>

<ParamField type="string">
  Filter by display name of the attached file.
</ParamField>

<ParamField type="string">
  Filter by optional description of the attached file.
</ParamField>

<ParamField type="string">
  Filter by stored filename of the uploaded file.
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload and attach to this record.
</ParamField>

<ParamField type="boolean">
  Filter by when true, removes the currently attached file.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfiles?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfiles',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfiles?CommunityThreadFile_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles?' + new URLSearchParams({
      CommunityThreadFile_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfiles',
      params={
          'CommunityThreadFile_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfiles?from_CommunityThreadFile_UpdatedOn=2025-01-01T00:00&to_CommunityThreadFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles?' + new URLSearchParams({
      from_CommunityThreadFile_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThreadFile_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfiles',
      params={
          'from_CommunityThreadFile_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThreadFile_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityThreadFile[]">
  The list of CommunityThreadFile records matching the query. See the [Get one CommunityThreadFile](/rest-api/community/get-communitythreadfiles-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CommunityThreadId": 0,
      "Name": null,
      "Description": null,
      "FileDataFileName": null,
      "NewFileDataUrl": null,
      "ClearFileDataFile": 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": "CommunityThreadFile Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityThreadFiles
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfiles-batch

GET /api/community/communitythreadfiles/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityThreadFile records by their Ids in a single request.

Fetch several CommunityThreadFile records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityThreadFile-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityThreadFile Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfiles/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfiles/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityThreadFile records. Each record has the same structure as the response from the [Get one CommunityThreadFile](/rest-api/community/get-communitythreadfiles-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CommunityThreadId": 0,
    "Name": null,
    "Description": null,
    "FileDataFileName": null,
    "NewFileDataUrl": null,
    "ClearFileDataFile": 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": "CommunityThreadFile Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityThreadFile
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfiles-by-id

GET /api/community/communitythreadfiles/{id}
Retrieve a single CommunityThreadFile record by its Id.

A **CommunityThreadFile** is a file or image attached to a `CommunityThread` conversation on the Discussion Board. When starting a conversation, customers can optionally include a picture or file alongside the opening message.

## Authentication

<Note>
  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 **`CommunityThreadFile-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadFile record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CommunityThreadId" type="integer">
  ID of the conversation this file is attached to.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the attached file.
</ResponseField>

<ResponseField name="Description" type="string">
  Optional description of the attached file.
</ResponseField>

<ResponseField name="FileDataFileName" type="string">
  Stored filename of the uploaded file.
</ResponseField>

<ResponseField name="NewFileDataUrl" type="string">
  URL of a new file to upload and attach to this record.
</ResponseField>

<ResponseField name="ClearFileDataFile" type="boolean">
  When true, removes the currently attached file.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CommunityThreadId": 0,
  "Name": null,
  "Description": null,
  "FileDataFileName": null,
  "NewFileDataUrl": null,
  "ClearFileDataFile": 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": "CommunityThreadFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityThreadFollows
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfollows

GET /api/community/communitythreadfollows
Search and list CommunityThreadFollow records with filtering, sorting, and pagination.

A **CommunityThreadFollow** records a user following a `CommunityThread` conversation on the Discussion Board. Followers receive notifications when new messages are posted. Users automatically start following a conversation when they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadFollow-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the conversation being followed.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user following the conversation.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfollows?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfollows',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfollows?CommunityThreadFollow_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows?' + new URLSearchParams({
      CommunityThreadFollow_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfollows',
      params={
          'CommunityThreadFollow_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfollows?from_CommunityThreadFollow_UpdatedOn=2025-01-01T00:00&to_CommunityThreadFollow_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows?' + new URLSearchParams({
      from_CommunityThreadFollow_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThreadFollow_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfollows',
      params={
          'from_CommunityThreadFollow_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThreadFollow_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityThreadFollow[]">
  The list of CommunityThreadFollow records matching the query. See the [Get one CommunityThreadFollow](/rest-api/community/get-communitythreadfollows-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ThreadId": 0,
      "UserId": 0,
      "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": "CommunityThreadFollow Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityThreadFollows
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfollows-batch

GET /api/community/communitythreadfollows/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityThreadFollow records by their Ids in a single request.

Fetch several CommunityThreadFollow records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityThreadFollow-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityThreadFollow Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfollows/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadfollows/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityThreadFollow records. Each record has the same structure as the response from the [Get one CommunityThreadFollow](/rest-api/community/get-communitythreadfollows-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ThreadId": 0,
    "UserId": 0,
    "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": "CommunityThreadFollow Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityThreadFollow
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadfollows-by-id

GET /api/community/communitythreadfollows/{id}
Retrieve a single CommunityThreadFollow record by its Id.

A **CommunityThreadFollow** records a user following a `CommunityThread` conversation on the Discussion Board. Followers receive notifications when new messages are posted. Users automatically start following a conversation when they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadFollow-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadFollow record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadfollows/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ThreadId" type="integer">
  ID of the conversation being followed.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user following the conversation.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ThreadId": 0,
  "UserId": 0,
  "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": "CommunityThreadFollow Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityThreadLikes
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadlikes

GET /api/community/communitythreadlikes
Search and list CommunityThreadLike records with filtering, sorting, and pagination.

A **CommunityThreadLike** records a like placed by a user on a `CommunityThread` conversation on the Discussion Board. Each record represents a single like from one user on one conversation.

## Authentication

<Note>
  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 **`CommunityThreadLike-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the conversation that was liked.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user who liked the conversation.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadlikes?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadlikes',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadlikes?CommunityThreadLike_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes?' + new URLSearchParams({
      CommunityThreadLike_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadlikes',
      params={
          'CommunityThreadLike_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadlikes?from_CommunityThreadLike_UpdatedOn=2025-01-01T00:00&to_CommunityThreadLike_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes?' + new URLSearchParams({
      from_CommunityThreadLike_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThreadLike_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadlikes',
      params={
          'from_CommunityThreadLike_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThreadLike_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityThreadLike[]">
  The list of CommunityThreadLike records matching the query. See the [Get one CommunityThreadLike](/rest-api/community/get-communitythreadlikes-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ThreadId": 0,
      "UserId": 0,
      "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": "CommunityThreadLike Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityThreadLikes
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadlikes-batch

GET /api/community/communitythreadlikes/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityThreadLike records by their Ids in a single request.

Fetch several CommunityThreadLike records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityThreadLike-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityThreadLike Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadlikes/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadlikes/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityThreadLike records. Each record has the same structure as the response from the [Get one CommunityThreadLike](/rest-api/community/get-communitythreadlikes-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ThreadId": 0,
    "UserId": 0,
    "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": "CommunityThreadLike Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityThreadLike
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadlikes-by-id

GET /api/community/communitythreadlikes/{id}
Retrieve a single CommunityThreadLike record by its Id.

A **CommunityThreadLike** records a like placed by a user on a `CommunityThread` conversation on the Discussion Board. Each record represents a single like from one user on one conversation.

## Authentication

<Note>
  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 **`CommunityThreadLike-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadLike record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadlikes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ThreadId" type="integer">
  ID of the conversation that was liked.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user who liked the conversation.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ThreadId": 0,
  "UserId": 0,
  "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": "CommunityThreadLike Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityThreadMutes
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadmutes

GET /api/community/communitythreadmutes
Search and list CommunityThreadMute records with filtering, sorting, and pagination.

A **CommunityThreadMute** records a user muting a `CommunityThread` conversation on the Discussion Board. Muted users will not receive any notifications for that conversation, even if they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadMute-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the conversation being muted.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user muting the conversation.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadmutes?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadmutes',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadmutes?CommunityThreadMute_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes?' + new URLSearchParams({
      CommunityThreadMute_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadmutes',
      params={
          'CommunityThreadMute_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadmutes?from_CommunityThreadMute_UpdatedOn=2025-01-01T00:00&to_CommunityThreadMute_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes?' + new URLSearchParams({
      from_CommunityThreadMute_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThreadMute_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadmutes',
      params={
          'from_CommunityThreadMute_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThreadMute_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityThreadMute[]">
  The list of CommunityThreadMute records matching the query. See the [Get one CommunityThreadMute](/rest-api/community/get-communitythreadmutes-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "ThreadId": 0,
      "UserId": 0,
      "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": "CommunityThreadMute Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityThreadMutes
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadmutes-batch

GET /api/community/communitythreadmutes/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityThreadMute records by their Ids in a single request.

Fetch several CommunityThreadMute records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityThreadMute-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityThreadMute Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadmutes/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreadmutes/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityThreadMute records. Each record has the same structure as the response from the [Get one CommunityThreadMute](/rest-api/community/get-communitythreadmutes-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "ThreadId": 0,
    "UserId": 0,
    "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": "CommunityThreadMute Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityThreadMute
Source: https://learn.nexudus.com/rest-api/community/get-communitythreadmutes-by-id

GET /api/community/communitythreadmutes/{id}
Retrieve a single CommunityThreadMute record by its Id.

A **CommunityThreadMute** records a user muting a `CommunityThread` conversation on the Discussion Board. Muted users will not receive any notifications for that conversation, even if they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadMute-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThreadMute record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreadmutes/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="ThreadId" type="integer">
  ID of the conversation being muted.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user muting the conversation.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "ThreadId": 0,
  "UserId": 0,
  "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": "CommunityThreadMute Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityThreads
Source: https://learn.nexudus.com/rest-api/community/get-communitythreads

GET /api/community/communitythreads
Search and list CommunityThread records with filtering, sorting, and pagination.

A **CommunityThread** represents a conversation posted to the Discussion Board. Discussion boards are a community feature that allows customers to communicate on the Members Portal — they can start, follow, like, and reply to conversations, mention other customers, and receive notifications about new messages.

Conversations can be assigned to a group (`CommunityGroupId`) to control who can see and contribute. Conversations not linked to any group are visible to all customers with access to the Discussion Boards page.

Use `Tags` to help customers find relevant conversations. Set `Private` to `true` to limit visibility to only the customers explicitly mentioned in the message. Enable `InstantDelivery` to push notifications to followers immediately rather than waiting for the daily digest.

## Authentication

<Note>
  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 **`CommunityThread-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the location this conversation belongs to.
</ParamField>

<ParamField type="integer">
  Filter by iD of the group this conversation is assigned to; the group's access level (Public, Restricted, or Private) determines who can see and contribute to it.
</ParamField>

<ParamField type="integer">
  Filter by iD of the user account that posted this conversation.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer profile that posted this conversation.
</ParamField>

<ParamField type="string">
  Filter by title or topic of the conversation.
</ParamField>

<ParamField type="string">
  Filter by body text of the opening message in this conversation.
</ParamField>

<ParamField type="boolean">
  Filter by when true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
</ParamField>

<ParamField type="string">
  Filter by comma-separated tags to help customers find this conversation.
</ParamField>

<ParamField type="boolean">
  Filter by when true, the conversation is visible only to customers explicitly mentioned in the message.
</ParamField>

<ParamField type="string">
  Filter by date and time of the most recent reply in this conversation.
</ParamField>

<ParamField type="boolean">
  Filter by when true, attaches a Zoom meeting invite to this conversation.
</ParamField>

<ParamField type="string">
  Filter by jSON payload containing Zoom meeting details attached to this conversation.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date and time of the most recent reply in this conversation greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time of the most recent reply in this conversation less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreads?page=1&size=15&orderBy=Subject&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Subject',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreads',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Subject',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Subject

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreads?CommunityThread_Subject=example-value&orderBy=Subject&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads?' + new URLSearchParams({
      CommunityThread_Subject: 'example-value',
      orderBy: 'Subject',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreads',
      params={
          'CommunityThread_Subject': 'example-value',
          'orderBy': 'Subject',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreads?from_CommunityThread_UpdatedOn=2025-01-01T00:00&to_CommunityThread_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads?' + new URLSearchParams({
      from_CommunityThread_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThread_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreads',
      params={
          'from_CommunityThread_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThread_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityThread[]">
  The list of CommunityThread records matching the query. See the [Get one CommunityThread](/rest-api/community/get-communitythreads-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CommunityThread. The following fields are **not populated** in the `Records[]` response: `Message`, `InstantDelivery`, `IncludeZoomInvite`.

  To get all fields, fetch the full record using the [Get one CommunityThread](/rest-api/community/get-communitythreads-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "CommunityGroupId": null,
      "UserId": 0,
      "CoworkerId": null,
      "Subject": "",
      "Tags": null,
      "Private": false,
      "Guests": [],
      "LastMessageDate": null,
      "ZoomEventData": 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": "CommunityThread Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Subject",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityThreads
Source: https://learn.nexudus.com/rest-api/community/get-communitythreads-batch

GET /api/community/communitythreads/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityThread records by their Ids in a single request.

Fetch several CommunityThread records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityThread-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityThread Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreads/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitythreads/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityThread records. Each record has the same structure as the response from the [Get one CommunityThread](/rest-api/community/get-communitythreads-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CommunityThread. The following fields are **not populated** in the response: `Message`, `InstantDelivery`, `IncludeZoomInvite`.

  To get all fields, fetch the full record using the [Get one CommunityThread](/rest-api/community/get-communitythreads-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "CommunityGroupId": null,
    "UserId": 0,
    "CoworkerId": null,
    "Subject": "",
    "Tags": null,
    "Private": false,
    "Guests": [],
    "LastMessageDate": null,
    "ZoomEventData": 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": "CommunityThread Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityThread
Source: https://learn.nexudus.com/rest-api/community/get-communitythreads-by-id

GET /api/community/communitythreads/{id}
Retrieve a single CommunityThread record by its Id.

A **CommunityThread** represents a conversation posted to the Discussion Board. Discussion boards are a community feature that allows customers to communicate on the Members Portal — they can start, follow, like, and reply to conversations, mention other customers, and receive notifications about new messages.

Conversations can be assigned to a group (`CommunityGroupId`) to control who can see and contribute. Conversations not linked to any group are visible to all customers with access to the Discussion Boards page.

Use `Tags` to help customers find relevant conversations. Set `Private` to `true` to limit visibility to only the customers explicitly mentioned in the message. Enable `InstantDelivery` to push notifications to followers immediately rather than waiting for the daily digest.

## Authentication

<Note>
  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 **`CommunityThread-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityThread record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitythreads/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the location this conversation belongs to.
</ResponseField>

<ResponseField name="CommunityGroupId" type="integer">
  ID of the group this conversation is assigned to; the group's access level (Public, Restricted, or Private) determines who can see and contribute to it.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user account that posted this conversation.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the customer profile that posted this conversation.
</ResponseField>

<ResponseField name="Subject" type="string">
  Title or topic of the conversation.
</ResponseField>

<ResponseField name="Message" type="string">
  Body text of the opening message in this conversation.
</ResponseField>

<ResponseField name="InstantDelivery" type="boolean">
  When true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
</ResponseField>

<ResponseField name="Tags" type="string">
  Comma-separated tags to help customers find this conversation.
</ResponseField>

<ResponseField name="Private" type="boolean">
  When true, the conversation is visible only to customers explicitly mentioned in the message.
</ResponseField>

<ResponseField name="Guests" type="integer[]">
  IDs of users mentioned or invited as guests in this conversation.
</ResponseField>

<ResponseField name="LastMessageDate" type="string">
  Date and time of the most recent reply in this conversation.
</ResponseField>

<ResponseField name="IncludeZoomInvite" type="boolean">
  When true, attaches a Zoom meeting invite to this conversation.
</ResponseField>

<ResponseField name="ZoomEventData" type="string">
  JSON payload containing Zoom meeting details attached to this conversation.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "CommunityGroupId": null,
  "UserId": 0,
  "CoworkerId": null,
  "Subject": "",
  "Message": "",
  "InstantDelivery": false,
  "Tags": null,
  "Private": false,
  "Guests": [],
  "LastMessageDate": null,
  "IncludeZoomInvite": false,
  "ZoomEventData": 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": "CommunityThread Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search VideoRooms
Source: https://learn.nexudus.com/rest-api/community/get-videorooms

GET /api/community/videorooms
Search and list VideoRoom records with filtering, sorting, and pagination.

A **VideoRoom** represents a virtual meeting room for video conferencing. Video rooms enable online meetings between members and can be integrated with booking resources.

## Authentication

<Note>
  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 **`VideoRoom-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by the name value for this video room.
</ParamField>

<ParamField type="string">
  Filter by free-text description of this video room.
</ParamField>

<ParamField type="string">
  Filter by current file name of the image (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current image file.
</ParamField>

<ParamField type="integer">
  Filter by the number of participants value for this video room.
</ParamField>

<ParamField type="boolean">
  Filter by whether this video room is currently active.
</ParamField>

<ParamField type="boolean">
  Filter by whether only for contacts is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether only for members is enabled.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by the number of participants value for this video room greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by the number of participants value for this video room less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/videorooms?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/videorooms',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/videorooms?VideoRoom_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms?' + new URLSearchParams({
      VideoRoom_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/videorooms',
      params={
          'VideoRoom_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/videorooms?from_VideoRoom_UpdatedOn=2025-01-01T00:00&to_VideoRoom_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms?' + new URLSearchParams({
      from_VideoRoom_UpdatedOn: '2025-01-01T00:00',
      to_VideoRoom_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/videorooms',
      params={
          'from_VideoRoom_UpdatedOn': '2025-01-01T00:00',
          'to_VideoRoom_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="VideoRoom[]">
  The list of VideoRoom records matching the query. See the [Get one VideoRoom](/rest-api/community/get-videorooms-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Description": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "NumberOfParticipants": 0,
      "Active": false,
      "OnlyForContacts": false,
      "OnlyForMembers": false,
      "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": "VideoRoom Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple VideoRooms
Source: https://learn.nexudus.com/rest-api/community/get-videorooms-batch

GET /api/community/videorooms/?id=[{id1},{id2},{id3}]
Retrieve multiple VideoRoom records by their Ids in a single request.

Fetch several VideoRoom records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`VideoRoom-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of VideoRoom Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/videorooms/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/community/videorooms/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of VideoRoom records. Each record has the same structure as the response from the [Get one VideoRoom](/rest-api/community/get-videorooms-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "Description": null,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "NumberOfParticipants": 0,
    "Active": false,
    "OnlyForContacts": false,
    "OnlyForMembers": false,
    "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": "VideoRoom Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one VideoRoom
Source: https://learn.nexudus.com/rest-api/community/get-videorooms-by-id

GET /api/community/videorooms/{id}
Retrieve a single VideoRoom record by its Id.

A **VideoRoom** represents a virtual meeting room for video conferencing. Video rooms enable online meetings between members and can be integrated with booking resources.

## Authentication

<Note>
  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 **`VideoRoom-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the VideoRoom record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/videorooms/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this video room.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description of this video room.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current file name of the image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new file to upload as the image.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current image file.
</ResponseField>

<ResponseField name="NumberOfParticipants" type="integer">
  The number of participants value for this video room.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether this video room is currently active.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Whether only for contacts is enabled.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Whether only for members is enabled.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "NumberOfParticipants": 0,
  "Active": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "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": "VideoRoom Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Create CommunityGroup
Source: https://learn.nexudus.com/rest-api/community/post-communitygroups

POST /api/community/communitygroups
Create a new CommunityGroup record.

A **CommunityGroup** is a named subset of customers used to control who can see and contribute to conversations on the Discussion Board. Groups are created by admins and can be assigned to `CommunityThread` conversations to restrict or open participation.

Each group has an access level (`GroupAccess`) that determines visibility:

| Value            | Meaning                                                                   |
| ---------------- | ------------------------------------------------------------------------- |
| `Restricted` (1) | All customers can see the group's conversations but only members can post |
| `Public` (2)     | Any customer with access to Discussion Boards can see and post            |
| `Private` (3)    | Only group members can see or post in the group's conversations           |

Groups can also be auto-generated by the system: if a `Team` has `HasCommunityGroup = true`, a group is created and its GUID stored in `TeamGuid`; if a `Course` has `HasCommunityGroup = true`, a group is created and its GUID stored in `CourseGuid`.

## Authentication

<Note>
  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 **`CommunityGroup-Create`** role.
</Note>

## Enums

<Accordion title="eCommunityThreadVisibility — GroupAccess values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Restricted |
  | 2     | Public     |
  | 3     | Private    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the location this group belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account designated as the group administrator.
</ParamField>

<ParamField type="string">
  Display name of the group.
</ParamField>

<ParamField type="integer">
  Access level controlling who can see and post in this group's conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only.
</ParamField>

### Optional Fields

<ParamField type="string">
  Short description of the group's purpose shown to customers.
</ParamField>

<ParamField type="integer[]">
  IDs of customers who are members of this group.
</ParamField>

<ParamField type="string">
  GUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ParamField>

<ParamField type="string">
  GUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitygroups" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "UserId": 0,
      "Name": "",
      "GroupAccess": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        UserId: 0,
        Name: '',
        GroupAccess: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitygroups',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'UserId': 0,
          'Name': '',
          'GroupAccess': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitygroup was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityGroup 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityMessageLike
Source: https://learn.nexudus.com/rest-api/community/post-communitymessagelikes

POST /api/community/communitymessagelikes
Create a new CommunityMessageLike record.

A **CommunityMessageLike** records a like placed by a user on an individual `CommunityMessage` reply in a Discussion Board conversation. Each record represents a single like from one user on one message.

## Authentication

<Note>
  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 **`CommunityMessageLike-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the message that was liked.
</ParamField>

<ParamField type="integer">
  ID of the user who liked the message.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitymessagelikes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "MessageId": 0,
      "UserId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        MessageId: 0,
        UserId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitymessagelikes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'MessageId': 0,
          'UserId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitymessagelike was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessageLike 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityMessage
Source: https://learn.nexudus.com/rest-api/community/post-communitymessages

POST /api/community/communitymessages
Create a new CommunityMessage record.

A **CommunityMessage** is an individual reply posted within a `CommunityThread` conversation on the Discussion Board. Admins and customers with a customer account can add messages to any conversation to help others or share information.

Admins can delete any message; customers can only delete their own.

## Authentication

<Note>
  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 **`CommunityMessage-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the conversation this message belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account that posted this message.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the customer profile that posted this message.
</ParamField>

<ParamField type="string">
  Body text of the message.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitymessages" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CommunityThreadId": 0,
      "UserId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CommunityThreadId: 0,
        UserId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitymessages',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CommunityThreadId': 0,
          'UserId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitymessage was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessage 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityThreadFile
Source: https://learn.nexudus.com/rest-api/community/post-communitythreadfiles

POST /api/community/communitythreadfiles
Create a new CommunityThreadFile record.

A **CommunityThreadFile** is a file or image attached to a `CommunityThread` conversation on the Discussion Board. When starting a conversation, customers can optionally include a picture or file alongside the opening message.

## Authentication

<Note>
  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 **`CommunityThreadFile-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the conversation this file is attached to.
</ParamField>

### Optional Fields

<ParamField type="string">
  Display name of the attached file.
</ParamField>

<ParamField type="string">
  Optional description of the attached file.
</ParamField>

<ParamField type="string">
  URL of a new file to upload and attach to this record.
</ParamField>

<ParamField type="boolean">
  When true, removes the currently attached file.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitythreadfiles" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CommunityThreadId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CommunityThreadId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitythreadfiles',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CommunityThreadId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadfile was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFile 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityThreadFollow
Source: https://learn.nexudus.com/rest-api/community/post-communitythreadfollows

POST /api/community/communitythreadfollows
Create a new CommunityThreadFollow record.

A **CommunityThreadFollow** records a user following a `CommunityThread` conversation on the Discussion Board. Followers receive notifications when new messages are posted. Users automatically start following a conversation when they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadFollow-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the conversation being followed.
</ParamField>

<ParamField type="integer">
  ID of the user following the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitythreadfollows" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitythreadfollows',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadfollow was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFollow 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityThreadLike
Source: https://learn.nexudus.com/rest-api/community/post-communitythreadlikes

POST /api/community/communitythreadlikes
Create a new CommunityThreadLike record.

A **CommunityThreadLike** records a like placed by a user on a `CommunityThread` conversation on the Discussion Board. Each record represents a single like from one user on one conversation.

## Authentication

<Note>
  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 **`CommunityThreadLike-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the conversation that was liked.
</ParamField>

<ParamField type="integer">
  ID of the user who liked the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitythreadlikes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitythreadlikes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadlike was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadLike 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityThreadMute
Source: https://learn.nexudus.com/rest-api/community/post-communitythreadmutes

POST /api/community/communitythreadmutes
Create a new CommunityThreadMute record.

A **CommunityThreadMute** records a user muting a `CommunityThread` conversation on the Discussion Board. Muted users will not receive any notifications for that conversation, even if they are mentioned in it.

## Authentication

<Note>
  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 **`CommunityThreadMute-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the conversation being muted.
</ParamField>

<ParamField type="integer">
  ID of the user muting the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitythreadmutes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitythreadmutes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadmute was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadMute 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Create CommunityThread
Source: https://learn.nexudus.com/rest-api/community/post-communitythreads

POST /api/community/communitythreads
Create a new CommunityThread record.

A **CommunityThread** represents a conversation posted to the Discussion Board. Discussion boards are a community feature that allows customers to communicate on the Members Portal — they can start, follow, like, and reply to conversations, mention other customers, and receive notifications about new messages.

Conversations can be assigned to a group (`CommunityGroupId`) to control who can see and contribute. Conversations not linked to any group are visible to all customers with access to the Discussion Boards page.

Use `Tags` to help customers find relevant conversations. Set `Private` to `true` to limit visibility to only the customers explicitly mentioned in the message. Enable `InstantDelivery` to push notifications to followers immediately rather than waiting for the daily digest.

## Authentication

<Note>
  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 **`CommunityThread-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the location this conversation belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account that posted this conversation.
</ParamField>

<ParamField type="string">
  Title or topic of the conversation.
</ParamField>

<ParamField type="string">
  Body text of the opening message in this conversation.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the group this conversation is assigned to; the group's access level (Public, Restricted, or Private) determines who can see and contribute to it.
</ParamField>

<ParamField type="integer">
  ID of the customer profile that posted this conversation.
</ParamField>

<ParamField type="boolean">
  When true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
</ParamField>

<ParamField type="string">
  Comma-separated tags to help customers find this conversation.
</ParamField>

<ParamField type="boolean">
  When true, the conversation is visible only to customers explicitly mentioned in the message.
</ParamField>

<ParamField type="integer[]">
  IDs of users mentioned or invited as guests in this conversation.
</ParamField>

<ParamField type="boolean">
  When true, attaches a Zoom meeting invite to this conversation.
</ParamField>

<ParamField type="string">
  JSON payload containing Zoom meeting details attached to this conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/communitythreads" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "UserId": 0,
      "Subject": "",
      "Message": ""
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        UserId: 0,
        Subject: '',
        Message: ''
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/communitythreads',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'UserId': 0,
          'Subject': '',
          'Message': ''
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythread was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThread 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Subject: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Subject"
    }
  ],
  "WasSuccessful": false
}
```


# Create VideoRoom
Source: https://learn.nexudus.com/rest-api/community/post-videorooms

POST /api/community/videorooms
Create a new VideoRoom record.

A **VideoRoom** represents a virtual meeting room for video conferencing. Video rooms enable online meetings between members and can be integrated with booking resources.

## Authentication

<Note>
  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 **`VideoRoom-Create`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this video room.
</ParamField>

<ParamField type="integer">
  The number of participants value for this video room.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this video room.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current image file.
</ParamField>

<ParamField type="boolean">
  Whether this video room is currently active.
</ParamField>

<ParamField type="boolean">
  Whether only for contacts is enabled.
</ParamField>

<ParamField type="boolean">
  Whether only for members is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    "https://spaces.nexudus.com/api/community/videorooms" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "NumberOfParticipants": 0
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        NumberOfParticipants: 0
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://spaces.nexudus.com/api/community/videorooms',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'NumberOfParticipants': 0
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the videoroom was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "VideoRoom 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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityGroup
Source: https://learn.nexudus.com/rest-api/community/put-communitygroups

PUT /api/community/communitygroups
Update an existing CommunityGroup record.

Updates an existing CommunityGroup record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityGroup-Edit`** role.
</Note>

## Enums

<Accordion title="eCommunityThreadVisibility — GroupAccess values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Restricted |
  | 2     | Public     |
  | 3     | Private    |
</Accordion>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityGroup record to update.
</ParamField>

<ParamField type="integer">
  ID of the location this group belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account designated as the group administrator.
</ParamField>

<ParamField type="string">
  Display name of the group.
</ParamField>

<ParamField type="integer">
  Access level controlling who can see and post in this group's conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only.
</ParamField>

### Optional Fields

<ParamField type="string">
  Short description of the group's purpose shown to customers.
</ParamField>

<ParamField type="integer[]">
  IDs of customers who are members of this group.
</ParamField>

<ParamField type="integer[]">
  Customer IDs to add as members (used in partial updates).
</ParamField>

<ParamField type="integer[]">
  Customer IDs to remove as members (used in partial updates).
</ParamField>

<ParamField type="string">
  GUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ParamField>

<ParamField type="string">
  GUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitygroups" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "UserId": 0,
      "Name": "",
      "GroupAccess": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        UserId: 0,
        Name: '',
        GroupAccess: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitygroups',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'UserId': 0,
          'Name': '',
          'GroupAccess': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitygroup was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityGroup was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityMessageLike
Source: https://learn.nexudus.com/rest-api/community/put-communitymessagelikes

PUT /api/community/communitymessagelikes
Update an existing CommunityMessageLike record.

Updates an existing CommunityMessageLike record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityMessageLike-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityMessageLike record to update.
</ParamField>

<ParamField type="integer">
  ID of the message that was liked.
</ParamField>

<ParamField type="integer">
  ID of the user who liked the message.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitymessagelikes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "MessageId": 0,
      "UserId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessagelikes',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        MessageId: 0,
        UserId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitymessagelikes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'MessageId': 0,
          'UserId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitymessagelike was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessageLike was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityMessage
Source: https://learn.nexudus.com/rest-api/community/put-communitymessages

PUT /api/community/communitymessages
Update an existing CommunityMessage record.

Updates an existing CommunityMessage record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityMessage-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityMessage record to update.
</ParamField>

<ParamField type="integer">
  ID of the conversation this message belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account that posted this message.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the customer profile that posted this message.
</ParamField>

<ParamField type="string">
  Body text of the message.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitymessages" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CommunityThreadId": 0,
      "UserId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitymessages',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CommunityThreadId: 0,
        UserId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitymessages',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CommunityThreadId': 0,
          'UserId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitymessage was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityMessage was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityThreadFile
Source: https://learn.nexudus.com/rest-api/community/put-communitythreadfiles

PUT /api/community/communitythreadfiles
Update an existing CommunityThreadFile record.

Updates an existing CommunityThreadFile record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityThreadFile-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityThreadFile record to update.
</ParamField>

<ParamField type="integer">
  ID of the conversation this file is attached to.
</ParamField>

### Optional Fields

<ParamField type="string">
  Display name of the attached file.
</ParamField>

<ParamField type="string">
  Optional description of the attached file.
</ParamField>

<ParamField type="string">
  URL of a new file to upload and attach to this record.
</ParamField>

<ParamField type="boolean">
  When true, removes the currently attached file.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitythreadfiles" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "CommunityThreadId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfiles',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CommunityThreadId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitythreadfiles',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CommunityThreadId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadfile was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFile was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityThreadFollow
Source: https://learn.nexudus.com/rest-api/community/put-communitythreadfollows

PUT /api/community/communitythreadfollows
Update an existing CommunityThreadFollow record.

Updates an existing CommunityThreadFollow record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityThreadFollow-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityThreadFollow record to update.
</ParamField>

<ParamField type="integer">
  ID of the conversation being followed.
</ParamField>

<ParamField type="integer">
  ID of the user following the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitythreadfollows" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadfollows',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitythreadfollows',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadfollow was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadFollow was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityThreadLike
Source: https://learn.nexudus.com/rest-api/community/put-communitythreadlikes

PUT /api/community/communitythreadlikes
Update an existing CommunityThreadLike record.

Updates an existing CommunityThreadLike record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityThreadLike-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityThreadLike record to update.
</ParamField>

<ParamField type="integer">
  ID of the conversation that was liked.
</ParamField>

<ParamField type="integer">
  ID of the user who liked the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitythreadlikes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadlikes',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitythreadlikes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadlike was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadLike was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityThreadMute
Source: https://learn.nexudus.com/rest-api/community/put-communitythreadmutes

PUT /api/community/communitythreadmutes
Update an existing CommunityThreadMute record.

Updates an existing CommunityThreadMute record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityThreadMute-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityThreadMute record to update.
</ParamField>

<ParamField type="integer">
  ID of the conversation being muted.
</ParamField>

<ParamField type="integer">
  ID of the user muting the conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitythreadmutes" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "ThreadId": 0,
      "UserId": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreadmutes',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        ThreadId: 0,
        UserId: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitythreadmutes',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'ThreadId': 0,
          'UserId': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythreadmute was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThreadMute was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Update CommunityThread
Source: https://learn.nexudus.com/rest-api/community/put-communitythreads

PUT /api/community/communitythreads
Update an existing CommunityThread record.

Updates an existing CommunityThread record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`CommunityThread-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the CommunityThread record to update.
</ParamField>

<ParamField type="integer">
  ID of the location this conversation belongs to.
</ParamField>

<ParamField type="integer">
  ID of the user account that posted this conversation.
</ParamField>

<ParamField type="string">
  Title or topic of the conversation.
</ParamField>

<ParamField type="string">
  Body text of the opening message in this conversation.
</ParamField>

### Optional Fields

<ParamField type="integer">
  ID of the group this conversation is assigned to; the group's access level (Public, Restricted, or Private) determines who can see and contribute to it.
</ParamField>

<ParamField type="integer">
  ID of the customer profile that posted this conversation.
</ParamField>

<ParamField type="boolean">
  When true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
</ParamField>

<ParamField type="string">
  Comma-separated tags to help customers find this conversation.
</ParamField>

<ParamField type="boolean">
  When true, the conversation is visible only to customers explicitly mentioned in the message.
</ParamField>

<ParamField type="integer[]">
  IDs of users mentioned or invited as guests in this conversation.
</ParamField>

<ParamField type="integer[]">
  User IDs to add as guests (used in partial updates).
</ParamField>

<ParamField type="integer[]">
  User IDs to remove as guests (used in partial updates).
</ParamField>

<ParamField type="boolean">
  When true, attaches a Zoom meeting invite to this conversation.
</ParamField>

<ParamField type="string">
  JSON payload containing Zoom meeting details attached to this conversation.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/communitythreads" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "UserId": 0,
      "Subject": "",
      "Message": "",
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        UserId: 0,
        Subject: '',
        Message: '',
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/communitythreads',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'UserId': 0,
          'Subject': '',
          'Message': '',
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the communitythread was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityThread was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Subject: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Subject"
    }
  ],
  "WasSuccessful": false
}
```


# Update VideoRoom
Source: https://learn.nexudus.com/rest-api/community/put-videorooms

PUT /api/community/videorooms
Update an existing VideoRoom record.

Updates an existing VideoRoom record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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 **`VideoRoom-Edit`** role.
</Note>

## Request Body

### Required Fields

<ParamField type="integer">
  The Id of the VideoRoom record to update.
</ParamField>

<ParamField type="integer">
  ID of the business linked to this record.
</ParamField>

<ParamField type="string">
  The name value for this video room.
</ParamField>

<ParamField type="integer">
  The number of participants value for this video room.
</ParamField>

### Optional Fields

<ParamField type="string">
  Free-text description of this video room.
</ParamField>

<ParamField type="string">
  URL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Set to true to remove the current image file.
</ParamField>

<ParamField type="boolean">
  Whether this video room is currently active.
</ParamField>

<ParamField type="boolean">
  Whether only for contacts is enabled.
</ParamField>

<ParamField type="boolean">
  Whether only for members is enabled.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/community/videorooms" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "Name": "",
      "NumberOfParticipants": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/videorooms',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        BusinessId: 0,
        Name: '',
        NumberOfParticipants: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/community/videorooms',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'Name': '',
          'NumberOfParticipants': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the videoroom was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "VideoRoom was successfully updated.",
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```


# Delete AudioFile
Source: https://learn.nexudus.com/rest-api/content/delete-audiofiles-by-id

DELETE /api/content/audiofiles/{id}
Delete an existing AudioFile record by its Id.

Deletes a AudioFile record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`AudioFile-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the AudioFile record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/audiofiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/audiofiles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "AudioFile was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete BlogCategory
Source: https://learn.nexudus.com/rest-api/content/delete-blogcategories-by-id

DELETE /api/content/blogcategories/{id}
Delete an existing BlogCategory record by its Id.

Deletes a BlogCategory record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BlogCategory-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogCategory record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/blogcategories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/blogcategories/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BlogCategory was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete BlogPostComment
Source: https://learn.nexudus.com/rest-api/content/delete-blogpostcomments-by-id

DELETE /api/content/blogpostcomments/{id}
Delete an existing BlogPostComment record by its Id.

Deletes a BlogPostComment record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BlogPostComment-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogPostComment record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/blogpostcomments/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/blogpostcomments/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BlogPostComment was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete BlogPost
Source: https://learn.nexudus.com/rest-api/content/delete-blogposts-by-id

DELETE /api/content/blogposts/{id}
Delete an existing BlogPost record by its Id.

Deletes a BlogPost record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BlogPost-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogPost record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/blogposts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/blogposts/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BlogPost was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete BusinessAnnouncement
Source: https://learn.nexudus.com/rest-api/content/delete-businessannouncements-by-id

DELETE /api/content/businessannouncements/{id}
Delete an existing BusinessAnnouncement record by its Id.

Deletes a BusinessAnnouncement record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`BusinessAnnouncement-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BusinessAnnouncement record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/businessannouncements/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/businessannouncements/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "BusinessAnnouncement was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CalendarEventCategory
Source: https://learn.nexudus.com/rest-api/content/delete-calendareventcategories-by-id

DELETE /api/content/calendareventcategories/{id}
Delete an existing CalendarEventCategory record by its Id.

Deletes a CalendarEventCategory record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CalendarEventCategory-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CalendarEventCategory record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/calendareventcategories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/calendareventcategories/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CalendarEventCategory was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CalendarEvent
Source: https://learn.nexudus.com/rest-api/content/delete-calendarevents-by-id

DELETE /api/content/calendarevents/{id}
Delete an existing CalendarEvent record by its Id.

Deletes a CalendarEvent record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CalendarEvent-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CalendarEvent record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/calendarevents/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/calendarevents/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CalendarEvent was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CommunityPerk
Source: https://learn.nexudus.com/rest-api/content/delete-communityperks-by-id

DELETE /api/content/communityperks/{id}
Delete an existing CommunityPerk record by its Id.

Deletes a CommunityPerk record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CommunityPerk-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityPerk record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/communityperks/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/communityperks/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CommunityPerk was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CourseCompletedLesson
Source: https://learn.nexudus.com/rest-api/content/delete-coursecompletedlessons-by-id

DELETE /api/content/coursecompletedlessons/{id}
Delete an existing CourseCompletedLesson record by its Id.

Deletes a CourseCompletedLesson record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CourseCompletedLesson-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseCompletedLesson record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/coursecompletedlessons/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CourseCompletedLesson was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CourseLesson
Source: https://learn.nexudus.com/rest-api/content/delete-courselessons-by-id

DELETE /api/content/courselessons/{id}
Delete an existing CourseLesson record by its Id.

Deletes a CourseLesson record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CourseLesson-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseLesson record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/courselessons/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/courselessons/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CourseLesson was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CourseMember
Source: https://learn.nexudus.com/rest-api/content/delete-coursemembers-by-id

DELETE /api/content/coursemembers/{id}
Delete an existing CourseMember record by its Id.

Deletes a CourseMember record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CourseMember-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseMember record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/coursemembers/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/coursemembers/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CourseMember was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Course
Source: https://learn.nexudus.com/rest-api/content/delete-courses-by-id

DELETE /api/content/courses/{id}
Delete an existing Course record by its Id.

Deletes a Course record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Course-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Course record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/courses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/courses/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Course was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete CourseSection
Source: https://learn.nexudus.com/rest-api/content/delete-coursesections-by-id

DELETE /api/content/coursesections/{id}
Delete an existing CourseSection record by its Id.

Deletes a CourseSection record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`CourseSection-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseSection record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/coursesections/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/coursesections/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CourseSection was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete DataFile
Source: https://learn.nexudus.com/rest-api/content/delete-datafiles-by-id

DELETE /api/content/datafiles/{id}
Delete an existing DataFile record by its Id.

Deletes a DataFile record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`DataFile-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the DataFile record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/datafiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/datafiles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "DataFile was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete EventAttendee
Source: https://learn.nexudus.com/rest-api/content/delete-eventattendees-by-id

DELETE /api/content/eventattendees/{id}
Delete an existing EventAttendee record by its Id.

Deletes a EventAttendee record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`EventAttendee-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the EventAttendee record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/eventattendees/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventattendees/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/eventattendees/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "EventAttendee was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete EventComment
Source: https://learn.nexudus.com/rest-api/content/delete-eventcomments-by-id

DELETE /api/content/eventcomments/{id}
Delete an existing EventComment record by its Id.

Deletes a EventComment record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`EventComment-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the EventComment record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/eventcomments/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventcomments/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/eventcomments/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "EventComment was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete EventProduct
Source: https://learn.nexudus.com/rest-api/content/delete-eventproducts-by-id

DELETE /api/content/eventproducts/{id}
Delete an existing EventProduct record by its Id.

Deletes a EventProduct record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`EventProduct-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the EventProduct record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/eventproducts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventproducts/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/eventproducts/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "EventProduct was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete EventWaitingAttendee
Source: https://learn.nexudus.com/rest-api/content/delete-eventwaitingattendees-by-id

DELETE /api/content/eventwaitingattendees/{id}
Delete an existing EventWaitingAttendee record by its Id.

Deletes a EventWaitingAttendee record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`EventWaitingAttendee-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the EventWaitingAttendee record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/eventwaitingattendees/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventwaitingattendees/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/eventwaitingattendees/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "EventWaitingAttendee was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete FaqArticle
Source: https://learn.nexudus.com/rest-api/content/delete-faqarticles-by-id

DELETE /api/content/faqarticles/{id}
Delete an existing FaqArticle record by its Id.

Deletes a FaqArticle record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`FaqArticle-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FaqArticle record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/faqarticles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/faqarticles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/faqarticles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FaqArticle was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete FormPageQuestion
Source: https://learn.nexudus.com/rest-api/content/delete-formpagequestions-by-id

DELETE /api/content/formpagequestions/{id}
Delete an existing FormPageQuestion record by its Id.

Deletes a FormPageQuestion record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`FormPageQuestion-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FormPageQuestion record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/formpagequestions/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/formpagequestions/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/formpagequestions/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FormPageQuestion was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete FormPageRequest
Source: https://learn.nexudus.com/rest-api/content/delete-formpagerequests-by-id

DELETE /api/content/formpagerequests/{id}
Delete an existing FormPageRequest record by its Id.

Deletes a FormPageRequest record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`FormPageRequest-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FormPageRequest record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/formpagerequests/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/formpagerequests/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/formpagerequests/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FormPageRequest was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete FormPage
Source: https://learn.nexudus.com/rest-api/content/delete-formpages-by-id

DELETE /api/content/formpages/{id}
Delete an existing FormPage record by its Id.

Deletes a FormPage record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`FormPage-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the FormPage record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/formpages/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/formpages/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/formpages/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "FormPage was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete ImageFile
Source: https://learn.nexudus.com/rest-api/content/delete-imagefiles-by-id

DELETE /api/content/imagefiles/{id}
Delete an existing ImageFile record by its Id.

Deletes a ImageFile record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`ImageFile-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the ImageFile record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/imagefiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/imagefiles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/imagefiles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "ImageFile was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete NewsLetter
Source: https://learn.nexudus.com/rest-api/content/delete-newsletters-by-id

DELETE /api/content/newsletters/{id}
Delete an existing NewsLetter record by its Id.

Deletes a NewsLetter record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`NewsLetter-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the NewsLetter record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/newsletters/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/newsletters/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/newsletters/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "NewsLetter was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete NewsLetterSubscriber
Source: https://learn.nexudus.com/rest-api/content/delete-newslettersubscribers-by-id

DELETE /api/content/newslettersubscribers/{id}
Delete an existing NewsLetterSubscriber record by its Id.

Deletes a NewsLetterSubscriber record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`NewsLetterSubscriber-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the NewsLetterSubscriber record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/newslettersubscribers/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/newslettersubscribers/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/newslettersubscribers/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "NewsLetterSubscriber was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete SubscriberGroup
Source: https://learn.nexudus.com/rest-api/content/delete-subscribergroups-by-id

DELETE /api/content/subscribergroups/{id}
Delete an existing SubscriberGroup record by its Id.

Deletes a SubscriberGroup record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`SubscriberGroup-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the SubscriberGroup record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/subscribergroups/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/subscribergroups/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/subscribergroups/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "SubscriberGroup was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete SurveyAnswer
Source: https://learn.nexudus.com/rest-api/content/delete-surveyanswers-by-id

DELETE /api/content/surveyanswers/{id}
Delete an existing SurveyAnswer record by its Id.

Deletes a SurveyAnswer record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`SurveyAnswer-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the SurveyAnswer record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/surveyanswers/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/surveyanswers/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/surveyanswers/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "SurveyAnswer was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete SurveyQuestion
Source: https://learn.nexudus.com/rest-api/content/delete-surveyquestions-by-id

DELETE /api/content/surveyquestions/{id}
Delete an existing SurveyQuestion record by its Id.

Deletes a SurveyQuestion record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`SurveyQuestion-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the SurveyQuestion record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/surveyquestions/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/surveyquestions/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/surveyquestions/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "SurveyQuestion was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete SurveyRun
Source: https://learn.nexudus.com/rest-api/content/delete-surveyruns-by-id

DELETE /api/content/surveyruns/{id}
Delete an existing SurveyRun record by its Id.

Deletes a SurveyRun record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`SurveyRun-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the SurveyRun record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/surveyruns/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/surveyruns/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/surveyruns/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "SurveyRun was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete Survey
Source: https://learn.nexudus.com/rest-api/content/delete-surveys-by-id

DELETE /api/content/surveys/{id}
Delete an existing Survey record by its Id.

Deletes a Survey record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`Survey-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Survey record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/surveys/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/surveys/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/surveys/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Survey was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Delete VideoFile
Source: https://learn.nexudus.com/rest-api/content/delete-videofiles-by-id

DELETE /api/content/videofiles/{id}
Delete an existing VideoFile record by its Id.

Deletes a VideoFile record. Once deleted, the record is permanently removed from the system.

<Warning>
  This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.
</Warning>

## Authentication

<Note>
  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 **`VideoFile-Delete`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the VideoFile record to delete.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE \
    "https://spaces.nexudus.com/api/content/videofiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/videofiles/87654321',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      'https://spaces.nexudus.com/api/content/videofiles/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the deletion.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the deleted record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the deletion was successful.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "VideoFile was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 500

```json Example Response theme={null}
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}
```


# Search AudioFiles
Source: https://learn.nexudus.com/rest-api/content/get-audiofiles

GET /api/content/audiofiles
Search and list AudioFile records with filtering, sorting, and pagination.

Represents a valid audio file stored in the Nexudus account. These can be used in document templates, newsletters or custom pages in the Members Portal and app.

## Authentication

<Note>
  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 **`AudioFile-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by name of the audio file.
</ParamField>

<ParamField type="string">
  Filter by description of the audio file.
</ParamField>

<ParamField type="string">
  Filter by current file name of the audio (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the audio.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current audio file.
</ParamField>

<ParamField type="integer">
  Filter by file size in bytes.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by file size in bytes greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by file size in bytes less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/audiofiles?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/audiofiles',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/audiofiles?AudioFile_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles?' + new URLSearchParams({
      AudioFile_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/audiofiles',
      params={
          'AudioFile_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/audiofiles?from_AudioFile_UpdatedOn=2025-01-01T00:00&to_AudioFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles?' + new URLSearchParams({
      from_AudioFile_UpdatedOn: '2025-01-01T00:00',
      to_AudioFile_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/audiofiles',
      params={
          'from_AudioFile_UpdatedOn': '2025-01-01T00:00',
          'to_AudioFile_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="AudioFile[]">
  The list of AudioFile records matching the query. See the [Get one AudioFile](/rest-api/content/get-audiofiles-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Description": null,
      "AudioFileName": null,
      "NewAudioUrl": null,
      "ClearAudioFile": null,
      "FileSizeBytes": 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": "AudioFile Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple AudioFiles
Source: https://learn.nexudus.com/rest-api/content/get-audiofiles-batch

GET /api/content/audiofiles/?id=[{id1},{id2},{id3}]
Retrieve multiple AudioFile records by their Ids in a single request.

Fetch several AudioFile records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`AudioFile-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of AudioFile Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/audiofiles/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/audiofiles/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of AudioFile records. Each record has the same structure as the response from the [Get one AudioFile](/rest-api/content/get-audiofiles-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "Description": null,
    "AudioFileName": null,
    "NewAudioUrl": null,
    "ClearAudioFile": null,
    "FileSizeBytes": 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": "AudioFile Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one AudioFile
Source: https://learn.nexudus.com/rest-api/content/get-audiofiles-by-id

GET /api/content/audiofiles/{id}
Retrieve a single AudioFile record by its Id.

Represents a valid audio file stored in the Nexudus account. These can be used in document templates, newsletters or custom pages in the Members Portal and app.

## Authentication

<Note>
  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 **`AudioFile-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the AudioFile record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/audiofiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/audiofiles/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Name of the audio file.
</ResponseField>

<ResponseField name="Description" type="string">
  Description of the audio file.
</ResponseField>

<ResponseField name="AudioFileName" type="string">
  Current file name of the audio (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewAudioUrl" type="string">
  URL of a new file to upload as the audio.
</ResponseField>

<ResponseField name="ClearAudioFile" type="boolean">
  Set to true to remove the current audio file.
</ResponseField>

<ResponseField name="FileSizeBytes" type="integer">
  File size in bytes.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "AudioFileName": null,
  "NewAudioUrl": null,
  "ClearAudioFile": null,
  "FileSizeBytes": 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": "AudioFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search BlogCategories
Source: https://learn.nexudus.com/rest-api/content/get-blogcategories

GET /api/content/blogcategories
Search and list BlogCategory records with filtering, sorting, and pagination.

A **BlogCategory** groups blog posts into named categories within a location. Each category belongs to a single `Business` and has a `Title` used for display and filtering.

Categories can optionally be associated with a `Language` to support multilingual blogs. Use the `BlogPosts`, `AddedBlogPosts`, and `RemovedBlogPosts` collections to manage which blog posts belong to the category.

## Authentication

<Note>
  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 **`BlogCategory-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the language linked to this record.
</ParamField>

<ParamField type="string">
  Filter by category title.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogcategories?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogcategories',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogcategories?BlogCategory_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories?' + new URLSearchParams({
      BlogCategory_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogcategories',
      params={
          'BlogCategory_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogcategories?from_BlogCategory_UpdatedOn=2025-01-01T00:00&to_BlogCategory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories?' + new URLSearchParams({
      from_BlogCategory_UpdatedOn: '2025-01-01T00:00',
      to_BlogCategory_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogcategories',
      params={
          'from_BlogCategory_UpdatedOn': '2025-01-01T00:00',
          'to_BlogCategory_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BlogCategory[]">
  The list of BlogCategory records matching the query. See the [Get one BlogCategory](/rest-api/content/get-blogcategories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "LanguageId": null,
      "Title": "",
      "BlogPosts": [],
      "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": "BlogCategory Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BlogCategories
Source: https://learn.nexudus.com/rest-api/content/get-blogcategories-batch

GET /api/content/blogcategories/?id=[{id1},{id2},{id3}]
Retrieve multiple BlogCategory records by their Ids in a single request.

Fetch several BlogCategory records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BlogCategory-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BlogCategory Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogcategories/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogcategories/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BlogCategory records. Each record has the same structure as the response from the [Get one BlogCategory](/rest-api/content/get-blogcategories-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "LanguageId": null,
    "Title": "",
    "BlogPosts": [],
    "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": "BlogCategory Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BlogCategory
Source: https://learn.nexudus.com/rest-api/content/get-blogcategories-by-id

GET /api/content/blogcategories/{id}
Retrieve a single BlogCategory record by its Id.

A **BlogCategory** groups blog posts into named categories within a location. Each category belongs to a single `Business` and has a `Title` used for display and filtering.

Categories can optionally be associated with a `Language` to support multilingual blogs. Use the `BlogPosts`, `AddedBlogPosts`, and `RemovedBlogPosts` collections to manage which blog posts belong to the category.

## Authentication

<Note>
  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 **`BlogCategory-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogCategory record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogcategories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogcategories/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="LanguageId" type="integer">
  ID of the language linked to this record.
</ResponseField>

<ResponseField name="Title" type="string">
  Category title.
</ResponseField>

<ResponseField name="BlogPosts" type="integer[]">
  List of blog posts linked to this record.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "LanguageId": null,
  "Title": "",
  "BlogPosts": [],
  "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": "BlogCategory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search BlogPostComments
Source: https://learn.nexudus.com/rest-api/content/get-blogpostcomments

GET /api/content/blogpostcomments
Search and list BlogPostComment records with filtering, sorting, and pagination.

A **BlogPostComment** represents a comment left on a `BlogPost`. Each comment belongs to a specific blog post via `BlogPostId`.

Comments have a `Title` and `Text` body, and can optionally include a `Rating`. The `Published` flag controls whether the comment is visible to readers — use this for moderation. The `PostedById` links the comment to the `Coworker` who authored it.

## Authentication

<Note>
  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 **`BlogPostComment-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the blog post linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the posted by linked to this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the coworker who posted the comment.
</ParamField>

<ParamField type="string">
  Filter by comment title.
</ParamField>

<ParamField type="string">
  Filter by comment body text.
</ParamField>

<ParamField type="boolean">
  Filter by whether the comment is published and visible to readers.
</ParamField>

<ParamField type="integer">
  Filter by optional rating given by the commenter.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by optional rating given by the commenter greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by optional rating given by the commenter less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogpostcomments?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogpostcomments',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogpostcomments?BlogPostComment_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments?' + new URLSearchParams({
      BlogPostComment_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogpostcomments',
      params={
          'BlogPostComment_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogpostcomments?from_BlogPostComment_UpdatedOn=2025-01-01T00:00&to_BlogPostComment_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments?' + new URLSearchParams({
      from_BlogPostComment_UpdatedOn: '2025-01-01T00:00',
      to_BlogPostComment_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogpostcomments',
      params={
          'from_BlogPostComment_UpdatedOn': '2025-01-01T00:00',
          'to_BlogPostComment_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BlogPostComment[]">
  The list of BlogPostComment records matching the query. See the [Get one BlogPostComment](/rest-api/content/get-blogpostcomments-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BlogPostId": 0,
      "PostedById": null,
      "PostedByFullName": null,
      "Title": "",
      "Text": "",
      "Published": false,
      "Rating": 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": "BlogPostComment Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BlogPostComments
Source: https://learn.nexudus.com/rest-api/content/get-blogpostcomments-batch

GET /api/content/blogpostcomments/?id=[{id1},{id2},{id3}]
Retrieve multiple BlogPostComment records by their Ids in a single request.

Fetch several BlogPostComment records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BlogPostComment-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BlogPostComment Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogpostcomments/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogpostcomments/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BlogPostComment records. Each record has the same structure as the response from the [Get one BlogPostComment](/rest-api/content/get-blogpostcomments-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BlogPostId": 0,
    "PostedById": null,
    "PostedByFullName": null,
    "Title": "",
    "Text": "",
    "Published": false,
    "Rating": 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": "BlogPostComment Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BlogPostComment
Source: https://learn.nexudus.com/rest-api/content/get-blogpostcomments-by-id

GET /api/content/blogpostcomments/{id}
Retrieve a single BlogPostComment record by its Id.

A **BlogPostComment** represents a comment left on a `BlogPost`. Each comment belongs to a specific blog post via `BlogPostId`.

Comments have a `Title` and `Text` body, and can optionally include a `Rating`. The `Published` flag controls whether the comment is visible to readers — use this for moderation. The `PostedById` links the comment to the `Coworker` who authored it.

## Authentication

<Note>
  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 **`BlogPostComment-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogPostComment record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogpostcomments/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogpostcomments/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BlogPostId" type="integer">
  ID of the blog post linked to this record.
</ResponseField>

<ResponseField name="PostedById" type="integer">
  ID of the posted by linked to this record.
</ResponseField>

<ResponseField name="PostedByFullName" type="string">
  Full name of the coworker who posted the comment.
</ResponseField>

<ResponseField name="Title" type="string">
  Comment title.
</ResponseField>

<ResponseField name="Text" type="string">
  Comment body text.
</ResponseField>

<ResponseField name="Published" type="boolean">
  Whether the comment is published and visible to readers.
</ResponseField>

<ResponseField name="Rating" type="integer">
  Optional rating given by the commenter.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BlogPostId": 0,
  "PostedById": null,
  "PostedByFullName": null,
  "Title": "",
  "Text": "",
  "Published": false,
  "Rating": 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": "BlogPostComment Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search BlogPosts
Source: https://learn.nexudus.com/rest-api/content/get-blogposts

GET /api/content/blogposts
Search and list BlogPost records with filtering, sorting, and pagination.

A **BlogPost** represents an article published on the Members Portal. Articles can be used to share news, updates, or useful content with customers.

Articles support scheduled publishing via `PublishDate` and automatic unpublishing via `UnpublishDate`. Setting a `PublishDate` in the past publishes the article immediately; setting a future date schedules it. Leaving `UnpublishDate` blank keeps the article published until it is manually unpublished or deleted.

Each article has a `SummaryText` (short overview displayed at the top) and a `FullText` (the main body content). Articles can be organised into categories using the `BlogCategory` entity and can optionally allow customer comments.

Visibility can be controlled with `OnlyForMembers` (customers with an active contract) and `OnlyForContacts` (customers without an active contract). Articles can also be featured on the Members Portal home page before login (`ShowInHomeBanner`) or after login (`ShowInHomePage`).

## Authentication

<Note>
  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 **`BlogPost-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the language linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the posted by linked to this record.
</ParamField>

<ParamField type="string">
  Filter by full name of the article author.
</ParamField>

<ParamField type="string">
  Filter by article title.
</ParamField>

<ParamField type="string">
  Filter by short overview displayed at the top of the article.
</ParamField>

<ParamField type="string">
  Filter by main body content of the article.
</ParamField>

<ParamField type="string">
  Filter by current file name of the image (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the image.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current image file.
</ParamField>

<ParamField type="string">
  Filter by current file name of the large image (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new file to upload as the large image.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current large image file.
</ParamField>

<ParamField type="string">
  Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication.
</ParamField>

<ParamField type="boolean">
  Filter by feature this article on the Members Portal home page before users log in.
</ParamField>

<ParamField type="boolean">
  Filter by feature this article on the Members Portal home page after users log in.
</ParamField>

<ParamField type="string">
  Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
</ParamField>

<ParamField type="boolean">
  Filter by whether customers can post comments on this article.
</ParamField>

<ParamField type="integer">
  Filter by number of comments on this article.
</ParamField>

<ParamField type="boolean">
  Filter by restrict visibility to contacts (customers without an active contract).
</ParamField>

<ParamField type="boolean">
  Filter by restrict visibility to members (customers with an active contract).
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when the article is published. Past dates publish immediately; future dates schedule publication less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time when the article is automatically unpublished. Leave blank to keep published indefinitely less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of comments on this article greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of comments on this article less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogposts?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogposts',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogposts?BlogPost_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts?' + new URLSearchParams({
      BlogPost_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogposts',
      params={
          'BlogPost_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogposts?from_BlogPost_UpdatedOn=2025-01-01T00:00&to_BlogPost_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts?' + new URLSearchParams({
      from_BlogPost_UpdatedOn: '2025-01-01T00:00',
      to_BlogPost_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogposts',
      params={
          'from_BlogPost_UpdatedOn': '2025-01-01T00:00',
          'to_BlogPost_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BlogPost[]">
  The list of BlogPost records matching the query. See the [Get one BlogPost](/rest-api/content/get-blogposts-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each BlogPost. The following fields are **not populated** in the `Records[]` response: `FullText`, `ShowInHomeBanner`, `ShowInHomePage`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one BlogPost](/rest-api/content/get-blogposts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "LanguageId": null,
      "PostedById": null,
      "PostedByFullName": null,
      "Title": "",
      "SummaryText": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "PublishDate": null,
      "UnpublishDate": null,
      "AllowComments": false,
      "BlogCategories": [],
      "CommentsCount": 0,
      "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": "BlogPost Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BlogPosts
Source: https://learn.nexudus.com/rest-api/content/get-blogposts-batch

GET /api/content/blogposts/?id=[{id1},{id2},{id3}]
Retrieve multiple BlogPost records by their Ids in a single request.

Fetch several BlogPost records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BlogPost-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BlogPost Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogposts/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/blogposts/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BlogPost records. Each record has the same structure as the response from the [Get one BlogPost](/rest-api/content/get-blogposts-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each BlogPost. The following fields are **not populated** in the response: `FullText`, `ShowInHomeBanner`, `ShowInHomePage`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one BlogPost](/rest-api/content/get-blogposts-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "LanguageId": null,
    "PostedById": null,
    "PostedByFullName": null,
    "Title": "",
    "SummaryText": null,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "LargeImageFileName": null,
    "NewLargeImageUrl": null,
    "ClearLargeImageFile": null,
    "PublishDate": null,
    "UnpublishDate": null,
    "AllowComments": false,
    "BlogCategories": [],
    "CommentsCount": 0,
    "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": "BlogPost Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BlogPost
Source: https://learn.nexudus.com/rest-api/content/get-blogposts-by-id

GET /api/content/blogposts/{id}
Retrieve a single BlogPost record by its Id.

A **BlogPost** represents an article published on the Members Portal. Articles can be used to share news, updates, or useful content with customers.

Articles support scheduled publishing via `PublishDate` and automatic unpublishing via `UnpublishDate`. Setting a `PublishDate` in the past publishes the article immediately; setting a future date schedules it. Leaving `UnpublishDate` blank keeps the article published until it is manually unpublished or deleted.

Each article has a `SummaryText` (short overview displayed at the top) and a `FullText` (the main body content). Articles can be organised into categories using the `BlogCategory` entity and can optionally allow customer comments.

Visibility can be controlled with `OnlyForMembers` (customers with an active contract) and `OnlyForContacts` (customers without an active contract). Articles can also be featured on the Members Portal home page before login (`ShowInHomeBanner`) or after login (`ShowInHomePage`).

## Authentication

<Note>
  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 **`BlogPost-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BlogPost record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/blogposts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/blogposts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="LanguageId" type="integer">
  ID of the language linked to this record.
</ResponseField>

<ResponseField name="PostedById" type="integer">
  ID of the posted by linked to this record.
</ResponseField>

<ResponseField name="PostedByFullName" type="string">
  Full name of the article author.
</ResponseField>

<ResponseField name="Title" type="string">
  Article title.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short overview displayed at the top of the article.
</ResponseField>

<ResponseField name="FullText" type="string">
  Main body content of the article.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current file name of the image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new file to upload as the image.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current image file.
</ResponseField>

<ResponseField name="LargeImageFileName" type="string">
  Current file name of the large image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewLargeImageUrl" type="string">
  URL of a new file to upload as the large image.
</ResponseField>

<ResponseField name="ClearLargeImageFile" type="boolean">
  Set to true to remove the current large image file.
</ResponseField>

<ResponseField name="PublishDate" type="string">
  Date and time when the article is published. Past dates publish immediately; future dates schedule publication.
</ResponseField>

<ResponseField name="ShowInHomeBanner" type="boolean">
  Feature this article on the Members Portal home page before users log in.
</ResponseField>

<ResponseField name="ShowInHomePage" type="boolean">
  Feature this article on the Members Portal home page after users log in.
</ResponseField>

<ResponseField name="UnpublishDate" type="string">
  Date and time when the article is automatically unpublished. Leave blank to keep published indefinitely.
</ResponseField>

<ResponseField name="AllowComments" type="boolean">
  Whether customers can post comments on this article.
</ResponseField>

<ResponseField name="BlogCategories" type="integer[]">
  List of blog categories linked to this record.
</ResponseField>

<ResponseField name="CommentsCount" type="integer">
  Number of comments on this article.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Restrict visibility to contacts (customers without an active contract).
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Restrict visibility to members (customers with an active contract).
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "LanguageId": null,
  "PostedById": null,
  "PostedByFullName": null,
  "Title": "",
  "SummaryText": null,
  "FullText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "PublishDate": null,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "UnpublishDate": null,
  "AllowComments": false,
  "BlogCategories": [],
  "CommentsCount": 0,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "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": "BlogPost Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search BusinessAnnouncements
Source: https://learn.nexudus.com/rest-api/content/get-businessannouncements

GET /api/content/businessannouncements
Search and list BusinessAnnouncement records with filtering, sorting, and pagination.

A **BusinessAnnouncement** is a notification displayed to customers on the members portal and mobile app. Announcements support plain text only (no bold, italics, or lists) and can include an optional image and a call-to-action button.

Use `ActiveFrom` and `ActiveTo` to schedule when the announcement is visible. Use `OnlyForContacts` and `OnlyForMembers` to control the audience:

| OnlyForContacts | OnlyForMembers | Audience                               |
| --------------- | -------------- | -------------------------------------- |
| false           | false          | All customers (contacts and members)   |
| true            | false          | Contacts only (no active contract)     |
| false           | true           | Members only (with an active contract) |

Announcement images should ideally be 600x350 pixels (12:7 aspect ratio). Set `NewImageUrl` to a URL to upload a new image, or set `ClearImage` to true to remove the current image.

## Authentication

<Note>
  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 **`BusinessAnnouncement-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by business name.
</ParamField>

<ParamField type="string">
  Filter by announcement title.
</ParamField>

<ParamField type="boolean">
  Filter by whether the announcement is active and visible to customers.
</ParamField>

<ParamField type="string">
  Filter by current image file name.
</ParamField>

<ParamField type="string">
  Filter by uRL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current image file.
</ParamField>

<ParamField type="string">
  Filter by announcement body text (plain text only, no formatting).
</ParamField>

<ParamField type="boolean">
  Filter by whether to display a call-to-action button in the announcement.
</ParamField>

<ParamField type="string">
  Filter by text displayed on the call-to-action button.
</ParamField>

<ParamField type="string">
  Filter by uRL the call-to-action button redirects to (must start with https\://).
</ParamField>

<ParamField type="boolean">
  Filter by whether to send a push notification to customers when the announcement is published.
</ParamField>

<ParamField type="string">
  Filter by text of the push notification sent to customers.
</ParamField>

<ParamField type="string">
  Filter by date from which the announcement is visible to customers (publish from).
</ParamField>

<ParamField type="string">
  Filter by date until which the announcement is visible to customers (publish to).
</ParamField>

<ParamField type="boolean">
  Filter by restrict announcement visibility to contacts (customers without an active contract).
</ParamField>

<ParamField type="boolean">
  Filter by restrict announcement visibility to members (customers with an active contract).
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date from which the announcement is visible to customers (publish from) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date from which the announcement is visible to customers (publish from) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which the announcement is visible to customers (publish to) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date until which the announcement is visible to customers (publish to) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/businessannouncements?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/businessannouncements',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/businessannouncements?BusinessAnnouncement_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
      BusinessAnnouncement_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/businessannouncements',
      params={
          'BusinessAnnouncement_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/businessannouncements?from_BusinessAnnouncement_UpdatedOn=2025-01-01T00:00&to_BusinessAnnouncement_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
      from_BusinessAnnouncement_UpdatedOn: '2025-01-01T00:00',
      to_BusinessAnnouncement_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/businessannouncements',
      params={
          'from_BusinessAnnouncement_UpdatedOn': '2025-01-01T00:00',
          'to_BusinessAnnouncement_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="BusinessAnnouncement[]">
  The list of BusinessAnnouncement records matching the query. See the [Get one BusinessAnnouncement](/rest-api/content/get-businessannouncements-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each BusinessAnnouncement. The following fields are **not populated** in the `Records[]` response: `Body`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one BusinessAnnouncement](/rest-api/content/get-businessannouncements-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "Active": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "ShowButton": false,
      "ButtonLabel": null,
      "ButtonUrl": null,
      "SendPushNotification": false,
      "PushNotificationText": null,
      "ActiveFrom": null,
      "ActiveTo": 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": "BusinessAnnouncement Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple BusinessAnnouncements
Source: https://learn.nexudus.com/rest-api/content/get-businessannouncements-batch

GET /api/content/businessannouncements/?id=[{id1},{id2},{id3}]
Retrieve multiple BusinessAnnouncement records by their Ids in a single request.

Fetch several BusinessAnnouncement records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`BusinessAnnouncement-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of BusinessAnnouncement Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/businessannouncements/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/businessannouncements/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of BusinessAnnouncement records. Each record has the same structure as the response from the [Get one BusinessAnnouncement](/rest-api/content/get-businessannouncements-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each BusinessAnnouncement. The following fields are **not populated** in the response: `Body`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one BusinessAnnouncement](/rest-api/content/get-businessannouncements-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "Name": "",
    "Active": false,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "ShowButton": false,
    "ButtonLabel": null,
    "ButtonUrl": null,
    "SendPushNotification": false,
    "PushNotificationText": null,
    "ActiveFrom": null,
    "ActiveTo": 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": "BusinessAnnouncement Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one BusinessAnnouncement
Source: https://learn.nexudus.com/rest-api/content/get-businessannouncements-by-id

GET /api/content/businessannouncements/{id}
Retrieve a single BusinessAnnouncement record by its Id.

A **BusinessAnnouncement** is a notification displayed to customers on the members portal and mobile app. Announcements support plain text only (no bold, italics, or lists) and can include an optional image and a call-to-action button.

Use `ActiveFrom` and `ActiveTo` to schedule when the announcement is visible. Use `OnlyForContacts` and `OnlyForMembers` to control the audience:

| OnlyForContacts | OnlyForMembers | Audience                               |
| --------------- | -------------- | -------------------------------------- |
| false           | false          | All customers (contacts and members)   |
| true            | false          | Contacts only (no active contract)     |
| false           | true           | Members only (with an active contract) |

Announcement images should ideally be 600x350 pixels (12:7 aspect ratio). Set `NewImageUrl` to a URL to upload a new image, or set `ClearImage` to true to remove the current image.

## Authentication

<Note>
  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 **`BusinessAnnouncement-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the BusinessAnnouncement record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/businessannouncements/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Announcement title.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the announcement is active and visible to customers.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current image file name.
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current image file.
</ResponseField>

<ResponseField name="Body" type="string">
  Announcement body text (plain text only, no formatting).
</ResponseField>

<ResponseField name="ShowButton" type="boolean">
  Whether to display a call-to-action button in the announcement.
</ResponseField>

<ResponseField name="ButtonLabel" type="string">
  Text displayed on the call-to-action button.
</ResponseField>

<ResponseField name="ButtonUrl" type="string">
  URL the call-to-action button redirects to (must start with https\://).
</ResponseField>

<ResponseField name="SendPushNotification" type="boolean">
  Whether to send a push notification to customers when the announcement is published.
</ResponseField>

<ResponseField name="PushNotificationText" type="string">
  Text of the push notification sent to customers.
</ResponseField>

<ResponseField name="ActiveFrom" type="string">
  Date from which the announcement is visible to customers (publish from).
</ResponseField>

<ResponseField name="ActiveTo" type="string">
  Date until which the announcement is visible to customers (publish to).
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Restrict announcement visibility to contacts (customers without an active contract).
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Restrict announcement visibility to members (customers with an active contract).
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "Active": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "Body": null,
  "ShowButton": false,
  "ButtonLabel": null,
  "ButtonUrl": null,
  "SendPushNotification": false,
  "PushNotificationText": null,
  "ActiveFrom": null,
  "ActiveTo": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "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": "BusinessAnnouncement Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CalendarEventCategories
Source: https://learn.nexudus.com/rest-api/content/get-calendareventcategories

GET /api/content/calendareventcategories
Search and list CalendarEventCategory records with filtering, sorting, and pagination.

A **CalendarEventCategory** groups events by type or theme within a location. Categories appear as filters on the Events page of the Members Portal, letting customers quickly find relevant events. Events that share the same category are also shown as related events when a customer views the detail page of a specific event.

Assign categories to events via the `EventCategories` list on the `CalendarEvent` entity.

## Authentication

<Note>
  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 **`CalendarEventCategory-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by the location this event category belongs to.
</ParamField>

<ParamField type="string">
  Filter by category name shown as a filter on the Members Portal.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendareventcategories?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendareventcategories',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendareventcategories?CalendarEventCategory_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories?' + new URLSearchParams({
      CalendarEventCategory_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendareventcategories',
      params={
          'CalendarEventCategory_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendareventcategories?from_CalendarEventCategory_UpdatedOn=2025-01-01T00:00&to_CalendarEventCategory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories?' + new URLSearchParams({
      from_CalendarEventCategory_UpdatedOn: '2025-01-01T00:00',
      to_CalendarEventCategory_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendareventcategories',
      params={
          'from_CalendarEventCategory_UpdatedOn': '2025-01-01T00:00',
          'to_CalendarEventCategory_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CalendarEventCategory[]">
  The list of CalendarEventCategory records matching the query. See the [Get one CalendarEventCategory](/rest-api/content/get-calendareventcategories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Title": "",
      "CalendarEvents": [],
      "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": "CalendarEventCategory Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CalendarEventCategories
Source: https://learn.nexudus.com/rest-api/content/get-calendareventcategories-batch

GET /api/content/calendareventcategories/?id=[{id1},{id2},{id3}]
Retrieve multiple CalendarEventCategory records by their Ids in a single request.

Fetch several CalendarEventCategory records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CalendarEventCategory-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CalendarEventCategory Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendareventcategories/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendareventcategories/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CalendarEventCategory records. Each record has the same structure as the response from the [Get one CalendarEventCategory](/rest-api/content/get-calendareventcategories-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Title": "",
    "CalendarEvents": [],
    "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": "CalendarEventCategory Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CalendarEventCategory
Source: https://learn.nexudus.com/rest-api/content/get-calendareventcategories-by-id

GET /api/content/calendareventcategories/{id}
Retrieve a single CalendarEventCategory record by its Id.

A **CalendarEventCategory** groups events by type or theme within a location. Categories appear as filters on the Events page of the Members Portal, letting customers quickly find relevant events. Events that share the same category are also shown as related events when a customer views the detail page of a specific event.

Assign categories to events via the `EventCategories` list on the `CalendarEvent` entity.

## Authentication

<Note>
  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 **`CalendarEventCategory-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CalendarEventCategory record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendareventcategories/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendareventcategories/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  The location this event category belongs to.
</ResponseField>

<ResponseField name="Title" type="string">
  Category name shown as a filter on the Members Portal.
</ResponseField>

<ResponseField name="CalendarEvents" type="integer[]">
  IDs of events assigned to this category.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Title": "",
  "CalendarEvents": [],
  "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": "CalendarEventCategory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CalendarEvents
Source: https://learn.nexudus.com/rest-api/content/get-calendarevents

GET /api/content/calendarevents
Search and list CalendarEvent records with filtering, sorting, and pagination.

A **CalendarEvent** represents a physical, virtual, or hybrid event published on the Members Portal. Events can be free or monetised with ticket products.

Physical events can be linked to a space resource via `ResourceId`, which automatically blocks that resource from being booked for the event's duration. Virtual events require the Zoom integration and support both conference calls (`IncludeZoomInvite`) and webinars (`CreateZoomWebinarInvite`).

Events support recurring schedules: set `RepeatEvent = true` on creation and configure `Repeats`, `RepeatEvery`, `RepeatUntil`, and the day-of-week flags. `RepeatEvent` and all repeat-configuration fields (`Repeats`, `RepeatEvery`, `RepeatUntil`, `RepeatOn*`) are create-only. Once an event series is created, only `WhichEventsToUpdate` can be used to update or delete events in the series. New events cannot be added to an existing series.

Attendance can be restricted to all customers, contacts only (`OnlyForContacts`), or members only (`OnlyForMembers`). Set `Allocation` to cap total attendees and enable `EnableWaitList` to allow overflow sign-ups.

## Authentication

<Note>
  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 **`CalendarEvent-List`** role.
</Note>

## Enums

<Accordion title="eCalendarEventRepeatCycle — Repeats values">
  | Value | Name          |
  | ----- | ------------- |
  | 1     | Daily         |
  | 2     | Weekly        |
  | 3     | Monthly       |
  | 4     | Yearly        |
  | 5     | FirstOfMonth  |
  | 6     | SecondOfMonth |
  | 7     | ThirdOfMonth  |
  | 8     | LastOfMonth   |
  | 9     | FourthOfMonth |
</Accordion>

<Accordion title="eRepeatedCalendarEventUpdateAction — WhichEventsToUpdate values">
  | Value | Name                   |
  | ----- | ---------------------- |
  | 1     | UpdateThisEventOnly    |
  | 2     | UpdateFutureEventsOnly |
  | 3     | UpdateAllEvents        |
  | 4     | DeleteAllEvents        |
  | 5     | DeleteEventsAfterThis  |
  | 6     | UpdateEventProducts    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by the location this event belongs to.
</ParamField>

<ParamField type="string">
  Filter by event name.
</ParamField>

<ParamField type="string">
  Filter by full name of the event host or presenter.
</ParamField>

<ParamField type="string">
  Filter by brief summary shown under the event name on the Members Portal.
</ParamField>

<ParamField type="string">
  Filter by full event description visible when a customer opens the event on the Members Portal.
</ParamField>

<ParamField type="string">
  Filter by additional notes included in ticket confirmation emails.
</ParamField>

<ParamField type="boolean">
  Filter by allow customers to join a waiting list when the event is at full capacity.
</ParamField>

<ParamField type="boolean">
  Filter by request the buyer's postal address during ticket checkout.
</ParamField>

<ParamField type="boolean">
  Filter by display the attendee list on the Members Portal event page.
</ParamField>

<ParamField type="string">
  Filter by venue or room name displayed on the event page.
</ParamField>

<ParamField type="string">
  Filter by street address of the event venue.
</ParamField>

<ParamField type="integer">
  Filter by resource linked to this event; automatically blocked from bookings for the event's duration.
</ParamField>

<ParamField type="string">
  Filter by event start date and time (UTC).
</ParamField>

<ParamField type="string">
  Filter by event end date and time (UTC).
</ParamField>

<ParamField type="integer">
  Filter by maximum number of attendees; leave empty for unlimited.
</ParamField>

<ParamField type="string">
  Filter by date and time the event becomes visible on the Members Portal (UTC).
</ParamField>

<ParamField type="boolean">
  Filter by display this event in the home page banner on the Members Portal.
</ParamField>

<ParamField type="boolean">
  Filter by display this event on the Members Portal home page.
</ParamField>

<ParamField type="boolean">
  Filter by allow customers to post comments on the event.
</ParamField>

<ParamField type="boolean">
  Filter by attach a Zoom conference call link to this event.
</ParamField>

<ParamField type="boolean">
  Filter by create a Zoom webinar instead of a regular conference call.
</ParamField>

<ParamField type="string">
  Filter by comma-separated email addresses of alternative Zoom hosts who can start the meeting.
</ParamField>

<ParamField type="string">
  Filter by raw Zoom meeting data returned after the Zoom event is created.
</ParamField>

<ParamField type="string">
  Filter by zoom meeting or webinar ID.
</ParamField>

<ParamField type="boolean">
  Filter by restrict event attendance to contacts only.
</ParamField>

<ParamField type="boolean">
  Filter by restrict event attendance to members only.
</ParamField>

<ParamField type="string">
  Filter by filename of the small event image shown in related-events sections (read-only; set via `NewSmallLogoUrl`).
</ParamField>

<ParamField type="string">
  Filter by uRL of an image to upload as the small event image.
</ParamField>

<ParamField type="boolean">
  Filter by remove the current small event image.
</ParamField>

<ParamField type="string">
  Filter by filename of the large event image shown on the event list and detail page (read-only; set via `NewLargeLogoUrl`).
</ParamField>

<ParamField type="string">
  Filter by uRL of an image to upload as the large event image.
</ParamField>

<ParamField type="boolean">
  Filter by remove the current large event image.
</ParamField>

<ParamField type="string">
  Filter by uRL of an external website related to this event.
</ParamField>

<ParamField type="string">
  Filter by uRL of a Facebook event or page for this event.
</ParamField>

<ParamField type="string">
  Filter by uRL of an external ticketing page for this event.
</ParamField>

<ParamField type="string">
  Filter by unique identifier shared by all occurrences in a repeat series.
</ParamField>

<ParamField type="boolean">
  Filter by create this event as a recurring series (create only).
</ParamField>

<ParamField type="integer">
  Filter by recurrence pattern for the event series.
</ParamField>

<ParamField type="integer">
  Filter by which events in the recurring series to update (update only).
</ParamField>

<ParamField type="integer">
  Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks).
</ParamField>

<ParamField type="string">
  Filter by date the recurring series ends (create only).
</ParamField>

<ParamField type="boolean">
  Filter by include Mondays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Tuesdays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Wednesdays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Thursdays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Fridays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Saturdays in the recurring schedule.
</ParamField>

<ParamField type="boolean">
  Filter by include Sundays in the recurring schedule.
</ParamField>

<ParamField type="string">
  Filter by event start date and time in the location's local timezone.
</ParamField>

<ParamField type="string">
  Filter by event end date and time in the location's local timezone.
</ParamField>

<ParamField type="string">
  Filter by publish date and time in the location's local timezone.
</ParamField>

<ParamField type="string">
  Filter by background job ID for the scheduled post-event notification email.
</ParamField>

<ParamField type="boolean">
  Filter by send a follow-up notification email to attendees after the event ends.
</ParamField>

<ParamField type="string">
  Filter by custom message body for the post-event notification email.
</ParamField>

<ParamField type="boolean">
  Filter by send a reminder notification email to attendees before the event starts.
</ParamField>

<ParamField type="boolean">
  Filter by a form is linked to this event that attendees are asked to complete.
</ParamField>

<ParamField type="boolean">
  Filter by send the linked event form to attendees by email.
</ParamField>

<ParamField type="integer">
  Filter by iD of the form page linked to this event.
</ParamField>

<ParamField type="string">
  Filter by name of the linked form page.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by event start date and time (UTC) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event start date and time (UTC) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event end date and time (UTC) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event end date and time (UTC) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of attendees; leave empty for unlimited greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by maximum number of attendees; leave empty for unlimited less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date and time the event becomes visible on the Members Portal (UTC) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time the event becomes visible on the Members Portal (UTC) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date the recurring series ends (create only) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date the recurring series ends (create only) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event start date and time in the location's local timezone greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event start date and time in the location's local timezone less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event end date and time in the location's local timezone greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by event end date and time in the location's local timezone less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by publish date and time in the location's local timezone greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by publish date and time in the location's local timezone less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendarevents?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendarevents',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
      CalendarEvent_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendarevents',
      params={
          'CalendarEvent_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendarevents?from_CalendarEvent_UpdatedOn=2025-01-01T00:00&to_CalendarEvent_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
      from_CalendarEvent_UpdatedOn: '2025-01-01T00:00',
      to_CalendarEvent_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendarevents',
      params={
          'from_CalendarEvent_UpdatedOn': '2025-01-01T00:00',
          'to_CalendarEvent_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CalendarEvent[]">
  The list of CalendarEvent records matching the query. See the [Get one CalendarEvent](/rest-api/content/get-calendarevents-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CalendarEvent. The following fields are **not populated** in the `Records[]` response: `ShortDescription`, `LongDescription`, `TicketNotes`, `EnableWaitList`, `AskBuyerAddress`, `ShowEventAttendees`, `Location`, `VenueAddress`, `ShowInHomeBanner`, `ShowInHomePage`, `IncludeZoomInvite`, `CreateZoomWebinarInvite`, `ZoomWebinarAlternativeHosts`, `WebAddress`, `FacebookPage`, `TicketsPage`, `RepeatEvent`, `Repeats`, `WhichEventsToUpdate`, `RepeatEvery`, `RepeatUntil`, `RepeatOnMondays`, `RepeatOnTuesdays`, `RepeatOnWednesdays`, `RepeatOnThursdays`, `RepeatOnFridays`, `RepeatOnSaturdays`, `RepeatOnSundays`, `SendAfterEventNotification`, `AfterEventNotificationText`, `SendBeforeEventNotification`, `HasEventForm`, `SendEventFormByEmail`.

  To get all fields, fetch the full record using the [Get one CalendarEvent](/rest-api/content/get-calendarevents-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "HostFullName": null,
      "ResourceId": null,
      "StartDate": "2025-01-15T10:30:00Z",
      "EndDate": "2025-01-15T10:30:00Z",
      "Allocation": null,
      "EventCategories": [],
      "PublishDate": null,
      "AllowComments": false,
      "ZoomEventData": null,
      "ZoomMeetingId": null,
      "OnlyForContacts": false,
      "OnlyForMembers": false,
      "SmallLogoFileName": null,
      "NewSmallLogoUrl": null,
      "ClearSmallLogoFile": null,
      "LargeLogoFileName": null,
      "NewLargeLogoUrl": null,
      "ClearLargeLogoFile": null,
      "RepeatSeriesUniqueId": null,
      "StartDateLocal": null,
      "EndDateLocal": null,
      "PublishDateLocal": null,
      "AfterEventNotificationJobId": null,
      "FormPageId": null,
      "FormPageName": 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": "CalendarEvent Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CalendarEvents
Source: https://learn.nexudus.com/rest-api/content/get-calendarevents-batch

GET /api/content/calendarevents/?id=[{id1},{id2},{id3}]
Retrieve multiple CalendarEvent records by their Ids in a single request.

Fetch several CalendarEvent records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CalendarEvent-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CalendarEvent Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendarevents/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/calendarevents/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CalendarEvent records. Each record has the same structure as the response from the [Get one CalendarEvent](/rest-api/content/get-calendarevents-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CalendarEvent. The following fields are **not populated** in the response: `ShortDescription`, `LongDescription`, `TicketNotes`, `EnableWaitList`, `AskBuyerAddress`, `ShowEventAttendees`, `Location`, `VenueAddress`, `ShowInHomeBanner`, `ShowInHomePage`, `IncludeZoomInvite`, `CreateZoomWebinarInvite`, `ZoomWebinarAlternativeHosts`, `WebAddress`, `FacebookPage`, `TicketsPage`, `RepeatEvent`, `Repeats`, `WhichEventsToUpdate`, `RepeatEvery`, `RepeatUntil`, `RepeatOnMondays`, `RepeatOnTuesdays`, `RepeatOnWednesdays`, `RepeatOnThursdays`, `RepeatOnFridays`, `RepeatOnSaturdays`, `RepeatOnSundays`, `SendAfterEventNotification`, `AfterEventNotificationText`, `SendBeforeEventNotification`, `HasEventForm`, `SendEventFormByEmail`.

  To get all fields, fetch the full record using the [Get one CalendarEvent](/rest-api/content/get-calendarevents-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "HostFullName": null,
    "ResourceId": null,
    "StartDate": "2025-01-15T10:30:00Z",
    "EndDate": "2025-01-15T10:30:00Z",
    "Allocation": null,
    "EventCategories": [],
    "PublishDate": null,
    "AllowComments": false,
    "ZoomEventData": null,
    "ZoomMeetingId": null,
    "OnlyForContacts": false,
    "OnlyForMembers": false,
    "SmallLogoFileName": null,
    "NewSmallLogoUrl": null,
    "ClearSmallLogoFile": null,
    "LargeLogoFileName": null,
    "NewLargeLogoUrl": null,
    "ClearLargeLogoFile": null,
    "RepeatSeriesUniqueId": null,
    "StartDateLocal": null,
    "EndDateLocal": null,
    "PublishDateLocal": null,
    "AfterEventNotificationJobId": null,
    "FormPageId": null,
    "FormPageName": 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": "CalendarEvent Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CalendarEvent
Source: https://learn.nexudus.com/rest-api/content/get-calendarevents-by-id

GET /api/content/calendarevents/{id}
Retrieve a single CalendarEvent record by its Id.

A **CalendarEvent** represents a physical, virtual, or hybrid event published on the Members Portal. Events can be free or monetised with ticket products.

Physical events can be linked to a space resource via `ResourceId`, which automatically blocks that resource from being booked for the event's duration. Virtual events require the Zoom integration and support both conference calls (`IncludeZoomInvite`) and webinars (`CreateZoomWebinarInvite`).

Events support recurring schedules: set `RepeatEvent = true` on creation and configure `Repeats`, `RepeatEvery`, `RepeatUntil`, and the day-of-week flags. `RepeatEvent` and all repeat-configuration fields (`Repeats`, `RepeatEvery`, `RepeatUntil`, `RepeatOn*`) are create-only. Once an event series is created, only `WhichEventsToUpdate` can be used to update or delete events in the series. New events cannot be added to an existing series.

Attendance can be restricted to all customers, contacts only (`OnlyForContacts`), or members only (`OnlyForMembers`). Set `Allocation` to cap total attendees and enable `EnableWaitList` to allow overflow sign-ups.

## Authentication

<Note>
  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 **`CalendarEvent-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CalendarEvent record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/calendarevents/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/calendarevents/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  The location this event belongs to.
</ResponseField>

<ResponseField name="Name" type="string">
  Event name.
</ResponseField>

<ResponseField name="HostFullName" type="string">
  Full name of the event host or presenter.
</ResponseField>

<ResponseField name="ShortDescription" type="string">
  Brief summary shown under the event name on the Members Portal.
</ResponseField>

<ResponseField name="LongDescription" type="string">
  Full event description visible when a customer opens the event on the Members Portal.
</ResponseField>

<ResponseField name="TicketNotes" type="string">
  Additional notes included in ticket confirmation emails.
</ResponseField>

<ResponseField name="EnableWaitList" type="boolean">
  Allow customers to join a waiting list when the event is at full capacity.
</ResponseField>

<ResponseField name="AskBuyerAddress" type="boolean">
  Request the buyer's postal address during ticket checkout.
</ResponseField>

<ResponseField name="ShowEventAttendees" type="boolean">
  Display the attendee list on the Members Portal event page.
</ResponseField>

<ResponseField name="Location" type="string">
  Venue or room name displayed on the event page.
</ResponseField>

<ResponseField name="VenueAddress" type="string">
  Street address of the event venue.
</ResponseField>

<ResponseField name="ResourceId" type="integer">
  Resource linked to this event; automatically blocked from bookings for the event's duration.
</ResponseField>

<ResponseField name="StartDate" type="string">
  Event start date and time (UTC).
</ResponseField>

<ResponseField name="EndDate" type="string">
  Event end date and time (UTC).
</ResponseField>

<ResponseField name="Allocation" type="integer">
  Maximum number of attendees; leave empty for unlimited.
</ResponseField>

<ResponseField name="EventCategories" type="integer[]">
  Categories assigned to this event.
</ResponseField>

<ResponseField name="PublishDate" type="string">
  Date and time the event becomes visible on the Members Portal (UTC).
</ResponseField>

<ResponseField name="ShowInHomeBanner" type="boolean">
  Display this event in the home page banner on the Members Portal.
</ResponseField>

<ResponseField name="ShowInHomePage" type="boolean">
  Display this event on the Members Portal home page.
</ResponseField>

<ResponseField name="AllowComments" type="boolean">
  Allow customers to post comments on the event.
</ResponseField>

<ResponseField name="IncludeZoomInvite" type="boolean">
  Attach a Zoom conference call link to this event.
</ResponseField>

<ResponseField name="CreateZoomWebinarInvite" type="boolean">
  Create a Zoom webinar instead of a regular conference call.
</ResponseField>

<ResponseField name="ZoomWebinarAlternativeHosts" type="string">
  Comma-separated email addresses of alternative Zoom hosts who can start the meeting.
</ResponseField>

<ResponseField name="ZoomEventData" type="string">
  Raw Zoom meeting data returned after the Zoom event is created.
</ResponseField>

<ResponseField name="ZoomMeetingId" type="string">
  Zoom meeting or webinar ID.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Restrict event attendance to contacts only.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Restrict event attendance to members only.
</ResponseField>

<ResponseField name="SmallLogoFileName" type="string">
  Filename of the small event image shown in related-events sections (read-only; set via `NewSmallLogoUrl`).
</ResponseField>

<ResponseField name="NewSmallLogoUrl" type="string">
  URL of an image to upload as the small event image.
</ResponseField>

<ResponseField name="ClearSmallLogoFile" type="boolean">
  Remove the current small event image.
</ResponseField>

<ResponseField name="LargeLogoFileName" type="string">
  Filename of the large event image shown on the event list and detail page (read-only; set via `NewLargeLogoUrl`).
</ResponseField>

<ResponseField name="NewLargeLogoUrl" type="string">
  URL of an image to upload as the large event image.
</ResponseField>

<ResponseField name="ClearLargeLogoFile" type="boolean">
  Remove the current large event image.
</ResponseField>

<ResponseField name="WebAddress" type="string">
  URL of an external website related to this event.
</ResponseField>

<ResponseField name="FacebookPage" type="string">
  URL of a Facebook event or page for this event.
</ResponseField>

<ResponseField name="TicketsPage" type="string">
  URL of an external ticketing page for this event.
</ResponseField>

<ResponseField name="RepeatSeriesUniqueId" type="string">
  Unique identifier shared by all occurrences in a repeat series.
</ResponseField>

<ResponseField name="RepeatEvent" type="boolean">
  Create this event as a recurring series (create only).
</ResponseField>

<ResponseField name="Repeats" type="integer">
  Recurrence pattern for the event series. See `eCalendarEventRepeatCycle` enum values: `1` = Daily, `2` = Weekly, `3` = Monthly, `4` = Yearly, `5` = FirstOfMonth, `6` = SecondOfMonth, `7` = ThirdOfMonth, `8` = LastOfMonth, `9` = FourthOfMonth.
</ResponseField>

<ResponseField name="WhichEventsToUpdate" type="integer">
  Which events in the recurring series to update (update only). See `eRepeatedCalendarEventUpdateAction` enum values: `1` = UpdateThisEventOnly, `2` = UpdateFutureEventsOnly, `3` = UpdateAllEvents, `4` = DeleteAllEvents, `5` = DeleteEventsAfterThis, `6` = UpdateEventProducts.
</ResponseField>

<ResponseField name="RepeatEvery" type="integer">
  Number of cycles between occurrences (e.g. 2 with Weekly means every two weeks).
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Date the recurring series ends (create only).
</ResponseField>

<ResponseField name="RepeatOnMondays" type="boolean">
  Include Mondays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnTuesdays" type="boolean">
  Include Tuesdays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnWednesdays" type="boolean">
  Include Wednesdays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnThursdays" type="boolean">
  Include Thursdays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnFridays" type="boolean">
  Include Fridays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnSaturdays" type="boolean">
  Include Saturdays in the recurring schedule.
</ResponseField>

<ResponseField name="RepeatOnSundays" type="boolean">
  Include Sundays in the recurring schedule.
</ResponseField>

<ResponseField name="StartDateLocal" type="string">
  Event start date and time in the location's local timezone.
</ResponseField>

<ResponseField name="EndDateLocal" type="string">
  Event end date and time in the location's local timezone.
</ResponseField>

<ResponseField name="PublishDateLocal" type="string">
  Publish date and time in the location's local timezone.
</ResponseField>

<ResponseField name="AfterEventNotificationJobId" type="string">
  Background job ID for the scheduled post-event notification email.
</ResponseField>

<ResponseField name="SendAfterEventNotification" type="boolean">
  Send a follow-up notification email to attendees after the event ends.
</ResponseField>

<ResponseField name="AfterEventNotificationText" type="string">
  Custom message body for the post-event notification email.
</ResponseField>

<ResponseField name="SendBeforeEventNotification" type="boolean">
  Send a reminder notification email to attendees before the event starts.
</ResponseField>

<ResponseField name="HasEventForm" type="boolean">
  A form is linked to this event that attendees are asked to complete.
</ResponseField>

<ResponseField name="SendEventFormByEmail" type="boolean">
  Send the linked event form to attendees by email.
</ResponseField>

<ResponseField name="FormPageId" type="integer">
  ID of the form page linked to this event.
</ResponseField>

<ResponseField name="FormPageName" type="string">
  Name of the linked form page.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "HostFullName": null,
  "ShortDescription": null,
  "LongDescription": null,
  "TicketNotes": null,
  "EnableWaitList": false,
  "AskBuyerAddress": false,
  "ShowEventAttendees": false,
  "Location": null,
  "VenueAddress": null,
  "ResourceId": null,
  "StartDate": "2025-01-15T10:30:00Z",
  "EndDate": "2025-01-15T10:30:00Z",
  "Allocation": null,
  "EventCategories": [],
  "PublishDate": null,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "AllowComments": false,
  "IncludeZoomInvite": false,
  "CreateZoomWebinarInvite": false,
  "ZoomWebinarAlternativeHosts": null,
  "ZoomEventData": null,
  "ZoomMeetingId": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "SmallLogoFileName": null,
  "NewSmallLogoUrl": null,
  "ClearSmallLogoFile": null,
  "LargeLogoFileName": null,
  "NewLargeLogoUrl": null,
  "ClearLargeLogoFile": null,
  "WebAddress": null,
  "FacebookPage": null,
  "TicketsPage": null,
  "RepeatSeriesUniqueId": null,
  "RepeatEvent": false,
  "Repeats": 0,
  "WhichEventsToUpdate": 0,
  "RepeatEvery": null,
  "RepeatUntil": null,
  "RepeatOnMondays": false,
  "RepeatOnTuesdays": false,
  "RepeatOnWednesdays": false,
  "RepeatOnThursdays": false,
  "RepeatOnFridays": false,
  "RepeatOnSaturdays": false,
  "RepeatOnSundays": false,
  "StartDateLocal": null,
  "EndDateLocal": null,
  "PublishDateLocal": null,
  "AfterEventNotificationJobId": null,
  "SendAfterEventNotification": false,
  "AfterEventNotificationText": null,
  "SendBeforeEventNotification": false,
  "HasEventForm": false,
  "SendEventFormByEmail": false,
  "FormPageId": null,
  "FormPageName": 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": "CalendarEvent Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CommunityPerks
Source: https://learn.nexudus.com/rest-api/content/get-communityperks

GET /api/content/communityperks
Search and list CommunityPerk records with filtering, sorting, and pagination.

A **CommunityPerk** represents a perk, discount, or benefit that a location offers to its customers in partnership with other businesses.

Perks can be discounts, free trials, or any other benefit negotiated with a partner business — for example, 50% off a car rental or a free hot drink at a nearby café. They are published on the Members Portal where customers can view and claim them.

Use `Active` to control visibility — when `false`, the perk is only visible on the Admin Panel. Use `ShowInHomePage` to feature a perk on the Members Portal home page after users log in.

Availability can be restricted via `OnlyForContacts` and `OnlyForMembers`. If neither flag is set, the perk is available to all customers. Use `Tariffs` to further restrict access to customers on specific pricing plans.

Which perks are listed in a location is also controlled by the `Access.Data.Perks` **BusinessSetting**, whose value is an `eDataVisibilityCriteria` enum integer. This determines which locations' perks are visible to customers at a given location — for example `ThisLocationOnly` (7) shows only perks belonging to the current location, while `AllLocations` (3) shows perks from all locations in the network.

## Authentication

<Note>
  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 **`CommunityPerk-List`** role.
</Note>

## Enums

<Accordion title="eDataVisibilityCriteria">
  | Value | Name                 |
  | ----- | -------------------- |
  | 1     | AllChildren          |
  | 2     | AllParents           |
  | 3     | AllLocations         |
  | 4     | HomeLocationOnly     |
  | 5     | HomeLocationChildren |
  | 6     | HomeLocationParents  |
  | 7     | ThisLocationOnly     |
  | 8     | AllParentChildren    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the location this perk belongs to.
</ParamField>

<ParamField type="string">
  Filter by name of the perk as displayed on the Members Portal and the Admin Panel.
</ParamField>

<ParamField type="string">
  Filter by uRL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https\://.
</ParamField>

<ParamField type="string">
  Filter by short description shown under the perk title on the Perks listing page of the Members Portal.
</ParamField>

<ParamField type="string">
  Filter by full description of the perk, displayed when a customer clicks on it from the Perks listing page.
</ParamField>

<ParamField type="string">
  Filter by file name of the small image shown on the Perks listing page alongside other perks.
</ParamField>

<ParamField type="string">
  Filter by uRL of a new small image to upload for this perk.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current small image from this perk.
</ParamField>

<ParamField type="string">
  Filter by file name of the large image displayed under the perk title on the perk detail page.
</ParamField>

<ParamField type="string">
  Filter by uRL of a new large image to upload for this perk.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the current large image from this perk.
</ParamField>

<ParamField type="boolean">
  Filter by whether this perk is published and visible to customers on the Members Portal. When false, the perk is only visible on the Admin Panel.
</ParamField>

<ParamField type="string">
  Filter by group or category this perk belongs to, used to organise perks on the Members Portal.
</ParamField>

<ParamField type="integer">
  Filter by position of this perk in the list relative to other perks. Lower values appear first.
</ParamField>

<ParamField type="boolean">
  Filter by whether to feature this perk on the Members Portal home page after users log in.
</ParamField>

<ParamField type="integer">
  Filter by number of times customers have clicked on this perk.
</ParamField>

<ParamField type="boolean">
  Filter by whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ParamField>

<ParamField type="boolean">
  Filter by whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by position of this perk in the list relative to other perks. Lower values appear first greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by position of this perk in the list relative to other perks. Lower values appear first less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of times customers have clicked on this perk greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of times customers have clicked on this perk less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/communityperks',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks?CommunityPerk_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks?' + new URLSearchParams({
      CommunityPerk_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/communityperks',
      params={
          'CommunityPerk_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks?from_CommunityPerk_UpdatedOn=2025-01-01T00:00&to_CommunityPerk_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks?' + new URLSearchParams({
      from_CommunityPerk_UpdatedOn: '2025-01-01T00:00',
      to_CommunityPerk_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/communityperks',
      params={
          'from_CommunityPerk_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityPerk_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CommunityPerk[]">
  The list of CommunityPerk records matching the query. See the [Get one CommunityPerk](/rest-api/content/get-communityperks-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CommunityPerk. The following fields are **not populated** in the `Records[]` response: `FullText`, `Active`, `ShowInHomePage`, `ClickCount`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one CommunityPerk](/rest-api/content/get-communityperks-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Title": "",
      "PerkUrl": null,
      "SummaryText": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "GroupName": null,
      "DisplayOrder": 0,
      "Tariffs": [],
      "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": "CommunityPerk Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CommunityPerks
Source: https://learn.nexudus.com/rest-api/content/get-communityperks-batch

GET /api/content/communityperks/?id=[{id1},{id2},{id3}]
Retrieve multiple CommunityPerk records by their Ids in a single request.

Fetch several CommunityPerk records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CommunityPerk-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CommunityPerk Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/communityperks/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CommunityPerk records. Each record has the same structure as the response from the [Get one CommunityPerk](/rest-api/content/get-communityperks-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CommunityPerk. The following fields are **not populated** in the response: `FullText`, `Active`, `ShowInHomePage`, `ClickCount`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one CommunityPerk](/rest-api/content/get-communityperks-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Title": "",
    "PerkUrl": null,
    "SummaryText": null,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "LargeImageFileName": null,
    "NewLargeImageUrl": null,
    "ClearLargeImageFile": null,
    "GroupName": null,
    "DisplayOrder": 0,
    "Tariffs": [],
    "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": "CommunityPerk Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CommunityPerk
Source: https://learn.nexudus.com/rest-api/content/get-communityperks-by-id

GET /api/content/communityperks/{id}
Retrieve a single CommunityPerk record by its Id.

A **CommunityPerk** represents a perk, discount, or benefit that a location offers to its customers in partnership with other businesses.

Perks can be discounts, free trials, or any other benefit negotiated with a partner business — for example, 50% off a car rental or a free hot drink at a nearby café. They are published on the Members Portal where customers can view and claim them.

Use `Active` to control visibility — when `false`, the perk is only visible on the Admin Panel. Use `ShowInHomePage` to feature a perk on the Members Portal home page after users log in.

Availability can be restricted via `OnlyForContacts` and `OnlyForMembers`. If neither flag is set, the perk is available to all customers. Use `Tariffs` to further restrict access to customers on specific pricing plans.

Which perks are listed in a location is also controlled by the `Access.Data.Perks` **BusinessSetting**, whose value is an `eDataVisibilityCriteria` enum integer. This determines which locations' perks are visible to customers at a given location — for example `ThisLocationOnly` (7) shows only perks belonging to the current location, while `AllLocations` (3) shows perks from all locations in the network.

## Authentication

<Note>
  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 **`CommunityPerk-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CommunityPerk record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the location this perk belongs to.
</ResponseField>

<ResponseField name="Title" type="string">
  Name of the perk as displayed on the Members Portal and the Admin Panel.
</ResponseField>

<ResponseField name="PerkUrl" type="string">
  URL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https\://.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short description shown under the perk title on the Perks listing page of the Members Portal.
</ResponseField>

<ResponseField name="FullText" type="string">
  Full description of the perk, displayed when a customer clicks on it from the Perks listing page.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  File name of the small image shown on the Perks listing page alongside other perks.
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new small image to upload for this perk.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current small image from this perk.
</ResponseField>

<ResponseField name="LargeImageFileName" type="string">
  File name of the large image displayed under the perk title on the perk detail page.
</ResponseField>

<ResponseField name="NewLargeImageUrl" type="string">
  URL of a new large image to upload for this perk.
</ResponseField>

<ResponseField name="ClearLargeImageFile" type="boolean">
  Set to true to remove the current large image from this perk.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether this perk is published and visible to customers on the Members Portal. When false, the perk is only visible on the Admin Panel.
</ResponseField>

<ResponseField name="GroupName" type="string">
  Group or category this perk belongs to, used to organise perks on the Members Portal.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Position of this perk in the list relative to other perks. Lower values appear first.
</ResponseField>

<ResponseField name="ShowInHomePage" type="boolean">
  Whether to feature this perk on the Members Portal home page after users log in.
</ResponseField>

<ResponseField name="ClickCount" type="integer">
  Number of times customers have clicked on this perk.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  IDs of the pricing plans (tariffs) whose members can see and claim this perk. Leave empty to make the perk available regardless of pricing plan.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Title": "",
  "PerkUrl": null,
  "SummaryText": null,
  "FullText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "Active": false,
  "GroupName": null,
  "DisplayOrder": 0,
  "ShowInHomePage": false,
  "ClickCount": 0,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "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": "CommunityPerk Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CourseCompletedLessons
Source: https://learn.nexudus.com/rest-api/content/get-coursecompletedlessons

GET /api/content/coursecompletedlessons
Search and list CourseCompletedLesson records with filtering, sorting, and pagination.

A **CourseCompletedLesson** records that a specific `CourseMember` has completed a specific `CourseLesson`. Each record is the junction between a lesson and the enrolled member who finished it.

These records are typically created automatically by the Members Portal when a member meets the lesson's completion criteria (e.g. visiting the lesson page, clicking a completion button, or finishing a video). They can also be created or deleted manually via the API to manage progress programmatically.

Use this entity to query which lessons a member has completed, or to find all members who have completed a given lesson.

## Authentication

<Note>
  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 **`CourseCompletedLesson-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the course lesson that was completed.
</ParamField>

<ParamField type="string">
  Filter by title of the completed lesson.
</ParamField>

<ParamField type="integer">
  Filter by iD of the course enrolment (CourseMember) record for the member who completed the lesson.
</ParamField>

<ParamField type="string">
  Filter by full name of the member who completed the lesson.
</ParamField>

<ParamField type="string">
  Filter by company name of the member who completed the lesson.
</ParamField>

<ParamField type="string">
  Filter by comma-separated list of teams the member belongs to.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursecompletedlessons',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons?CourseCompletedLesson_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons?' + new URLSearchParams({
      CourseCompletedLesson_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursecompletedlessons',
      params={
          'CourseCompletedLesson_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons?from_CourseCompletedLesson_UpdatedOn=2025-01-01T00:00&to_CourseCompletedLesson_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons?' + new URLSearchParams({
      from_CourseCompletedLesson_UpdatedOn: '2025-01-01T00:00',
      to_CourseCompletedLesson_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursecompletedlessons',
      params={
          'from_CourseCompletedLesson_UpdatedOn': '2025-01-01T00:00',
          'to_CourseCompletedLesson_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CourseCompletedLesson[]">
  The list of CourseCompletedLesson records matching the query. See the [Get one CourseCompletedLesson](/rest-api/content/get-coursecompletedlessons-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CourseLessonId": 0,
      "CourseLessonTitle": null,
      "CourseMemberId": 0,
      "CourseMemberCoworkerFullName": null,
      "CourseMemberCoworkerCompanyName": null,
      "CourseMemberCoworkerTeamNames": 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": "CourseCompletedLesson Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CourseCompletedLessons
Source: https://learn.nexudus.com/rest-api/content/get-coursecompletedlessons-batch

GET /api/content/coursecompletedlessons/?id=[{id1},{id2},{id3}]
Retrieve multiple CourseCompletedLesson records by their Ids in a single request.

Fetch several CourseCompletedLesson records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CourseCompletedLesson-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CourseCompletedLesson Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursecompletedlessons/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CourseCompletedLesson records. Each record has the same structure as the response from the [Get one CourseCompletedLesson](/rest-api/content/get-coursecompletedlessons-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CourseLessonId": 0,
    "CourseLessonTitle": null,
    "CourseMemberId": 0,
    "CourseMemberCoworkerFullName": null,
    "CourseMemberCoworkerCompanyName": null,
    "CourseMemberCoworkerTeamNames": 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": "CourseCompletedLesson Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CourseCompletedLesson
Source: https://learn.nexudus.com/rest-api/content/get-coursecompletedlessons-by-id

GET /api/content/coursecompletedlessons/{id}
Retrieve a single CourseCompletedLesson record by its Id.

A **CourseCompletedLesson** records that a specific `CourseMember` has completed a specific `CourseLesson`. Each record is the junction between a lesson and the enrolled member who finished it.

These records are typically created automatically by the Members Portal when a member meets the lesson's completion criteria (e.g. visiting the lesson page, clicking a completion button, or finishing a video). They can also be created or deleted manually via the API to manage progress programmatically.

Use this entity to query which lessons a member has completed, or to find all members who have completed a given lesson.

## Authentication

<Note>
  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 **`CourseCompletedLesson-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseCompletedLesson record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursecompletedlessons/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CourseLessonId" type="integer">
  ID of the course lesson that was completed.
</ResponseField>

<ResponseField name="CourseLessonTitle" type="string">
  Title of the completed lesson.
</ResponseField>

<ResponseField name="CourseMemberId" type="integer">
  ID of the course enrolment (CourseMember) record for the member who completed the lesson.
</ResponseField>

<ResponseField name="CourseMemberCoworkerFullName" type="string">
  Full name of the member who completed the lesson.
</ResponseField>

<ResponseField name="CourseMemberCoworkerCompanyName" type="string">
  Company name of the member who completed the lesson.
</ResponseField>

<ResponseField name="CourseMemberCoworkerTeamNames" type="string">
  Comma-separated list of teams the member belongs to.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CourseLessonId": 0,
  "CourseLessonTitle": null,
  "CourseMemberId": 0,
  "CourseMemberCoworkerFullName": null,
  "CourseMemberCoworkerCompanyName": null,
  "CourseMemberCoworkerTeamNames": 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": "CourseCompletedLesson Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CourseLessons
Source: https://learn.nexudus.com/rest-api/content/get-courselessons

GET /api/content/courselessons
Search and list CourseLesson records with filtering, sorting, and pagination.

A **CourseLesson** is an individual learning unit within a Course. Lessons are the building blocks that customers complete to work through a course's content. Each lesson belongs to a `Course` and optionally to a `CourseSection` that groups related lessons together.

Lessons have two key behavioural settings:

**`UnlockType`** — controls when a lesson becomes available to enrolled members:

| Value      | Meaning                                                        |
| ---------- | -------------------------------------------------------------- |
| Immediate  | Available as soon as the member enrols                         |
| Sequential | Unlocked only after the previous lesson is completed           |
| Timed      | Unlocked after a number of days specified by `UnlockAfterDays` |

**`CompletionType`** — defines what action marks the lesson as done:

| Value   | Meaning                                                                    |
| ------- | -------------------------------------------------------------------------- |
| None    | No completion tracking                                                     |
| Visited | Marked complete when the member opens the lesson                           |
| Button  | Member must click a completion button                                      |
| Video   | Member must finish watching the embedded video (must be hosted on YouTube) |

## Authentication

<Note>
  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 **`CourseLesson-List`** role.
</Note>

## Enums

<Accordion title="eLessonUnlockType — UnlockType values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Immediate  |
  | 2     | Sequential |
  | 3     | Timed      |
</Accordion>

<Accordion title="eLessonCompletionType — CompletionType values">
  | Value | Name    |
  | ----- | ------- |
  | 1     | None    |
  | 2     | Visited |
  | 3     | Button  |
  | 4     | Video   |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the course this lesson belongs to.
</ParamField>

<ParamField type="string">
  Filter by title of the parent course.
</ParamField>

<ParamField type="integer">
  Filter by iD of the course section this lesson belongs to (optional; lessons without a section appear ungrouped).
</ParamField>

<ParamField type="integer">
  Filter by display order of the parent section.
</ParamField>

<ParamField type="string">
  Filter by title of the parent section.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker attributed as instructor for this lesson (optional; overrides the course-level host for this lesson).
</ParamField>

<ParamField type="string">
  Filter by instructor full name.
</ParamField>

<ParamField type="string">
  Filter by instructor company name.
</ParamField>

<ParamField type="string">
  Filter by comma-separated list of teams the instructor belongs to.
</ParamField>

<ParamField type="string">
  Filter by lesson title displayed to members.
</ParamField>

<ParamField type="string">
  Filter by short summary shown in the lesson listing.
</ParamField>

<ParamField type="string">
  Filter by full HTML or rich-text body of the lesson displayed to members when they open it.
</ParamField>

<ParamField type="boolean">
  Filter by whether the lesson is active and visible to enrolled members.
</ParamField>

<ParamField type="integer">
  Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first.
</ParamField>

<ParamField type="integer">
  Filter by when the lesson becomes available: Immediate (1), after the previous lesson is done — Sequential (2), or after a set number of days — Timed (3).
</ParamField>

<ParamField type="string">
  Filter by stored filename of the lesson thumbnail image (read-only; use `NewImageUrl` to set).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the existing thumbnail image.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3).
</ParamField>

<ParamField type="integer">
  Filter by how completion is tracked: None (1), Visited (2), completion Button (3), or Video watched (4). Video completion requires the lesson to embed a YouTube-hosted video..
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by display order of the parent section greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by display order of the parent section less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3) less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courselessons?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courselessons',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courselessons?CourseLesson_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons?' + new URLSearchParams({
      CourseLesson_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courselessons',
      params={
          'CourseLesson_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courselessons?from_CourseLesson_UpdatedOn=2025-01-01T00:00&to_CourseLesson_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons?' + new URLSearchParams({
      from_CourseLesson_UpdatedOn: '2025-01-01T00:00',
      to_CourseLesson_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courselessons',
      params={
          'from_CourseLesson_UpdatedOn': '2025-01-01T00:00',
          'to_CourseLesson_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CourseLesson[]">
  The list of CourseLesson records matching the query. See the [Get one CourseLesson](/rest-api/content/get-courselessons-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CourseLesson. The following fields are **not populated** in the `Records[]` response: `LessonContents`, `UnlockType`, `CompletionType`.

  To get all fields, fetch the full record using the [Get one CourseLesson](/rest-api/content/get-courselessons-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CourseId": 0,
      "CourseTitle": null,
      "SectionId": null,
      "SectionDisplayOrder": null,
      "SectionTitle": null,
      "InstructorId": null,
      "InstructorFullName": null,
      "InstructorCompanyName": null,
      "InstructorTeamNames": null,
      "Title": "",
      "SummaryText": null,
      "Active": false,
      "DisplayOrder": 0,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "UnlockAfterDays": 0,
      "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": "CourseLesson Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CourseLessons
Source: https://learn.nexudus.com/rest-api/content/get-courselessons-batch

GET /api/content/courselessons/?id=[{id1},{id2},{id3}]
Retrieve multiple CourseLesson records by their Ids in a single request.

Fetch several CourseLesson records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CourseLesson-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CourseLesson Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courselessons/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courselessons/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CourseLesson records. Each record has the same structure as the response from the [Get one CourseLesson](/rest-api/content/get-courselessons-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CourseLesson. The following fields are **not populated** in the response: `LessonContents`, `UnlockType`, `CompletionType`.

  To get all fields, fetch the full record using the [Get one CourseLesson](/rest-api/content/get-courselessons-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CourseId": 0,
    "CourseTitle": null,
    "SectionId": null,
    "SectionDisplayOrder": null,
    "SectionTitle": null,
    "InstructorId": null,
    "InstructorFullName": null,
    "InstructorCompanyName": null,
    "InstructorTeamNames": null,
    "Title": "",
    "SummaryText": null,
    "Active": false,
    "DisplayOrder": 0,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "UnlockAfterDays": 0,
    "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": "CourseLesson Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CourseLesson
Source: https://learn.nexudus.com/rest-api/content/get-courselessons-by-id

GET /api/content/courselessons/{id}
Retrieve a single CourseLesson record by its Id.

A **CourseLesson** is an individual learning unit within a Course. Lessons are the building blocks that customers complete to work through a course's content. Each lesson belongs to a `Course` and optionally to a `CourseSection` that groups related lessons together.

Lessons have two key behavioural settings:

**`UnlockType`** — controls when a lesson becomes available to enrolled members:

| Value      | Meaning                                                        |
| ---------- | -------------------------------------------------------------- |
| Immediate  | Available as soon as the member enrols                         |
| Sequential | Unlocked only after the previous lesson is completed           |
| Timed      | Unlocked after a number of days specified by `UnlockAfterDays` |

**`CompletionType`** — defines what action marks the lesson as done:

| Value   | Meaning                                                                    |
| ------- | -------------------------------------------------------------------------- |
| None    | No completion tracking                                                     |
| Visited | Marked complete when the member opens the lesson                           |
| Button  | Member must click a completion button                                      |
| Video   | Member must finish watching the embedded video (must be hosted on YouTube) |

## Authentication

<Note>
  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 **`CourseLesson-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseLesson record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courselessons/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courselessons/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CourseId" type="integer">
  ID of the course this lesson belongs to.
</ResponseField>

<ResponseField name="CourseTitle" type="string">
  Title of the parent course.
</ResponseField>

<ResponseField name="SectionId" type="integer">
  ID of the course section this lesson belongs to (optional; lessons without a section appear ungrouped).
</ResponseField>

<ResponseField name="SectionDisplayOrder" type="integer">
  Display order of the parent section.
</ResponseField>

<ResponseField name="SectionTitle" type="string">
  Title of the parent section.
</ResponseField>

<ResponseField name="InstructorId" type="integer">
  ID of the coworker attributed as instructor for this lesson (optional; overrides the course-level host for this lesson).
</ResponseField>

<ResponseField name="InstructorFullName" type="string">
  Instructor full name.
</ResponseField>

<ResponseField name="InstructorCompanyName" type="string">
  Instructor company name.
</ResponseField>

<ResponseField name="InstructorTeamNames" type="string">
  Comma-separated list of teams the instructor belongs to.
</ResponseField>

<ResponseField name="Title" type="string">
  Lesson title displayed to members.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short summary shown in the lesson listing.
</ResponseField>

<ResponseField name="LessonContents" type="string">
  Full HTML or rich-text body of the lesson displayed to members when they open it.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the lesson is active and visible to enrolled members.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Position of the lesson within its section (or the course if unsectioned); lower numbers appear first.
</ResponseField>

<ResponseField name="UnlockType" type="integer">
  When the lesson becomes available: Immediate (1), after the previous lesson is done — Sequential (2), or after a set number of days — Timed (3). See `eLessonUnlockType` enum values: `1` = Immediate, `2` = Sequential, `3` = Timed.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Stored filename of the lesson thumbnail image (read-only; use `NewImageUrl` to set).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the existing thumbnail image.
</ResponseField>

<ResponseField name="UnlockAfterDays" type="integer">
  Number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3).
</ResponseField>

<ResponseField name="CompletionType" type="integer">
  How completion is tracked: None (1), Visited (2), completion Button (3), or Video watched (4). Video completion requires the lesson to embed a YouTube-hosted video.. See `eLessonCompletionType` enum values: `1` = None, `2` = Visited, `3` = Button, `4` = Video.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CourseId": 0,
  "CourseTitle": null,
  "SectionId": null,
  "SectionDisplayOrder": null,
  "SectionTitle": null,
  "InstructorId": null,
  "InstructorFullName": null,
  "InstructorCompanyName": null,
  "InstructorTeamNames": null,
  "Title": "",
  "SummaryText": null,
  "LessonContents": null,
  "Active": false,
  "DisplayOrder": 0,
  "UnlockType": 0,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "UnlockAfterDays": 0,
  "CompletionType": 0,
  "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": "CourseLesson Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CourseMembers
Source: https://learn.nexudus.com/rest-api/content/get-coursemembers

GET /api/content/coursemembers
Search and list CourseMember records with filtering, sorting, and pagination.

A **CourseMember** represents a customer's enrolment in a `Course`. When a customer signs up to a course through the Members Portal they are automatically added as a CourseMember. Members can also be added manually via the Admin Panel or the API.

Each CourseMember record tracks the member's progress (`LastCompletedLessonId`, `LastAccess`) and their access status:

* `Approved` — the member has been approved to access the course content. For public courses this is set automatically on sign-up; for private or paid courses an administrator may need to approve the enrolment.
* `Blocked` — the member has been blocked from accessing the course.

Use `CourseCompletedLesson` records to query which individual lessons a member has completed.

## Authentication

<Note>
  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 **`CourseMember-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the course the member is enrolled in.
</ParamField>

<ParamField type="string">
  Filter by title of the course.
</ParamField>

<ParamField type="integer">
  Filter by iD of the customer enrolled in the course.
</ParamField>

<ParamField type="string">
  Filter by whether the enrolled customer is an Individual (1) or a Company (2).
</ParamField>

<ParamField type="string">
  Filter by full name of the enrolled customer.
</ParamField>

<ParamField type="string">
  Filter by company name of the enrolled customer.
</ParamField>

<ParamField type="string">
  Filter by comma-separated list of teams the enrolled customer belongs to.
</ParamField>

<ParamField type="string">
  Filter by billing name of the enrolled customer.
</ParamField>

<ParamField type="integer">
  Filter by iD of the most recently completed lesson for this member.
</ParamField>

<ParamField type="string">
  Filter by title of the most recently completed lesson.
</ParamField>

<ParamField type="string">
  Filter by date and time the member last accessed the course.
</ParamField>

<ParamField type="boolean">
  Filter by whether the member has been approved to access the course content.
</ParamField>

<ParamField type="boolean">
  Filter by whether the member has been blocked from accessing the course.
</ParamField>

### Range Filters

<ParamField type="string">
  Filter by date and time the member last accessed the course greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date and time the member last accessed the course less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursemembers?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursemembers',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursemembers?CourseMember_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers?' + new URLSearchParams({
      CourseMember_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursemembers',
      params={
          'CourseMember_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursemembers?from_CourseMember_UpdatedOn=2025-01-01T00:00&to_CourseMember_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers?' + new URLSearchParams({
      from_CourseMember_UpdatedOn: '2025-01-01T00:00',
      to_CourseMember_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursemembers',
      params={
          'from_CourseMember_UpdatedOn': '2025-01-01T00:00',
          'to_CourseMember_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CourseMember[]">
  The list of CourseMember records matching the query. See the [Get one CourseMember](/rest-api/content/get-coursemembers-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CourseId": 0,
      "CourseTitle": null,
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerTeamNames": null,
      "CoworkerBillingName": null,
      "LastCompletedLessonId": null,
      "LastCompletedLessonTitle": null,
      "LastAccess": null,
      "Approved": false,
      "Blocked": false,
      "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": "CourseMember Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CourseMembers
Source: https://learn.nexudus.com/rest-api/content/get-coursemembers-batch

GET /api/content/coursemembers/?id=[{id1},{id2},{id3}]
Retrieve multiple CourseMember records by their Ids in a single request.

Fetch several CourseMember records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CourseMember-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CourseMember Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursemembers/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursemembers/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CourseMember records. Each record has the same structure as the response from the [Get one CourseMember](/rest-api/content/get-coursemembers-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "CourseId": 0,
    "CourseTitle": null,
    "CoworkerId": 0,
    "CoworkerCoworkerType": null,
    "CoworkerFullName": null,
    "CoworkerCompanyName": null,
    "CoworkerTeamNames": null,
    "CoworkerBillingName": null,
    "LastCompletedLessonId": null,
    "LastCompletedLessonTitle": null,
    "LastAccess": null,
    "Approved": false,
    "Blocked": false,
    "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": "CourseMember Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CourseMember
Source: https://learn.nexudus.com/rest-api/content/get-coursemembers-by-id

GET /api/content/coursemembers/{id}
Retrieve a single CourseMember record by its Id.

A **CourseMember** represents a customer's enrolment in a `Course`. When a customer signs up to a course through the Members Portal they are automatically added as a CourseMember. Members can also be added manually via the Admin Panel or the API.

Each CourseMember record tracks the member's progress (`LastCompletedLessonId`, `LastAccess`) and their access status:

* `Approved` — the member has been approved to access the course content. For public courses this is set automatically on sign-up; for private or paid courses an administrator may need to approve the enrolment.
* `Blocked` — the member has been blocked from accessing the course.

Use `CourseCompletedLesson` records to query which individual lessons a member has completed.

## Authentication

<Note>
  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 **`CourseMember-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseMember record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursemembers/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursemembers/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CourseId" type="integer">
  ID of the course the member is enrolled in.
</ResponseField>

<ResponseField name="CourseTitle" type="string">
  Title of the course.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the customer enrolled in the course.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Whether the enrolled customer is an Individual (1) or a Company (2).
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the enrolled customer.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the enrolled customer.
</ResponseField>

<ResponseField name="CoworkerTeamNames" type="string">
  Comma-separated list of teams the enrolled customer belongs to.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the enrolled customer.
</ResponseField>

<ResponseField name="LastCompletedLessonId" type="integer">
  ID of the most recently completed lesson for this member.
</ResponseField>

<ResponseField name="LastCompletedLessonTitle" type="string">
  Title of the most recently completed lesson.
</ResponseField>

<ResponseField name="LastAccess" type="string">
  Date and time the member last accessed the course.
</ResponseField>

<ResponseField name="Approved" type="boolean">
  Whether the member has been approved to access the course content.
</ResponseField>

<ResponseField name="Blocked" type="boolean">
  Whether the member has been blocked from accessing the course.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CourseId": 0,
  "CourseTitle": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "CoworkerBillingName": null,
  "LastCompletedLessonId": null,
  "LastCompletedLessonTitle": null,
  "LastAccess": null,
  "Approved": false,
  "Blocked": false,
  "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": "CourseMember Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search Courses
Source: https://learn.nexudus.com/rest-api/content/get-courses

GET /api/content/courses
Search and list Course records with filtering, sorting, and pagination.

A **Course** is a structured learning module published to customers through the Members Portal. Courses are organised into **sections** (milestones) and **lessons** (individual content units). They can be used for internal training, community building, or self-learning offers.

Courses belong to a Location and are assigned a Host (a customer or administrator) who is responsible for its content. You can control who can access a course using the `Visibility` field:

| Visibility | Meaning                                                           |
| ---------- | ----------------------------------------------------------------- |
| Public     | Visible and accessible to everyone on the Members Portal          |
| Hidden     | Not listed on the Members Portal but accessible via a direct link |
| Private    | Only accessible to members who have been explicitly added         |
| Paid       | Requires purchase via the linked `TariffId` pricing plan          |

Courses can optionally display a community discussion group (`HasCommunityGroup`), be featured on the portal home page (`ShowInHomePage`), and be grouped together under a `GroupName` for easier navigation.

## Authentication

<Note>
  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 **`Course-List`** role.
</Note>

## Enums

<Accordion title="eCourseVisibility — Visibility values">
  | Value | Name    |
  | ----- | ------- |
  | 1     | Public  |
  | 2     | Hidden  |
  | 3     | Private |
  | 4     | Paid    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the Location this course belongs to.
</ParamField>

<ParamField type="string">
  Filter by location name.
</ParamField>

<ParamField type="string">
  Filter by location address.
</ParamField>

<ParamField type="string">
  Filter by location town or city.
</ParamField>

<ParamField type="string">
  Filter by location postal code.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker or administrator who hosts this course.
</ParamField>

<ParamField type="string">
  Filter by host full name.
</ParamField>

<ParamField type="string">
  Filter by host company name.
</ParamField>

<ParamField type="string">
  Filter by comma-separated list of teams the host belongs to.
</ParamField>

<ParamField type="string">
  Filter by course title displayed on the Members Portal.
</ParamField>

<ParamField type="string">
  Filter by short summary displayed under the course title on the Members Portal (up to \~400 characters).
</ParamField>

<ParamField type="string">
  Filter by full course description shown in the 'What's this course about?' section when customers open the course.
</ParamField>

<ParamField type="boolean">
  Filter by whether to display the overview section on the course page.
</ParamField>

<ParamField type="boolean">
  Filter by whether the course has an associated community discussion group on the Members Portal.
</ParamField>

<ParamField type="string">
  Filter by overview text displayed below the full description on the course page.
</ParamField>

<ParamField type="string">
  Filter by stored filename of the course thumbnail image (read-only; use `NewImageUrl` to set).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the existing thumbnail image.
</ParamField>

<ParamField type="string">
  Filter by stored filename of the course banner/large image (read-only; use `NewLargeImageUrl` to set).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the existing banner/large image.
</ParamField>

<ParamField type="boolean">
  Filter by whether the course is active and available to customers.
</ParamField>

<ParamField type="string">
  Filter by optional group label used to cluster related courses together on the Members Portal.
</ParamField>

<ParamField type="integer">
  Filter by position of the course in listing pages; lower numbers appear first.
</ParamField>

<ParamField type="boolean">
  Filter by whether the course is featured on the Members Portal home page.
</ParamField>

<ParamField type="integer">
  Filter by access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4).
</ParamField>

<ParamField type="integer">
  Filter by iD of the pricing plan (tariff) required to access this course when Visibility is Paid.
</ParamField>

<ParamField type="string">
  Filter by pricing plan name.
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in months).
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in weeks).
</ParamField>

<ParamField type="number">
  Filter by price of the pricing plan.
</ParamField>

<ParamField type="string">
  Filter by currency code of the pricing plan (e.g. USD, GBP).
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by position of the course in listing pages; lower numbers appear first greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by position of the course in listing pages; lower numbers appear first less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in months) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in months) less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in weeks) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by billing frequency of the pricing plan (in weeks) less than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price of the pricing plan greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by price of the pricing plan less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses?Course_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
      Course_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courses',
      params={
          'Course_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses?from_Course_UpdatedOn=2025-01-01T00:00&to_Course_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses?' + new URLSearchParams({
      from_Course_UpdatedOn: '2025-01-01T00:00',
      to_Course_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courses',
      params={
          'from_Course_UpdatedOn': '2025-01-01T00:00',
          'to_Course_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Course[]">
  The list of Course records matching the query. See the [Get one Course](/rest-api/content/get-courses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Course. The following fields are **not populated** in the `Records[]` response: `FullDescription`, `ShowOverview`, `OverviewText`, `Active`, `ShowInHomePage`, `Visibility`.

  To get all fields, fetch the full record using the [Get one Course](/rest-api/content/get-courses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessAddress": null,
      "BusinessTownCity": null,
      "BusinessPostalCode": null,
      "HostId": 0,
      "HostFullName": null,
      "HostCompanyName": null,
      "HostTeamNames": null,
      "Title": "",
      "SummaryText": null,
      "HasCommunityGroup": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "GroupName": null,
      "DisplayOrder": 0,
      "TariffId": null,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": null,
      "TariffCurrencyCode": 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": "Course Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple Courses
Source: https://learn.nexudus.com/rest-api/content/get-courses-batch

GET /api/content/courses/?id=[{id1},{id2},{id3}]
Retrieve multiple Course records by their Ids in a single request.

Fetch several Course records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`Course-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of Course Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/courses/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of Course records. Each record has the same structure as the response from the [Get one Course](/rest-api/content/get-courses-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each Course. The following fields are **not populated** in the response: `FullDescription`, `ShowOverview`, `OverviewText`, `Active`, `ShowInHomePage`, `Visibility`.

  To get all fields, fetch the full record using the [Get one Course](/rest-api/content/get-courses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "BusinessName": null,
    "BusinessAddress": null,
    "BusinessTownCity": null,
    "BusinessPostalCode": null,
    "HostId": 0,
    "HostFullName": null,
    "HostCompanyName": null,
    "HostTeamNames": null,
    "Title": "",
    "SummaryText": null,
    "HasCommunityGroup": false,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "LargeImageFileName": null,
    "NewLargeImageUrl": null,
    "ClearLargeImageFile": null,
    "GroupName": null,
    "DisplayOrder": 0,
    "TariffId": null,
    "TariffName": null,
    "TariffInvoiceEvery": null,
    "TariffInvoiceEveryWeeks": null,
    "TariffPrice": null,
    "TariffCurrencyCode": 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": "Course Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one Course
Source: https://learn.nexudus.com/rest-api/content/get-courses-by-id

GET /api/content/courses/{id}
Retrieve a single Course record by its Id.

A **Course** is a structured learning module published to customers through the Members Portal. Courses are organised into **sections** (milestones) and **lessons** (individual content units). They can be used for internal training, community building, or self-learning offers.

Courses belong to a Location and are assigned a Host (a customer or administrator) who is responsible for its content. You can control who can access a course using the `Visibility` field:

| Visibility | Meaning                                                           |
| ---------- | ----------------------------------------------------------------- |
| Public     | Visible and accessible to everyone on the Members Portal          |
| Hidden     | Not listed on the Members Portal but accessible via a direct link |
| Private    | Only accessible to members who have been explicitly added         |
| Paid       | Requires purchase via the linked `TariffId` pricing plan          |

Courses can optionally display a community discussion group (`HasCommunityGroup`), be featured on the portal home page (`ShowInHomePage`), and be grouped together under a `GroupName` for easier navigation.

## Authentication

<Note>
  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 **`Course-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the Course record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/courses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/courses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the Location this course belongs to.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessAddress" type="string">
  Location address.
</ResponseField>

<ResponseField name="BusinessTownCity" type="string">
  Location town or city.
</ResponseField>

<ResponseField name="BusinessPostalCode" type="string">
  Location postal code.
</ResponseField>

<ResponseField name="HostId" type="integer">
  ID of the coworker or administrator who hosts this course.
</ResponseField>

<ResponseField name="HostFullName" type="string">
  Host full name.
</ResponseField>

<ResponseField name="HostCompanyName" type="string">
  Host company name.
</ResponseField>

<ResponseField name="HostTeamNames" type="string">
  Comma-separated list of teams the host belongs to.
</ResponseField>

<ResponseField name="Title" type="string">
  Course title displayed on the Members Portal.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short summary displayed under the course title on the Members Portal (up to \~400 characters).
</ResponseField>

<ResponseField name="FullDescription" type="string">
  Full course description shown in the 'What's this course about?' section when customers open the course.
</ResponseField>

<ResponseField name="ShowOverview" type="boolean">
  Whether to display the overview section on the course page.
</ResponseField>

<ResponseField name="HasCommunityGroup" type="boolean">
  Whether the course has an associated community discussion group on the Members Portal.
</ResponseField>

<ResponseField name="OverviewText" type="string">
  Overview text displayed below the full description on the course page.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Stored filename of the course thumbnail image (read-only; use `NewImageUrl` to set).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the existing thumbnail image.
</ResponseField>

<ResponseField name="LargeImageFileName" type="string">
  Stored filename of the course banner/large image (read-only; use `NewLargeImageUrl` to set).
</ResponseField>

<ResponseField name="NewLargeImageUrl" type="string">
  URL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ResponseField>

<ResponseField name="ClearLargeImageFile" type="boolean">
  Set to true to remove the existing banner/large image.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the course is active and available to customers.
</ResponseField>

<ResponseField name="GroupName" type="string">
  Optional group label used to cluster related courses together on the Members Portal.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Position of the course in listing pages; lower numbers appear first.
</ResponseField>

<ResponseField name="ShowInHomePage" type="boolean">
  Whether the course is featured on the Members Portal home page.
</ResponseField>

<ResponseField name="Visibility" type="integer">
  Access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4). See `eCourseVisibility` enum values: `1` = Public, `2` = Hidden, `3` = Private, `4` = Paid.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  ID of the pricing plan (tariff) required to access this course when Visibility is Paid.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Pricing plan name.
</ResponseField>

<ResponseField name="TariffInvoiceEvery" type="integer">
  Billing frequency of the pricing plan (in months).
</ResponseField>

<ResponseField name="TariffInvoiceEveryWeeks" type="integer">
  Billing frequency of the pricing plan (in weeks).
</ResponseField>

<ResponseField name="TariffPrice" type="number">
  Price of the pricing plan.
</ResponseField>

<ResponseField name="TariffCurrencyCode" type="string">
  Currency code of the pricing plan (e.g. USD, GBP).
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessAddress": null,
  "BusinessTownCity": null,
  "BusinessPostalCode": null,
  "HostId": 0,
  "HostFullName": null,
  "HostCompanyName": null,
  "HostTeamNames": null,
  "Title": "",
  "SummaryText": null,
  "FullDescription": null,
  "ShowOverview": false,
  "HasCommunityGroup": false,
  "OverviewText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "Active": false,
  "GroupName": null,
  "DisplayOrder": 0,
  "ShowInHomePage": false,
  "Visibility": 0,
  "TariffId": null,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": null,
  "TariffCurrencyCode": 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": "Course Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search CourseSections
Source: https://learn.nexudus.com/rest-api/content/get-coursesections

GET /api/content/coursesections
Search and list CourseSection records with filtering, sorting, and pagination.

A **CourseSection** is a structural grouping that organises lessons within a `Course`. Sections represent milestones or learning stages — each section should bring the member one step closer to the course's overall learning goal.

Sections are ordered by `DisplayOrder` and can be set to unlock immediately or after a delay, using the same `UnlockType` / `UnlockAfterDays` mechanism as individual lessons:

| UnlockType | Meaning                                                          |
| ---------- | ---------------------------------------------------------------- |
| Immediate  | Section is available as soon as the member enrols                |
| Sequential | Unlocked only after the previous section is completed            |
| Timed      | Unlocked after the number of days specified by `UnlockAfterDays` |

Sections are optional — lessons can belong directly to a course without a section. However, using sections can help create a clearer learning path for members, and allows you to unlock groups of lessons at once.

## Authentication

<Note>
  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 **`CourseSection-List`** role.
</Note>

## Enums

<Accordion title="eLessonUnlockType — UnlockType values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Immediate  |
  | 2     | Sequential |
  | 3     | Timed      |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the course this section belongs to.
</ParamField>

<ParamField type="string">
  Filter by title of the parent course.
</ParamField>

<ParamField type="string">
  Filter by section title displayed to members.
</ParamField>

<ParamField type="string">
  Filter by optional HTML or rich-text introductory content shown at the top of the section.
</ParamField>

<ParamField type="boolean">
  Filter by whether the section is active and visible to enrolled members.
</ParamField>

<ParamField type="integer">
  Filter by position of the section within the course; lower numbers appear first.
</ParamField>

<ParamField type="integer">
  Filter by when the section becomes available: Immediate (1), after the previous section is done — Sequential (2), or after a set number of days — Timed (3).
</ParamField>

<ParamField type="string">
  Filter by stored filename of the section thumbnail image (read-only; use `NewImageUrl` to set).
</ParamField>

<ParamField type="string">
  Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the existing thumbnail image.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3).
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by position of the section within the course; lower numbers appear first greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by position of the section within the course; lower numbers appear first less than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3) greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3) less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursesections?page=1&size=15&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Title',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursesections',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Title

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursesections?CourseSection_Title=example-value&orderBy=Title&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
      CourseSection_Title: 'example-value',
      orderBy: 'Title',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursesections',
      params={
          'CourseSection_Title': 'example-value',
          'orderBy': 'Title',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursesections?from_CourseSection_UpdatedOn=2025-01-01T00:00&to_CourseSection_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
      from_CourseSection_UpdatedOn: '2025-01-01T00:00',
      to_CourseSection_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursesections',
      params={
          'from_CourseSection_UpdatedOn': '2025-01-01T00:00',
          'to_CourseSection_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CourseSection[]">
  The list of CourseSection records matching the query. See the [Get one CourseSection](/rest-api/content/get-coursesections-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CourseSection. The following fields are **not populated** in the `Records[]` response: `SectionContents`, `UnlockType`.

  To get all fields, fetch the full record using the [Get one CourseSection](/rest-api/content/get-coursesections-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CourseId": 0,
      "CourseTitle": null,
      "Title": "",
      "Active": false,
      "DisplayOrder": 0,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "UnlockAfterDays": 0,
      "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": "CourseSection Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple CourseSections
Source: https://learn.nexudus.com/rest-api/content/get-coursesections-batch

GET /api/content/coursesections/?id=[{id1},{id2},{id3}]
Retrieve multiple CourseSection records by their Ids in a single request.

Fetch several CourseSection records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`CourseSection-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of CourseSection Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursesections/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/coursesections/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of CourseSection records. Each record has the same structure as the response from the [Get one CourseSection](/rest-api/content/get-coursesections-by-id) endpoint.

<Warning>
  **Partial records** — This endpoint returns a summary representation of each CourseSection. The following fields are **not populated** in the response: `SectionContents`, `UnlockType`.

  To get all fields, fetch the full record using the [Get one CourseSection](/rest-api/content/get-coursesections-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

```json Example Response theme={null}
[
  {
    "CourseId": 0,
    "CourseTitle": null,
    "Title": "",
    "Active": false,
    "DisplayOrder": 0,
    "ImageFileName": null,
    "NewImageUrl": null,
    "ClearImageFile": null,
    "UnlockAfterDays": 0,
    "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": "CourseSection Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one CourseSection
Source: https://learn.nexudus.com/rest-api/content/get-coursesections-by-id

GET /api/content/coursesections/{id}
Retrieve a single CourseSection record by its Id.

A **CourseSection** is a structural grouping that organises lessons within a `Course`. Sections represent milestones or learning stages — each section should bring the member one step closer to the course's overall learning goal.

Sections are ordered by `DisplayOrder` and can be set to unlock immediately or after a delay, using the same `UnlockType` / `UnlockAfterDays` mechanism as individual lessons:

| UnlockType | Meaning                                                          |
| ---------- | ---------------------------------------------------------------- |
| Immediate  | Section is available as soon as the member enrols                |
| Sequential | Unlocked only after the previous section is completed            |
| Timed      | Unlocked after the number of days specified by `UnlockAfterDays` |

Sections are optional — lessons can belong directly to a course without a section. However, using sections can help create a clearer learning path for members, and allows you to unlock groups of lessons at once.

## Authentication

<Note>
  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 **`CourseSection-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the CourseSection record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/coursesections/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/coursesections/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CourseId" type="integer">
  ID of the course this section belongs to.
</ResponseField>

<ResponseField name="CourseTitle" type="string">
  Title of the parent course.
</ResponseField>

<ResponseField name="Title" type="string">
  Section title displayed to members.
</ResponseField>

<ResponseField name="SectionContents" type="string">
  Optional HTML or rich-text introductory content shown at the top of the section.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the section is active and visible to enrolled members.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Position of the section within the course; lower numbers appear first.
</ResponseField>

<ResponseField name="UnlockType" type="integer">
  When the section becomes available: Immediate (1), after the previous section is done — Sequential (2), or after a set number of days — Timed (3). See `eLessonUnlockType` enum values: `1` = Immediate, `2` = Sequential, `3` = Timed.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Stored filename of the section thumbnail image (read-only; use `NewImageUrl` to set).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the existing thumbnail image.
</ResponseField>

<ResponseField name="UnlockAfterDays" type="integer">
  Number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3).
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CourseId": 0,
  "CourseTitle": null,
  "Title": "",
  "SectionContents": null,
  "Active": false,
  "DisplayOrder": 0,
  "UnlockType": 0,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "UnlockAfterDays": 0,
  "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": "CourseSection Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search DataFiles
Source: https://learn.nexudus.com/rest-api/content/get-datafiles

GET /api/content/datafiles
Search and list DataFile records with filtering, sorting, and pagination.

A **DataFile** stores a general-purpose file that can be referenced in the members portal, invoices, or email messages and templates sent to customers.

URLs for stored files are public. Use `NewFileDataUrl` to attach a file from a URL during create or update, and `ClearFileDataFile` to remove the currently attached file.

## Authentication

<Note>
  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 **`DataFile-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the file.
</ParamField>

<ParamField type="string">
  Filter by optional description of the file.
</ParamField>

<ParamField type="string">
  Filter by original filename of the uploaded file.
</ParamField>

<ParamField type="string">
  Filter by public URL pointing to the file to upload. Set during create or update to attach a new file.
</ParamField>

<ParamField type="boolean">
  Filter by set to true to remove the currently attached file.
</ParamField>

<ParamField type="integer">
  Filter by size of the uploaded file in bytes.
</ParamField>

### Range Filters

<ParamField type="integer">
  Filter by size of the uploaded file in bytes greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by size of the uploaded file in bytes less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/datafiles?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/datafiles',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/datafiles?DataFile_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles?' + new URLSearchParams({
      DataFile_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/datafiles',
      params={
          'DataFile_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/datafiles?from_DataFile_UpdatedOn=2025-01-01T00:00&to_DataFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles?' + new URLSearchParams({
      from_DataFile_UpdatedOn: '2025-01-01T00:00',
      to_DataFile_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/datafiles',
      params={
          'from_DataFile_UpdatedOn': '2025-01-01T00:00',
          'to_DataFile_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="DataFile[]">
  The list of DataFile records matching the query. See the [Get one DataFile](/rest-api/content/get-datafiles-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Description": null,
      "FileDataFileName": null,
      "NewFileDataUrl": null,
      "ClearFileDataFile": null,
      "FileSizeBytes": 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": "DataFile Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


# Get multiple DataFiles
Source: https://learn.nexudus.com/rest-api/content/get-datafiles-batch

GET /api/content/datafiles/?id=[{id1},{id2},{id3}]
Retrieve multiple DataFile records by their Ids in a single request.

Fetch several DataFile records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

## Authentication

<Note>
  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 **`DataFile-Read`** role.
</Note>

## Query Parameters

<ParamField type="integer[]">
  A comma-separated list of DataFile Ids enclosed in square brackets, e.g. `[123,456,789]`.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/datafiles/?id=[87654321,87654322,87654323]" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles/?id=[87654321,87654322,87654323]',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const records = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/datafiles/',
      params={
          'id': '[87654321,87654322,87654323]'
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  records = response.json()
  ```
</CodeGroup>

## Response

### 200

Returns an array of DataFile records. Each record has the same structure as the response from the [Get one DataFile](/rest-api/content/get-datafiles-by-id) endpoint.

```json Example Response theme={null}
[
  {
    "BusinessId": 0,
    "Name": "",
    "Description": null,
    "FileDataFileName": null,
    "NewFileDataUrl": null,
    "ClearFileDataFile": null,
    "FileSizeBytes": 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": "DataFile Example",
    "LocalizationDetails": null,
    "CustomFields": null
  }
]
```


# Get one DataFile
Source: https://learn.nexudus.com/rest-api/content/get-datafiles-by-id

GET /api/content/datafiles/{id}
Retrieve a single DataFile record by its Id.

A **DataFile** stores a general-purpose file that can be referenced in the members portal, invoices, or email messages and templates sent to customers.

URLs for stored files are public. Use `NewFileDataUrl` to attach a file from a URL during create or update, and `ClearFileDataFile` to remove the currently attached file.

## Authentication

<Note>
  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 **`DataFile-Read`** role.
</Note>

## Path Parameters

<ParamField type="integer">
  The Id of the DataFile record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/datafiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/datafiles/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the file.
</ResponseField>

<ResponseField name="Description" type="string">
  Optional description of the file.
</ResponseField>

<ResponseField name="FileDataFileName" type="string">
  Original filename of the uploaded file.
</ResponseField>

<ResponseField name="NewFileDataUrl" type="string">
  Public URL pointing to the file to upload. Set during create or update to attach a new file.
</ResponseField>

<ResponseField name="ClearFileDataFile" type="boolean">
  Set to true to remove the currently attached file.
</ResponseField>

<ResponseField name="FileSizeBytes" type="integer">
  Size of the uploaded file in bytes.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "FileDataFileName": null,
  "NewFileDataUrl": null,
  "ClearFileDataFile": null,
  "FileSizeBytes": 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": "DataFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


# Search EventAttendees
Source: https://learn.nexudus.com/rest-api/content/get-eventattendees

GET /api/content/eventattendees
Search and list EventAttendee records with filtering, sorting, and pagination.

An **EventAttendee** records a customer's registration for a calendar event. Each record links a customer to an event and tracks attendance details such as check-in status and whether the attendee was invoiced.

## Authentication

<Note>
  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 **`EventAttendee-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField type="integer">
  The page number to retrieve.
</ParamField>

<ParamField type="integer">
  The number of records per page.
</ParamField>

<ParamField type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField type="integer">
  Filter by iD of the calendar event linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the linked calendar event (read-only).
</ParamField>

<ParamField type="integer">
  Filter by iD of the event product linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the linked event product (read-only).
</ParamField>

<ParamField type="number">
  Filter by the event product price value for this event attendee.
</ParamField>

<ParamField type="string">
  Filter by the event product currency code value for this event attendee.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField type="string">
  Filter by display name of the linked coworker full (read-only).
</ParamField>

<ParamField type="string">
  Filter by the full name value for this event attendee.
</ParamField>

<ParamField type="string">
  Filter by the email value for this event attendee.
</ParamField>

<ParamField type="string">
  Filter by the purchase order value for this event attendee.
</ParamField>

<ParamField type="string">
  Filter by the attendee code value for this event attendee.
</ParamField>

<ParamField type="boolean">
  Filter by whether checked in is enabled.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date.
</ParamField>

<ParamField type="boolean">
  Filter by whether invoiced is enabled.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date.
</ParamField>

<ParamField type="boolean">
  Filter by whether billed is enabled.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date local.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice associated with this record.
</ParamField>

<ParamField type="string">
  Filter by the coworker invoice number value for this event attendee.
</ParamField>

<ParamField type="boolean">
  Filter by whether coworker invoice paid is enabled.
</ParamField>

<ParamField type="boolean">
  Filter by whether reminded is enabled.
</ParamField>

<ParamField type="string">
  Filter by the zoom event data value for this event attendee.
</ParamField>

<ParamField type="string">
  Filter by iD of the zoom participant associated with this record.
</ParamField>

<ParamField type="boolean">
  Filter by whether is sent is enabled.
</ParamField>

### Range Filters

<ParamField type="number">
  Filter by the event product price value for this event attendee greater than or equal to this value.
</ParamField>

<ParamField type="number">
  Filter by the event product price value for this event attendee less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for created on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter by date/time value for checked in date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice associated with this record greater than or equal to this value.
</ParamField>

<ParamField type="integer">
  Filter by iD of the coworker invoice associated with this record less than or equal to this value.
</ParamField>

<ParamField type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/eventattendees?page=1&size=15&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventattendees?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'FullName',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/eventattendees',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by FullName

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/eventattendees?EventAttendee_FullName=example-value&orderBy=FullName&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventattendees?' + new URLSearchParams({
      EventAttendee_FullName: 'example-value',
      orderBy: 'FullName',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/eventattendees',
      params={
          'EventAttendee_FullName': 'example-value',
          'orderBy': 'FullName',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/eventattendees?from_EventAttendee_UpdatedOn=2025-01-01T00:00&to_EventAttendee_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/eventattendees?' + new URLSearchParams({
      from_EventAttendee_UpdatedOn: '2025-01-01T00:00',
      to_EventAttendee_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/eventattendees',
      params={
          'from_EventAttendee_UpdatedOn': '2025-01-01T00:00',
          'to_EventAttendee_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="EventAttendee[]">
  The list of EventAttendee records matching the query. See the [Get one EventAttendee](/rest-api/content/get-eventattendees-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each EventAttendee. The following fields are **not populated** in the `Records[]` response: `Email`, `PurchaseOrder`, `CheckedInDate`.

  To get all fields, fetch the full record using the [Get one EventAttendee](/rest-api/content/get-eventattendees-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your