Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:receipt [07.07.2017 15:25]
mkuklin [Пример ответа сервера]
doc:dev:api:receipt [10.08.2018 18:09] (текущий)
aderyabin [Описание данных в ответе]
Строка 12: Строка 12:
  
 ==== Параметры запроса ==== ==== Параметры запроса ====
 +
 +Параметры,​ которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
  
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
  
-  * **marker** - уникальный идентификатор чека, который был обработан при последнем обмене данными. Параметр нужен для того, чтобы получать только новые чеки, которые еще не были получены ранее. Необязательный параметр. Если параметр указан,​ то будут отданы все чеки, которые были сформированы после него. Если параметр пустой,​ то будут отданы все чеки за последние 25 дней+  * **marker** ​(get only) - уникальный идентификатор чека, который был обработан при последнем обмене данными. Параметр нужен для того, чтобы получать только новые чеки, которые еще не были получены ранее. Необязательный параметр. Если параметр указан,​ то будут отданы все чеки, которые были сформированы после него. Если параметр пустой,​ то будут отданы все чеки за последние 25 дней 
 + 
 +  * **bankTransaction** (get only) - флаг, который включает добавление в чек информации о банковской транзакции. Принимает значения 0 и 1. По умолчанию 0.
  
-  * **bankTransaction** - флаг, который включает ​добавление в чек информации ​о банковской транзакции. Принимает значения ​0 и 1. По умолчанию 0.+  * **datefrom** (get only) Необязательный параметр. Если указан, то будут отданы данные, поступившие в облако после указанной даты ​и времени. Формат даты: ГГГГММДД / ГГГГММДДЧЧММСС. Необходимо обратить внимание, что дата продажи и дата ​поступления ​в облако могут различаться.
  
-  * **datefrom** - Необязательный параметр. Если указан,​ то будут отданы данные,​ поступившие в облако ​после ​указанной даты. Формат даты: ГГГГММДД. Необходимо обратить внимание,​ что дата продажи и дата поступления в облако могут различаться.+  * **dateto** (get only) - Необязательный параметр. Если указан,​ то будут отданы данные,​ поступившие в облако ​до указанной даты ​и времени (не включительно). Формат даты: ГГГГММДД ​/ ГГГГММДДЧЧММСС. Необходимо обратить внимание,​ что дата продажи и дата поступления в облако могут различаться.
  
-  * **format** - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.+  * **format** ​(get only) - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.
  
   * **fields** - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом ":"​. Необязательный параметр. Поддерживаются следующие поля:   * **fields** - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом ":"​. Необязательный параметр. Поддерживаются следующие поля:
Строка 66: Строка 70:
          <​warehouseid>​1</​warehouseid>​          <​warehouseid>​1</​warehouseid>​
          <​user_id>​19</​user_id>​          <​user_id>​19</​user_id>​
 +         <​corp_code>​CBX-0000</​corp_code>​
          <​fr_session>​1</​fr_session>​          <​fr_session>​1</​fr_session>​
          <​doc_type>​sale</​doc_type>​          <​doc_type>​sale</​doc_type>​
Строка 79: Строка 84:
          <​pay_credit>​0.00</​pay_credit>​          <​pay_credit>​0.00</​pay_credit>​
          <​is_electronic>​1</​is_electronic>​          <​is_electronic>​1</​is_electronic>​
 +         <​fiscal_attribute>​0</​fiscal_attribute>​
          <​pinpad_name>​sbrf</​pinpad_name>​          <​pinpad_name>​sbrf</​pinpad_name>​
          <​terminal_number>​3</​terminal_number>​          <​terminal_number>​3</​terminal_number>​
          <​device_model_name>​ШТРИХ-ФР-01Ф</​device_model_name>​          <​device_model_name>​ШТРИХ-ФР-01Ф</​device_model_name>​
          <​device_model_version>​S C.1 34378 13.01.2017 0 0 01.01.1980 1.14 4</​device_model_version>​          <​device_model_version>​S C.1 34378 13.01.2017 0 0 01.01.1980 1.14 4</​device_model_version>​
 +         <​terminal_description>​111</​terminal_description>​
          <​short_fiscal_serial_number>​234234</​short_fiscal_serial_number>​          <​short_fiscal_serial_number>​234234</​short_fiscal_serial_number>​
-         <​items_count>​1</​items_count>​+         <​is_electronic>​0</​is_electronic>​ 
 +         <​fiscal_attribute>​23324324234</​fiscal_attribute> ​         
 +         <​vat10_sum>​0.00</​vat10_sum>​ 
 +         <​vat18_sum>​0.00</​vat18_sum>​ 
 +         <​items_count>​1</​items_count> ​        ​
          <​items>​          <​items>​
             <​item>​             <​item>​
Строка 97: Строка 108:
                <​barcode />                <​barcode />
                <​user_id />                <​user_id />
-               <​vat_applied/>​ +               <​vat_applied>0</vat_applied
-               <​vat_amount/>​+               <​vat_amount>​0.00<​/vat_amount>
             </​item>​             </​item>​
          </​items>​          </​items>​
-         <​adjustment>​ 
-             <​id>​5</​id>​ 
-             <​title>​Корректировка поступления к товарной накладной №1</​title>​ 
-             <​created_date>​2017-07-03 16:​18:​55</​created_date>​ 
-             <​items>​ 
-                <​line_id>​11</​line_id>​ 
-                <​item_id>​5</​item_id>​ 
-                <​item_ext_id>​eacf7608-892c-11e4-ab28-005056a7771f</​item_ext_id>​ 
-                <​item_name>​Аджика по-абхазски SUNFEEL 250 г.</​item_name>​ 
-                <​quantity>​5.000</​quantity>​ 
-                <​quantity_expected>​1.000</​quantity_expected>​ 
-                <​line_id>​12</​line_id>​ 
-                <​item_id>​9</​item_id>​ 
-                <​item_ext_id>​7c3cbdc3-8d0f-11e4-ab28-005056a7771f</​item_ext_id>​ 
-                <​item_name>​Адреналин Раш, 0.5 л. ж/​б</​item_name>​ 
-                <​quantity>​2.000</​quantity>​ 
-                <​quantity_expected>​1.000</​quantity_expected>​ 
-             </​items>​ 
-         </​adjustment>​ 
          <​bankTransaction>​          <​bankTransaction>​
             <​rrn>​0123456789</​rrn>​             <​rrn>​0123456789</​rrn>​
Строка 128: Строка 120:
             <​client_card>​676201******1234</​client_card>​             <​client_card>​676201******1234</​client_card>​
             <​amount_clear>​21900</​amount_clear>​             <​amount_clear>​21900</​amount_clear>​
 +            <​card_name>​VISA</​card_name>​
             <​payment_type>​coupon</​payment_type>​             <​payment_type>​coupon</​payment_type>​
             <​payment_denomination>​500</​payment_denomination>​             <​payment_denomination>​500</​payment_denomination>​
Строка 156: Строка 149:
          <​pay_tare>​0.00</​pay_tare>​          <​pay_tare>​0.00</​pay_tare>​
          <​pay_credit>​0.00</​pay_credit>​          <​pay_credit>​0.00</​pay_credit>​
 +         <​is_electronic>​1</​is_electronic>​
 +         <​fiscal_attribute>​0</​fiscal_attribute> ​        
          <​pinpad_name>​sbrf</​pinpad_name>​          <​pinpad_name>​sbrf</​pinpad_name>​
          <​terminal_number>​3</​terminal_number>​          <​terminal_number>​3</​terminal_number>​
 +         <​device_model_name>​ШТРИХ-ФР-01Ф</​device_model_name>​
 +         <​device_model_version>​S C.1 34378 13.01.2017 0 0 01.01.1980 1.14 4</​device_model_version>​
 +         <​terminal_description>​111</​terminal_description>​
 +         <​short_fiscal_serial_number>​234234</​short_fiscal_serial_number>​
 +         <​is_electronic>​0</​is_electronic>​
 +         <​fiscal_attribute>​23324324234</​fiscal_attribute> ​                 ​
 +         <​vat10_sum>​0.00</​vat10_sum>​
 +         <​vat18_sum>​0.00</​vat18_sum>​
          <​items_count>​1</​items_count>​          <​items_count>​1</​items_count>​
          <​items>​          <​items>​
Строка 171: Строка 174:
                <​barcode />                <​barcode />
                <​user_id />                <​user_id />
-               <​vat_applied/>​ +               <​vat_applied>0</vat_applied
-               <​vat_amount/> ​              ​+               <​vat_amount>​0.00<​/vat_amount>
             </​item>​             </​item>​
          </​items>​          </​items>​
          <​bankTransaction>​          <​bankTransaction>​
-            <rrn>0123456789</rrn+            <payment_type>coupon</payment_type
-            <trx_date>18.11.2015</trx_date>​ +            <payment_denomination>500</payment_denomination>
-            <​term_num>​10000000</​term_num>​ +
-            <​auth_code>​500000</​auth_code>​ +
-            <​card_type>​3</​card_type>​ +
-            <​client_card>​676201******1234</​client_card>​ +
-            <​amount_clear>​21900</​amount_clear>+
          </​bankTransaction>​          </​bankTransaction>​
          <​sale_receipt_id>​D36B3C45-9939-AB11-D9FB-3BA4CB44607E</​sale_receipt_id>​          <​sale_receipt_id>​D36B3C45-9939-AB11-D9FB-3BA4CB44607E</​sale_receipt_id>​
Строка 200: Строка 198:
   * <​warehouseid>​1</​warehouseid>​ - ID склада/​магазина в системе VirtualPos   * <​warehouseid>​1</​warehouseid>​ - ID склада/​магазина в системе VirtualPos
   * <​user_id>​19</​user_id>​ - ID продавца   * <​user_id>​19</​user_id>​ - ID продавца
 +  * <​corp_code>​CBX-0000</​corp_code>​ - корпоративный код продавца
   * <​fr_session>​1</​fr_session>​ - номер смены   * <​fr_session>​1</​fr_session>​ - номер смены
   * <​doc_type>​sale</​doc_type>​ - тип чека: sale или return   * <​doc_type>​sale</​doc_type>​ - тип чека: sale или return
Строка 212: Строка 211:
   * <​pay_tare>​0.00</​pay_tare>​ - оплачено тарой (не используется)   * <​pay_tare>​0.00</​pay_tare>​ - оплачено тарой (не используется)
   * <​pay_credit>​0.00</​pay_credit>​ - оплачено кредитом (не используется)   * <​pay_credit>​0.00</​pay_credit>​ - оплачено кредитом (не используется)
-  * <​is_electronic>​1</​is_electronic>​ - отправлен электронный чек покупателю 
   * <​pinpad_name>​sbrf</​pinpad_name>​ - признак платёжного терминала   * <​pinpad_name>​sbrf</​pinpad_name>​ - признак платёжного терминала
   * <​terminal_number>​3</​terminal_number>​ - номер кассы в зале   * <​terminal_number>​3</​terminal_number>​ - номер кассы в зале
   * <​device_model_name>​ШТРИХ-ФР-01Ф</​device_model_name>​ - наименование модели ККМ   * <​device_model_name>​ШТРИХ-ФР-01Ф</​device_model_name>​ - наименование модели ККМ
   * <​device_model_version>​S C.1 34378 13.01.2017 0 0 01.01.1980 1.14 4</​device_model_version>​ - версия модели ККТ   * <​device_model_version>​S C.1 34378 13.01.2017 0 0 01.01.1980 1.14 4</​device_model_version>​ - версия модели ККТ
 +  * <​terminal_description>​1111</​terminal_description>​ - описание кассового места
   * <​short_fiscal_serial_number>​234234</​short_fiscal_serial_number>​ - краткий серийный номер ККТ   * <​short_fiscal_serial_number>​234234</​short_fiscal_serial_number>​ - краткий серийный номер ККТ
 +  * <​is_electronic>​1</​is_electronic>​ - отправлен электронный чек покупателю
 +  * <​fiscal_attribute>​0</​fiscal_attribute>​ - фискальный признак документа
 +  * <​vat10_sum>​0.00</​vat10_sum>​ - сумма НДС по позициям в чеке со ставкой 10%
 +  * <​vat18_sum>​0.00</​vat18_sum>​ - сумма НДС по позициям в чеке со ставкой 18%
   * <​items_count>​1</​items_count>​ - количество товаров в чеке   * <​items_count>​1</​items_count>​ - количество товаров в чеке
 +  * <​payment_type>​coupon</​payment_type>​ - признак того, что часть чека/​чек полностью оплачен подарочным сертификатом
 +  * <​payment_denomination>​500</​payment_denomination>​ - номинал подарочного сертификата
 +  * <​fiscal_attribute>​23324324234</​fiscal_attribute>​ - фискальный признак документа
   * <​sale_receipt_id>​D36B3C45-9939-AB11-D9FB-3BA4CB44607E</​sale_receipt_id>​ - поле заполняется только для чеков с типом "​Возврат"​ (return), содержит ссылку на первоначальные чек продажи   * <​sale_receipt_id>​D36B3C45-9939-AB11-D9FB-3BA4CB44607E</​sale_receipt_id>​ - поле заполняется только для чеков с типом "​Возврат"​ (return), содержит ссылку на первоначальные чек продажи
   * <​sale_receipt_date>​09.12.2015 17:​35:​11</​sale_receipt_date>​ - поле заполняется только для чеков с типом "​Возврат"​(return),​ содержит дату первоначального чека продажи   * <​sale_receipt_date>​09.12.2015 17:​35:​11</​sale_receipt_date>​ - поле заполняется только для чеков с типом "​Возврат"​(return),​ содержит дату первоначального чека продажи
Строка 228: Строка 234:
   * <​client_card>​676201******1234</​client_card>​ - номер платёжной карты   * <​client_card>​676201******1234</​client_card>​ - номер платёжной карты
   * <​amount_clear>​21900</​amount_clear>​ - сумма оплаты   * <​amount_clear>​21900</​amount_clear>​ - сумма оплаты
 +  * <​card_name>​VISA</​card_name>​ - наименование типа платёжной карты
   * <​session_open_datetime>​2016-03-01 16:​26:​39</​session_open_datetime>​ - дата и время начала смены   * <​session_open_datetime>​2016-03-01 16:​26:​39</​session_open_datetime>​ - дата и время начала смены
 === Данные о товарах в чеке (items): === === Данные о товарах в чеке (items): ===
Строка 241: Строка 248:
   * <barcode /> - штрихкоды упаковок через запятую   * <barcode /> - штрихкоды упаковок через запятую
   * <user_id /> - ID продавца (не используется)   * <user_id /> - ID продавца (не используется)
-  * <​vat_applied/>​ - ставка НДС +  * <​vat_applied>0</vat_applied> - ставка НДС 
-  * <​vat_amount/>​ - сумма НДС+  * <​vat_amount>​0.00<​/vat_amount> - сумма НДС 
 +  * <​onhand_id>​3975</​onhand_id>​ - ID товарного остатка
  
-=== Данные о корректировке поступления ​(adjustment): === +=== Данные о подарочных сертификатах (coupons): === 
-  * <id> - ID корректировки поступления +  * <barcode>CC-00000040</barcode> - номер ​ПС 
-  * <title> - наименование корректировки поступления +  * <sum>500.00</sum> - сумма сертификата ​оминал) 
-  * <created_date- дата создания корректировки поступления +  * <external_id>0</external_id> - идентификатор ​ПС как товара
-  * <items> - товары корректировки поступления +
-  * <​line_id>​11</​line_id>​ - id товара в корректировке поступления +
-  * <​item_id>​5</​item_id>​ - id товара в VirtualPos +
-  * <​item_ext_id>​eacf7608-892c-11e4-ab28-005056a7771f</​item_ext_id>​ - уникальный id товара +
-  * <​item_name>​Аджика по-абхазски SUNFEEL 250 г.</​item_name>​ - название товара +
-  * <quantity>5.000</quantity> - фактическое количество товара в корректировке +
-  * <​quantity_expected>​1.000</​quantity_expected>​ - ожидаемое ​количество ​товара ​в корректировке+