Skip to content

Business Management (1.0.0)

Full-featured B2B API for business operations.

Base URL: https://api.alteg.io/api

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Online Booking Settings

Configure online booking behavior and forms

Operations

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Freeze membership

Request

Freezes a subscription (membership) until the specified date.

The subscription's expiration date will be extended by the freeze period. Frozen subscriptions cannot be used for appointments.

Requirements:

  • Membership type must have allow_freeze: true
  • Freeze period must not exceed freeze_limit from membership type

Note: Requires chain-level permissions.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
membership_idintegerrequired

Membership ID to freeze

Example: 123
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
freeze_tillstring(date-time)required

Date until which the membership will be frozen (ISO 8601 format)

Example: "2026-12-31T23:59:59-05:00"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/abonements/123/freeze \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "freeze_till": "2026-12-31T23:59:59-05:00"
  }'

Responses

Subscription frozen successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "number": "123456",
    "is_frozen": true,
    "freeze_period": 14,
    "freeze_till": "2026-12-31T23:59:59-05:00"
  },
  "meta": []
}

Unfreeze membership

Request

Removes the freeze from a subscription (membership).

The subscription's expiration date will remain extended by the freeze period that was already applied during the freeze.

Note: Requires chain-level permissions.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
membership_idintegerrequired

Membership ID to unfreeze

Example: 123
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/json
object

Empty body required (or omit entirely)

curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/abonements/123/unfreeze \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Subscription unfrozen successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "number": "123456",
    "is_frozen": false,
    "freeze_period": 14
  },
  "meta": []
}

Change membership balance

Request

Modifies the remaining visit count for a subscription (membership).

For unified balance subscriptions:

  • Use united_balance_services_count to set total visits

For separate balance subscriptions:

  • Use services_balance_count array with service_id and balance for each service/category

Use cases:

  • Adjust balance after administrative changes
  • Correct errors in visit counts
  • Add bonus visits

Note: Requires chain-level permissions.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
membership_idintegerrequired

Membership ID

Example: 123
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
united_balance_services_countinteger

New visit count for unified balance subscriptions

Example: 10
services_balance_countArray of objects

New balance for separate balance subscriptions (per service/category)

Example: [{"service_id":13160808,"balance":5},{"service_id":13160809,"balance":3}]
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/loyalty/abonements/123/set_balance \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "united_balance_services_count": 10,
    "services_balance_count": [
      {
        "service_id": 13160808,
        "balance": 5
      },
      {
        "service_id": 13160809,
        "balance": 3
      }
    ]
  }'

Responses

Balance updated successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "united_balance_services_count": 10,
    "balance_container": {}
  },
  "meta": []
}

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations