Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| getAllAddresses | Get all addresses associated with specified accounts |
| addAddresses | Add new addresses to accounts |
| getAllCustomers | Get customers with filters. Note: At least one filter must be provided (CustomerIds, Emails, FirstNames, LastNames, LoyaltyCodes, CompanyIds, CreatedUtc, UpdatedUtc, or DeletedUtc). If no filters are specified, defaults to ActivityStates: ["Active"] to return all active customers. IMPORTANT LIMITATIONS: Date range filters (CreatedUtc, UpdatedUtc, DeletedUtc) have a maximum interval of 3 months and 1 day. All array filters have specific maximum item limits (typically 1000, except CompanyIds which is limited to 1). |
| addCustomer | Create a new customer |
| updateCustomers | Updates personal information of existing customers |
| deleteCustomers | Deletes specified customers |
| mergeCustomers | Merges two customers together |
| getAllCompanies | Returns all companies, optionally filtered by criteria |
| addCompany | Adds a new company |
| updateCompanies | Updates company information |
| deleteCompanies | Deletes specified companies |
| getAllReservations | Get reservations with filters. Note: The time interval between StartUtc and EndUtc must not exceed 100 hours. |
| addReservation | Adds a new reservation with the specified details |
| updateReservations | Updates reservation properties |
| cancelReservations | Cancels specified reservations |
| getConfiguration | Returns configuration of the enterprise and the client |
| getAllCountries | Returns all countries supported by the API |
| getAllCurrencies | Returns all currencies supported by the API |
| getAllTaxEnvironments | Returns all tax environments supported by the API |
| getAllTaxations | Returns all taxations supported in tax environments |
| getAllLanguages | Returns all languages supported by the API |
| getLanguageTexts | Returns translations of texts in the specified languages |
| getAllBills | Returns all bills by filter parameters, used for retrieving billing information |
| getAllAccountingItems | Returns all accounting items (charges, payments, etc.) based on filter parameters. REQUIRED: At least one of the following filters must be specified: AccountingItemIds, RebatedItemIds, ClosedUtc, ConsumedUtc, or UpdatedUtc. |
| addAccountingItems | Adds new accounting items (charges, payments, etc.) to customer bills |
| addPayment | Adds a new payment to a customer's bill |
| chargeCreditCard | Charges a credit card and adds the resulting payment to a customer bill |
| getAllPayments | Returns all payments based on filter parameters |
| getAllServices | Returns all services offered by the enterprise |
| getAllSpaces | Returns all spaces of the enterprise, or only those specified |
| getAllSpaceCategories | Returns all space categories of a service |
| getAllAccountNotes | Returns all the account notes associated with the specified accounts within the chain |
| addAccountNotes | Adds new account notes to the system and assigns them to specified accounts |
| getAllRates | Returns all rates (pricing) of the enterprise |
| getRatePricing | Returns prices of rates during the specified period |
| exportAccountingItems | Exports accounting items (charges, payments, etc.) in the specified format and period |
| exportReservations | Exports reservations in the specified format and period |
| getAllAvailabilityBlocks | Returns all availability blocks (reservations blocked by rate, space category, or space) based on filter parameters. Note: At least one filter must be provided (CreatedUtc, UpdatedUtc, CollidingUtc, AvailabilityBlockIds, or ExternalIdentifiers). The time interval must not exceed 100 hours. |
| addVouchers | Adds new vouchers (discount codes, gift certificates) to the system |
| getAllTasks | Returns all tasks of the enterprise, filtered by identifiers or other filters. REQUIRED: At least one filter must be provided (TaskIds, DepartmentIds, ServiceOrderIds, CreatedUtc, ClosedUtc, or DeadlineUtc). LIMITATIONS: Date range filters (CreatedUtc, ClosedUtc, DeadlineUtc) have a maximum interval of 3 months and 1 day. Array filters (TaskIds, DepartmentIds, ServiceOrderIds) are limited to 1000 items each. The Limitation parameter with Count is mandatory for pagination. |
| addTask | Adds a new task to the enterprise, optionally to a specified department |
| getAllLoyaltyMemberships | Returns all loyalty memberships of the enterprise, optionally filtered by specific loyalty membership identifiers, activity states, or other filter parameters. Note this operation uses Pagination and supports Portfolio Access Tokens. |
| addLoyaltyMemberships | Adds new loyalty memberships to the system |
| updateLoyaltyMemberships | Updates information about the specified loyalty memberships. Note this operation supports Portfolio Access Tokens. |
| deleteLoyaltyMemberships | Deletes loyalty memberships |
| getAllLoyaltyPrograms | Returns all loyalty programs of the enterprise, optionally filtered by specific loyalty program identifiers or other filter parameters. |
| addLoyaltyPrograms | Adds new loyalty programs to the system |
| updateLoyaltyPrograms | Updates information about the specified loyalty programs |
| deleteLoyaltyPrograms | Deletes loyalty programs |
| getAllLoyaltyTiers | Returns all loyalty tiers of the enterprise, optionally filtered by specific loyalty tier identifiers or other filter parameters. |
| addLoyaltyTiers | Adds new loyalty tiers to the system |
| updateLoyaltyTiers | Updates information about the specified loyalty tiers |
| deleteLoyaltyTiers | Deletes loyalty tiers |