User authentication and session management for B2B integrations
Business Management (1.0.0)
Full-featured B2B API for business operations.
Base URL: https://api.alteg.io/api
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/sale/{document_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Object with data
Example: {"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"type":{"id":5,"title":"deposit 1"}}}]}
Response
application/json
{ "success": true, "data": { "state": { … }, "kkm_state": { … }, "payment_methods": [ … ] }, "meta": [] }
Bodyapplication/jsonrequired
- In the case of payment by a gift card, if the user does not have the "Pay by gift card and membership without code" right, the "number" (string) parameter containing the gift card code must also be passed in the request body.
- In the case of payment by membership, if the user does not have the "Pay by gift card and membership without code" right, the "number" (string) parameter containing the membership code must also be passed in the request body.
Any of:
- Payment at the checkout
- Payment via client personal account
- Payment with a gift card
- Payment with membership - works only for the visit
- Pay with referral program - works only for visit
- Pay with a loyalty card
- Pay with a loyalty program
Payment at the checkout
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}/payment
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/sale/{document_id}/payment
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}/payment' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"payment": {
"method": {
"slug": "account",
"account_id": 90218
},
"amount": 123
}
}'OK
Object with data
Example: {"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"type":{"id":5,"title":"deposit 1"}}}]}
Response
application/json
{ "success": true, "data": { "state": { … }, "kkm_state": { … }, "payment_methods": [ … ] }, "meta": [] }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Object with data
Example: {"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"type":{"id":5,"title":"deposit 1"}}}]}
Response
application/json
{ "success": true, "data": { "state": { … }, "kkm_state": { … }, "payment_methods": [ … ] }, "meta": [] }