Skip to content
/
Create document

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

Create an inventory operation

Request

An inventory operation is created by submitting a document along with multiple product transactions in a single API request. If a payment type is specified, the corresponding financial transactions will be generated automatically.

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*/*required
create_datestring(date-time)required

Document creation date

Example: "2026-09-21T23:00:00.000-05:00"
goods_transactionsArray of objectsrequired

An array of objects containing transaction parameters, similar to a request to create a product transaction

storage_idnumberrequired

Inventory ID

Example: 91271
type_idnumberrequired

Document type (Sale 1, Usage / Material Consumption 2, Product Receipt / Incoming 3, Inventory Write-off / Product Disposal 4, Internal Transfer 5)

Example: 1
commentstring

A comment

Example: "test document comment"
master_idnumber

team member ID

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/storage_operations/operation/{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":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":91271,"user_id":999290,"company_id":4564,"number":1254,"comment":"test document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":91271,"title":"Secret place"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"transactions":[{"id":3428012,"document_id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":91271,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":91271,"title":"Secret place"},"supplier":[],"client":[],"master":[],"unit":{"id":1,"title":"Thing"}}]}
metaArray of objects

Metadata (empty array)

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

Create document

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

Bodyapplication/jsonrequired
create_datestring(date-time)required

Date of the inventory transaction

Example: "2026-09-21T23:00:00.000-05:00"
storage_idnumberrequired

Inventory ID

Example: 36539
type_idnumberrequired

Document type (sale 1, receipt 3, write-off 7)

Example: 1
commentstring

A comment

Example: "Document comment"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/storage_operations/documents/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type_id": 1,
    "comment": "Document comment",
    "storage_id": 36539,
    "create_date": "2026-09-21T23:00:00.000-05:00"
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 22255503,
    "type_id": 1,
    "type": { … },
    "storage_id": 36539,
    "user_id": 999290,
    "company_id": 4564,
    "number": 1251,
    "comment": "Document comment",
    "create_date": "2026-04-24 20:00:00",
    "storage": { … },
    "company": { … },
    "user": { … }
  },
  "meta": []
}

Get document

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

document_idnumberrequired

Document 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

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/storage_operations/documents/{location_id}/{document_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 22255503,
    "type_id": 1,
    "type": { … },
    "storage_id": 36539,
    "user_id": 999290,
    "company_id": 4564,
    "number": 1251,
    "comment": "Document comment",
    "create_date": "2026-04-24 20:00:00",
    "storage": { … },
    "company": { … },
    "user": { … }
  },
  "meta": []
}

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

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations