Skip to content
/
Create a client account t...

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

Get a list of client accounts by chain and customer phone number

Request

Security
BearerPartnerUser
Path
chain_idnumberrequired

Chain ID

phonenumberrequired

Customer phone number

Headers
Acceptstring

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/deposits/chain/{chain_id}/phone/{phone}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}

Create a client account topup operation

Request

Creating a transaction with a client account involves creating a document, a transaction with a client account, and a financial transaction within a single API request.

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Body*/*
account_idnumberrequired

Checkout ID for payment

amountnumberrequired

replenishment amount

client_idnumberrequired

ID of the client, the owner of the client account

deposit_idnumberrequired

client account ID

master_idnumber

team member ID

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/deposits_operations/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"document":{"id":1,"user_id":1,"salon_id":1,"type_id":9,"type":{"id":9,"title":"Account replenishment (advance payment)"},"comment":"","number":1,"salon":{"id":1,"title":"Location in New York","public_title":"Location in New York","business_group_id":1,"business_type_id":1,"country_id":7,"city_id":2,"timezone":"-5","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"http://app.alteg.io/images/icon.png","zip":"129090","phone":"+13155550175","phones":[],"site":"www.example.com","allow_delete_record":true,"allow_change_record":true},"user":{"id":1,"name":"James Smith","phone":"+13155550175"}},"deposits_transactions":[{"id":1,"salon_id":1,"salon_group_id":1,"document_id":1,"deposit_id":1,"deposit_type_id":1,"master_id":1,"user_id":1,"amount":100.5,"comment":"","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false,"deposit":{"id":1,"deposit_type_id":1,"salon_group_id":1,"initial_balance":10000,"balance":12239.56,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type 1","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false}}],"payment_transactions":[{"id":1,"document_id":1,"date":"2026-09-21T23:00:00.000-05:00","type_id":10,"expense_id":10,"account_id":1,"amount":100.5,"client_id":1,"master_id":1,"supplier_id":0,"comment":"","item_id":1,"target_type_id":0,"record_id":0,"goods_transaction_id":0,"type":{"id":10,"title":"Refill"}}]}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "document": { … },
    "deposits_transactions": [ … ],
    "payment_transactions": [ … ]
  },
  "meta": []
}

Get client account transaction history

Request

Retrieves the transaction history for a specific client account in the chain.

Returns a list of all transactions (top-ups, withdrawals, etc.) made on the client account.

Note: Requires chain-level permissions.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example: 706028
deposit_idintegerrequired

Client account ID

Example: 12345
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chain/706028/deposits/12345/history \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Transaction history retrieved successfully

Bodyapplication/json
successboolean
Example: true
dataArray of objects
metaArray of arrays
Example: []
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "meta": []
}

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

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations