Skip to content
/
Cancel Withdrawal from th...

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

Apply Deduction from the Loyalty Card in the Visit

Request

The amount deducted will not exceed the available bonus balance. If the value is set to 0, no write-off transaction will occur

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

card_idnumberrequired

Client card ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Body*/*required
amountnumberrequired

Number of points to redeem

Example: 100
record_idnumberrequired

Appointment ID

Example: 140967944
visit_idnumberrequired

Visit ID

Example: 118389447
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

OK

Bodyapplication/json
payment_transactionsArray of objects

Array with information about the financial transactions of the appointment

Example: []
loyalty_transactionsArray of objects

An array with information about applied loyalty transactions in a visit

Example: [{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"}}]
kkm_transaction_details_containerobject

An object that holds details about transactions recorded by the POS system

Example: {"last_operation_type":1,"transactions":[]}
itemsArray of objects

Array with information about products and services of the appointment

Example: [{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]
Response
application/json
{
  "payment_transactions": [],
  "loyalty_transactions": [
    { … }
  ],
  "kkm_transaction_details_container": {
    "last_operation_type": 1,
    "transactions": []
  },
  "items": [
    { … },
    { … }
  ]
}

Cancel Withdrawal from the Loyalty Card During the Visit

Request

Cancellation of write-off from the loyalty card.

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

card_idnumberrequired

Client card ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Body*/*required
record_idnumberrequired

Appointment ID

visit_idnumberrequired

Visit ID

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/cancel_card_withdrawal/{location_id}/{card_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

OK

Bodyapplication/json
payment_transactionsArray of objects

Array with information about the financial transactions of the appointment

Example: []
loyalty_transactionsArray of objects

An array with information about applied loyalty transactions in a visit

Example: []
kkm_transaction_details_containerobject

An object that holds details about transactions recorded by the POS system

Example: {"last_operation_type":1,"transactions":[]}
itemsArray of objects

Array with information about products and services of the appointment

Example: [{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]
Response
application/json
{
  "payment_transactions": [],
  "loyalty_transactions": [],
  "kkm_transaction_details_container": {
    "last_operation_type": 1,
    "transactions": []
  },
  "items": [
    { … },
    { … }
  ]
}

Apply a Discount Promotion in a Visit

Request

Applying a promotion to a visit, it only makes sense if there is a visit

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

card_idnumberrequired

Client card ID

program_idnumberrequired

ID of the promotion linked to the card

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
record_idnumberrequired

Appointment ID

visit_idnumberrequired

Visit ID

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/visit/loyalty/apply_discount_program/{location_id}/{card_id}/{program_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "record_id": 0,
    "visit_id": 0
  }'

Responses

OK

Bodyapplication/json
payment_transactionsArray of objects

Array with information about the financial transactions of the appointment

Example: []
loyalty_transactionsArray of objects

An array with information about applied loyalty transactions in a visit

Example: [{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"}}]
kkm_transaction_details_containerobject

An object that holds details about transactions recorded by the POS system

Example: {"last_operation_type":1,"transactions":[]}
itemsArray of objects

Array with information about products and services of the appointment

Example: [{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]
Response
application/json
{
  "payment_transactions": [],
  "loyalty_transactions": [
    { … }
  ],
  "kkm_transaction_details_container": {
    "last_operation_type": 1,
    "transactions": []
  },
  "items": [
    { … },
    { … }
  ]
}

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

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations