Создание онлайн заказа по API: различия между версиями
Merkulov (обсуждение | вклад)  | 
				Sobolev (обсуждение | вклад)   | 
				||
| (не показаны 33 промежуточные версии 3 участников) | |||
| Строка 1: | Строка 1: | ||
= CASHDESK API=  | |||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.  | '''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.  | ||
Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться <b>[https://kassa.bifit.com/wiki/index.php?title=ИНСТРУКЦИИ:Авторизация_при_интеграции_по_API здесь]</b>.  | Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться <b>[https://kassa.bifit.com/wiki/index.php?title=ИНСТРУКЦИИ:Авторизация_при_интеграции_по_API здесь]</b>.  | ||
= Нумераторы =  | |||
{{ProductTable-2  | |||
|title-left='''TaxSystem''' - cистема налогообложения (тэг 1055). Если при регистрации устройства в ФНС было выбрано более одного режима налогообложения, то в '''TaxSystem''' необходимо указать, к какой системе налогообложения относится данный чек.  | |||
|title-right=  | |||
|content-left=  | |||
   | |||
* '''COMMON'''  | |||
* '''SIMPLIFIED'''  | |||
* '''SIMPLIFIED_WITH_EXPENSE'''  | |||
* '''COMMON_AGRICULTURAL'''  | |||
* '''PATENT'''  | |||
|content-right=  | |||
   | |||
* ОСН  | |||
* УСН доход  | |||
* УСН доход - расход  | |||
* ЕСХН  | |||
* ПАТЕНТ  | |||
|}}<br>  | |||
{{ProductTable-2  | |||
|title-left='''CalculationMethod''' - признак способа расчета (тэг 1214).  | |||
|title-right=  | |||
|content-left=  | |||
   | |||
* '''PREPAY_FULL'''  | |||
* '''PREPAY_PARTIAL '''  | |||
* '''AVANS'''  | |||
* '''FULL_PAY'''  | |||
* '''PARTIAL_SETTLEMENT_AND_CREDIT'''  | |||
* '''TRANSFER_ON_CREDIT'''  | |||
* '''CREDIT_PAYMENT'''  | |||
|content-right=  | |||
   | |||
* Полная предварительная оплата до момента передачи предмета расчёта  | |||
* Частичная предварительная оплата до момента передачи предмета расчёта  | |||
* Аванс  | |||
* Полная оплата, в том числе с учётом аванса (предварительной оплаты) в момент передачи предмета расчёта  | |||
* Частичная оплата предмета расчёта в момент его передачи с последующей оплатой в кредит  | |||
* Передача предмета расчёта без его оплаты в момент его передачи с последующей оплатой в кредит  | |||
* Оплата предмета расчёта после его передачи с оплатой в кредит (оплата кредита)  | |||
|}}<br>  | |||
{{ProductTable-2  | |||
|title-left='''vat''' - ставка НДС (тэг 1199).  | |||
|title-right=  | |||
|content-left=  | |||
   | |||
* '''WITHOUT_VAT'''  | |||
* '''VAT_0'''  | |||
* '''VAT_10'''  | |||
* '''VAT_20'''  | |||
* '''VAT_110'''  | |||
* '''VAT_120'''  | |||
* '''VAT_5'''  | |||
* '''VAT_7'''  | |||
* '''VAT_105'''  | |||
* '''VAT_107'''  | |||
|content-right=  | |||
   | |||
* Без НДС  | |||
* НДС 0%   | |||
* НДС 10%   | |||
* НДС 20%    | |||
* НДС 10/110   | |||
* НДС 20/120  | |||
* НДС 5%   | |||
* НДС 7%   | |||
* НДС 5/105   | |||
* НДС 7/107   | |||
|}}<br>  | |||
{{ProductTable-2  | |||
|title-left='''PaymentSubject''' - признак предмета расчета (тэг 1212).  | |||
|title-right=  | |||
|content-left=  | |||
   | |||
* '''PRODUCT'''  | |||
* '''EXCISABLE_PRODUCT'''  | |||
* '''JOB'''  | |||
* '''SERVICE'''  | |||
* '''GAMBLING_RATE'''  | |||
* '''GAMBLING_WIN'''  | |||
* '''LOTTERY_TICKET'''  | |||
* '''LOTTERY_WIN'''  | |||
* '''PROVISION_RID'''  | |||
* '''PAYMENT'''  | |||
* '''AGENCY'''  | |||
* '''COMPOUND_SUBJECT'''  | |||
* '''OTHER_SUBJECT'''  | |||
* '''PROPERTY_LAW'''  | |||
* '''NON_OPERATING_INCOME'''  | |||
* '''INSURANCE_CONTRIBUTIONS'''  | |||
* '''TRADE_FEE'''  | |||
* '''RESORT_FEE'''  | |||
* '''PLEDGE'''  | |||
* '''CONSUMPTION'''  | |||
* '''CONTRIBUTIONS_MPI_SE'''  | |||
* '''CONTRIBUTIONS_MPI'''   | |||
* '''CONTRIBUTIONS_CHI_SE'''  | |||
* '''CONTRIBUTIONS_CHI'''  | |||
* '''CONTRIBUTIONS_MSI'''  | |||
* '''CASINO_PAYMENT'''  | |||
* '''MONEY_PAYMENT'''  | |||
* '''ATNM'''  | |||
* '''ATM'''  | |||
* '''TNM'''  | |||
* '''TM'''  | |||
|content-right=  | |||
   | |||
* Товар  | |||
* Подакцизный товар  | |||
* Работа  | |||
* Услуга  | |||
* Ставка азартной игры  | |||
* Выигрыш азартной игры  | |||
* Лотерейный билет  | |||
* Выигрыш лотереи  | |||
* Предоставление РИД  | |||
* Платеж  | |||
* Агентское вознаграждение  | |||
* Составной предмет расчета  | |||
* Иной предмет расчета  | |||
* Имущественное право  | |||
* Внереализованный доход  | |||
* Страховые взносы  | |||
* Торговый сбор  | |||
* Курортный сбор  | |||
* Залог  | |||
* Расход  | |||
* Взносы на ОПС ИП  | |||
* Взносы на ОПС  | |||
* Взносы на ОМС ИП  | |||
* Взносы на ОМС  | |||
* Взносы на ОСС  | |||
* Платеж казино  | |||
* Выплата  | |||
* Подакцизный маркируемый товар без КМ  | |||
* Подакцизный маркируемый товар c КМ  | |||
* Маркируемый товар без КМ  | |||
* Маркируемый товар с КМ  | |||
|}}<br>  | |||
{{ProductTable-2  | |||
|title-left='''address''' - телефон или электронный адрес покупателя (тэг 1008).  | |||
|title-right=    | |||
|content-left= Телефон передаётся в формате "7ХХХХХХХХХХ"  | |||
|content-right=  | |||
|}}<br>  | |||
= Создание заказа =  | = Создание заказа =  | ||
| Строка 10: | Строка 163: | ||
|title-left= '''Запрос'''  | |title-left= '''Запрос'''  | ||
|title-right=  '''POST '''  | |title-right=  '''POST '''  | ||
|content-left=   | |content-left= <br>  | ||
base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders  | base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders  | ||
|content-right=  | |content-right=  | ||
| Строка 18: | Строка 171: | ||
|}}<br>  | |}}<br>  | ||
{{Note|'''''  | {{Note|'''''Важно!'''''<br>  | ||
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''  | В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}}  | ||
<br>  | |||
{{ProductTable-2  | |||
   |title-left= Request HEADERS  | |||
   |title-right='''HEADERS'''  | |||
|content-left=   | |||
* передача access_token  | |||
* отключение компрессии  | |||
|content-right=  | |||
<syntaxhighlight lang="JSON">  | |||
Authorization: "Bearer <значение access_token>"  | |||
Accept-Encoding: "deflate"  | |||
</syntaxhighlight>  | |||
|}}<br>  | |||
{{ProductTable-2  | {{ProductTable-2  | ||
| Строка 76: | Строка 242: | ||
* '''markType''': Тип маркировки  | * '''markType''': Тип маркировки  | ||
* '''codeForOfd''': Код маркировки (КМ)  | * '''codeForOfd''': Код маркировки (КМ)  | ||
* '''gs''': последовательность символов принимаемых за GS1  | |||
* '''barcode''': Штрих код позиции (EAN-8, EAN-13)  | * '''barcode''': Штрих код позиции (EAN-8, EAN-13)  | ||
* '''vendorCode''': Артикул производителя  | * '''vendorCode''': Артикул производителя  | ||
| Строка 145: | Строка 312: | ||
         "created": 1644828163053,            |          "created": 1644828163053,            | ||
         "changed": 1644828163053,             |          "changed": 1644828163053,             | ||
         "organizationId": "<  |          "organizationId": "<organization_id>",       | ||
         "tradeObjectId": "<  |          "tradeObjectId": "<trade_object_id>",          | ||
         "taxSystem": "COMMON",                         |          "taxSystem": "COMMON",                         | ||
         "externalId": "BFt-002",                        |          "externalId": "BFt-002",                        | ||
| Строка 191: | Строка 358: | ||
             "organizationPhone": null,                |              "organizationPhone": null,                | ||
             "contractorActivityType": null,        |              "contractorActivityType": null,        | ||
             "markType": "  |              "markType": "OTHER",                | ||
             "codeForOfd":   |              "codeForOfd": "0104865736574906215Sib>qgGS193dGVz",   | ||
            "gs": "GS1" ,         | |||
             "barcode": null,              |              "barcode": null,              | ||
             "vendorCode": null,         |              "vendorCode": null,         | ||
| Строка 252: | Строка 420: | ||
     },  |      },  | ||
     "client": {  |      "client": {  | ||
         "organizationId": "<  |          "organizationId": "<organization_id>",    | ||
         "address": "Адрес",          |          "address": "Адрес",          | ||
         "phone": "79999999999",     |          "phone": "79999999999",     | ||
| Строка 278: | Строка 446: | ||
</syntaxhighlight>  | </syntaxhighlight>  | ||
|}}<br>  | |}}<br>  | ||
{{Note|'''''Примечание'''''<br>  | |||
После получения ID созданного онлайн заказа, укажите его в поисковом запросе  https://kassa.bifit.com/cashdesk/#/app_cashdesk/online_orders/list/  после знака /.|800}}  | |||
Текущая версия на 13:24, 28 августа 2025
CASHDESK API
API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.
Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться здесь.
Нумераторы
| TaxSystem - cистема налогообложения (тэг 1055). Если при регистрации устройства в ФНС было выбрано более одного режима налогообложения, то в TaxSystem необходимо указать, к какой системе налогообложения относится данный чек. | |
 
  | 
       
  | 
   
| CalculationMethod - признак способа расчета (тэг 1214). | |
 
  | 
       
  | 
   
| vat - ставка НДС (тэг 1199). | |
 
  | 
       
  | 
   
| PaymentSubject - признак предмета расчета (тэг 1212). | |
 
  | 
       
  | 
   
| address - телефон или электронный адрес покупателя (тэг 1008). | |
| Телефон передаётся в формате "7ХХХХХХХХХХ" | 
Создание заказа
| Запрос | POST | 
|   base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders  | 
      https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders
 | 
   
 Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .
| Request HEADERS | HEADERS | 
 
  | 
      Authorization: "Bearer <значение access_token>"
Accept-Encoding: "deflate"
 | 
   
| Request Body | type: raw (JSON) | 
|  
 onlineOrder: 
 onlineOrderItems: 
 properties: Свойства 
 client: 
  | 
       {
    "onlineOrder": {
        "visible": true,                          
        "created": 1644828163053,         
        "changed": 1644828163053,          
        "organizationId": "<organization_id>",    
        "tradeObjectId": "<trade_object_id>",       
        "taxSystem": "COMMON",                      
        "externalId": "BFt-002",                     
        "deliveryType": "COURIER",       
        "deliveryAmount": null,           
        "deliveryTime": null,       
        "paid": false,           
        "orderTime": 1644828134297,
        "clientId": 124329,                  
        "address": "Адрес",               
        "responsiblePersonLogin": "7xxxxxxxxxx",  
        "discount": 0.00,     
        "discountType": 0,                           
        "location": null,                       
        "totalAmount": 14500.00,                     
        "comment": null,                              
        "currentStatusType": "NEW",                     
        "currentStatusTime": 1644828159791,            
        "substatusId": null,             
        "shopId": null,                        
        "endLockTime": null,
        "routeSheetDocumentId": null,           
        "routeSheetDocumentPosition": null,          
        "routeSheetDocumentNumber": null,
        "size": null,
        "actualDeliveryTime": null,
        "cashierName": null,      
        "clientName": null   
    },
    "onlineOrderItems": [
        {
            "nomenclatureId": 22090265,               
            "description": "Букет белых роз",      
            "price": 3000,                    
            "vatValue": 20,                        
            "quantity": 1,                 
            "discount": 0,                
            "calculationMethod": null,                  
            "paymentSubject": "PRODUCT",            
            "contractorAddress": null,                 
            "contractorInn": null,                    
            "contractorName": null,                     
            "contractorPhone": null,                 
            "organizationPhone": null,             
            "contractorActivityType": null,     
            "markType": "OTHER",             
            "codeForOfd": "0104865736574906215Sib>qgGS193dGVz", 
            "gs": "GS1" ,       
            "barcode": null,           
            "vendorCode": null,      
            "unitCode": 796,                       
            "editable": true,                     
            "total": null                                
        },
        {
            "nomenclatureId": 22090204,
            "description": "Букет роз, 40 шт",
            "price": 7000,
            "vatValue": 20,
            "quantity": 1,
            "discount": 0,
            "calculationMethod": null,
            "paymentSubject": "PRODUCT",
            "contractorAddress": null,
            "contractorInn": null,
            "contractorName": null,
            "contractorPhone": null,
            "organizationPhone": null,
            "contractorActivityType": null,
            "markType": "UNKNOWN",
            "codeForOfd": null,
            "barcode": null,
            "vendorCode": null,
            "unitCode": 796,
            "editable": true,
            "total": null
        },
        {
            "nomenclatureId": 22090243,
            "description": "Букет розовых и белых роз, 15 штук",
            "price": 4500,
            "vatValue": 20,
            "quantity": 1,
            "discount": 0,
            "calculationMethod": null,
            "paymentSubject": "PRODUCT",
            "contractorAddress": null,
            "contractorInn": null,
            "contractorName": null,
            "contractorPhone": null,
            "organizationPhone": null,
            "contractorActivityType": null,
            "markType": "UNKNOWN",
            "codeForOfd": null,
            "barcode": null,
            "vendorCode": null,
            "unitCode": 796,
            "editable": true,
            "total": null
        }
    ],  
    "properties": {         
        "fullSettlement": true,     
        "prepayment": false, 
        "credit": false      
    },
    "client": {
        "organizationId": "<organization_id>", 
        "address": "Адрес",       
        "phone": "79999999999",  
        "lastName": "Иванов",    
        "firstName": "Иван", 
        "patronymic": "Иванович",          
        "email": "",                           
        "comment": null,                           
    },
    "organizationId": null,
    "cashierInfos": null
 }
 | 
   
| Response | |
|   ID созданного онлайн заказа  | 
      406707
 | 
   
 Примечание
После получения ID созданного онлайн заказа, укажите его в поисковом запросе  https://kassa.bifit.com/cashdesk/#/app_cashdesk/online_orders/list/  после знака /.