Загрузка контрагентов и карт — различия между версиями

Материал из Wiki
Перейти к: навигация, поиск
 
(не показано 14 промежуточных версии этого же участника)
Строка 14: Строка 14:
 
     address – адрес контрагента
 
     address – адрес контрагента
 
     phone – телефоны контрагента
 
     phone – телефоны контрагента
     birth_day – день рождения контрагента
+
     birth_day – день рождения контрагента в формате yyyy-mm-dd
 
     balance – баланс клубной карты контрагента (при загрузке используется для начальной установки)
 
     balance – баланс клубной карты контрагента (при загрузке используется для начальной установки)
 
     accumulation – накопления контрагента (при загрузке используется для начальной установки)
 
     accumulation – накопления контрагента (при загрузке используется для начальной установки)
Строка 25: Строка 25:
 
     club_card - признак клубной карты у добавляемой по умолчанию
 
     club_card - признак клубной карты у добавляемой по умолчанию
 
     bonus_card - признак бонусной карты у добавляемой по умолчанию
 
     bonus_card - признак бонусной карты у добавляемой по умолчанию
 +
    customer_type - Служебный индекс типа контрагента. При использовании модуля школьной системы 0 - школьник, 1 - учитель.
 +
    club_card_day_limit - Лимит суммы покупок по клубной карте за день. 0 - Если лимит не нужен (По умолчанию).
 +
    dh_credit_level - Уровень кредита по питанию столовой (режим раздача столовой).
 +
                      Например значение 100 соответствует, тому что клиента может  получать питание при уровне -100 р.
 
-->
 
-->
 
   <customer group="имя группы"  
 
   <customer group="имя группы"  
Строка 30: Строка 34:
 
             fio="ФИО"  
 
             fio="ФИО"  
 
             address="АдресКонтрагента"  
 
             address="АдресКонтрагента"  
 +
            category_code="002"
 
             phone="Телефон"  
 
             phone="Телефон"  
             birth_day="yyyy-mm-dd"  
+
             birth_day="2010-10-10"  
 
             balance=""  
 
             balance=""  
 
             accumulation="0"  
 
             accumulation="0"  
Строка 39: Строка 44:
 
             external_code=""  
 
             external_code=""  
 
             club_card="true"  
 
             club_card="true"  
             bonus_card="true" bind_type = "{card|name|external_code}">
+
             bonus_card="true"  
 +
            bind_type="{card|name|external_code}"
 +
            customer_type="0"
 +
            club_card_day_limit="100"
 +
            dh_credit_level="100">
 
     <!-- загрузка дополнительных карт поля  
 
     <!-- загрузка дополнительных карт поля  
 
         code* – код карты
 
         code* – код карты
Строка 52: Строка 61:
 
         С помощью внесения нескольких узлов по контрагенту можно создать историю его изменения счета.  
 
         С помощью внесения нескольких узлов по контрагенту можно создать историю его изменения счета.  
 
         В Аппетите каждый узел отражается в виде отдельной транзакции по контрагенту
 
         В Аппетите каждый узел отражается в виде отдельной транзакции по контрагенту
       type * – приход("debit"), расход("credit") средств клубных карт
+
       type * – Тип операции рассматривается по принципу пассивного счета:
 +
              значение "credit" соответствует увеличению баланса контрагента,
 +
              значение "debit" соответствует уменьшению баланса контрагента.
 
       value * – сумма операции
 
       value * – сумма операции
       datetime * – дата и время операции в формате yyyy-mm-dd hh:MM:ss -->
+
       datetime * – дата и время операции в формате yyyy-mm-dd hh:MM:ss  
 +
      uid_trx - Уникальный ID транзакции -->
 
     <reg_balance_operation>
 
     <reg_balance_operation>
         <operation type="credit" value="10.0" datetime="2011-10-10 00:00:00"/>
+
         <operation type="credit" value="10.0" datetime="2011-10-10 00:00:00" uid_trx="123123123123123123"/>
         <operation type="debit" value="10.0" datetime="2011-10-11 00:00:00"/>
+
         <operation type="debit" value="10.0" datetime="2011-10-11 00:00:00"  uid_trx="4234234"/>
         <operation type="credit" value="10.0" datetime="2011-10-12 00:00:00"/>
+
         <operation type="credit" value="10.0" datetime="2011-10-12 00:00:00" uid_trx="4645645"/>
         <operation type="debit" value="10.0" datetime="2011-10-13 00:00:00"/>
+
         <operation type="debit" value="10.0" datetime="2011-10-13 00:00:00" uid_trx="5675675"/>
 
     </reg_balance_operation>  
 
     </reg_balance_operation>  
 +
 +
    <!-- Узел соответствует индивидуальному стоп-листу блюд контрагента.
 +
        Если узел "nom_stop_list" отсутствует, то обработка списка игнорируется (не происходит удаление стоп листа контрагента).
 +
        Если узел "nom_stop_list" присутствует, то сначала происходит очистка стоп-листа в базе БИТ Аппетита.
 +
                    После этого добавляются элементы.
 +
      -->
 +
    <nom_stop_list>
 +
      <!-- Узел "item" соответствует элементу номенклатуры в стоп-листе
 +
            code* - соответствует атрибуту "code", элемента "nom_element"
 +
          -->
 +
      <nom_stop_item code="123324456"/>
 +
    </nom_stop_list>
 +
 +
    <!-- Необязательный элемент, загружающий фотографию контрагента в формате "JPEG"
 +
        Внутри элемента находятся бинарные данные файла изображения кодированные алгоритмом BASE64.
 +
        Если данные отсутствуют, это означает удаление фотографии.
 +
      -->
 +
    <photo>{BASE64Data}</photo>
 +
 +
 +
    <!-- Элемент "categories" соответствует списку применяемых к контрагенту льгот -->
 +
    <categories>
 +
      <!-- item элемент "item" соответствует категории контрагента
 +
          code - Код категории
 +
      -->
 +
      <category code="001"/>
 +
      <category code="002"/>
 +
    </categories>
 
   </customer>
 
   </customer>
 
</back_to_ef>
 
</back_to_ef>
 
</syntaxhighlight>
 
</syntaxhighlight>

Текущая версия на 14:24, 24 ноября 2016

API интеграции с учетной системой

<?xml version="1.0" encoding="utf-8"?>
<!-- Заголовок файла обмена -->
<back_to_ef org_name="Организация" dateuploading="yyyy-mm-dd hh:MM:ss">
 
<!--
    Обязательные group fio.
    Если при формировании файла будет bind_type = «card» то есть по картам, тогда атрибут code тоже будет обязательным и атрибуты, следующие за ним могут быть, могут не быть. В противном случае атрибуты 
    group* – наименование группы контрагентов
    fio* – ФИО контрагента или наименование
    address – адрес контрагента
    phone – телефоны контрагента
    birth_day – день рождения контрагента в формате yyyy-mm-dd
    balance – баланс клубной карты контрагента (при загрузке используется для начальной установки)
    accumulation – накопления контрагента (при загрузке используется для начальной установки)
    credit_level – уровень кредита контрагента
    credit_level_type – периодичность кредита контрагента. «0» - никакого, «1» - ежедневный, «2» - еженедельный, «3» - ежемесячный
    bind_type* – вариант синхронизации контрагентов при загрузке. {card|name|external_code} - {по картам|по имени контрагента|по внешнему коду}
    code – код карты контрагента, добавляемый сразу
    discount_card – признак дисконтной карты у добавляемой по умолчанию
    external_code* – внешний код синхронизации контрагента
    club_card - признак клубной карты у добавляемой по умолчанию
    bonus_card - признак бонусной карты у добавляемой по умолчанию
    customer_type - Служебный индекс типа контрагента. При использовании модуля школьной системы 0 - школьник, 1 - учитель.
    club_card_day_limit - Лимит суммы покупок по клубной карте за день. 0 - Если лимит не нужен (По умолчанию).
    dh_credit_level - Уровень кредита по питанию столовой (режим раздача столовой). 
                      Например значение 100 соответствует, тому что клиента может   получать питание при уровне -100 р.
-->
  <customer group="имя группы" 
            code="Код карты" 
            fio="ФИО" 
            address="АдресКонтрагента" 
            category_code="002"
            phone="Телефон" 
            birth_day="2010-10-10" 
            balance="" 
            accumulation="0" 
            credit_level="0" 
            credit_level_type="0" 
            discount_card="true" 
            external_code="" 
            club_card="true" 
            bonus_card="true" 
            bind_type="{card|name|external_code}"
            customer_type="0"
            club_card_day_limit="100"
            dh_credit_level="100">
    <!-- загрузка дополнительных карт поля 
         code* – код карты
         discount_card – признак дисконтной карты
         club_card - признак клубной карты
         bonus_card - признак бонусной карты
      -->
    <card code="123123" discount_card="true" club_card="true" bonus_card="true"/>
    <card code="122124"/>
 
    <!-- регистрация операций по внесению списанию средств для контрагента (изменяет баланс клубной карты). 
         С помощью внесения нескольких узлов по контрагенту можно создать историю его изменения счета. 
         В Аппетите каждый узел отражается в виде отдельной транзакции по контрагенту
      type * – Тип операции рассматривается по принципу пассивного счета:
               значение "credit" соответствует увеличению баланса контрагента,
               значение "debit" соответствует уменьшению баланса контрагента.
      value * – сумма операции
      datetime * – дата и время операции в формате yyyy-mm-dd hh:MM:ss 
      uid_trx - Уникальный ID транзакции -->
    <reg_balance_operation>
        <operation type="credit" value="10.0" datetime="2011-10-10 00:00:00" uid_trx="123123123123123123"/>
        <operation type="debit" value="10.0" datetime="2011-10-11 00:00:00"  uid_trx="4234234"/>
        <operation type="credit" value="10.0" datetime="2011-10-12 00:00:00" uid_trx="4645645"/>
        <operation type="debit" value="10.0" datetime="2011-10-13 00:00:00" uid_trx="5675675"/>
    </reg_balance_operation> 
 
    <!-- Узел соответствует индивидуальному стоп-листу блюд контрагента.
         Если узел "nom_stop_list" отсутствует, то обработка списка игнорируется (не происходит удаление стоп листа контрагента).
         Если узел "nom_stop_list" присутствует, то сначала происходит очистка стоп-листа в базе БИТ Аппетита. 
                    После этого добавляются элементы.
      -->
    <nom_stop_list> 
       <!-- Узел "item" соответствует элементу номенклатуры в стоп-листе 
            code* - соответствует атрибуту "code", элемента "nom_element"
          -->
       <nom_stop_item code="123324456"/>
    </nom_stop_list>
 
    <!-- Необязательный элемент, загружающий фотографию контрагента в формате "JPEG"
         Внутри элемента находятся бинарные данные файла изображения кодированные алгоритмом BASE64. 
         Если данные отсутствуют, это означает удаление фотографии.
      -->
    <photo>{BASE64Data}</photo>
 
 
    <!-- Элемент "categories" соответствует списку применяемых к контрагенту льгот -->
    <categories>
      <!-- item элемент "item" соответствует категории контрагента 
           code - Код категории
       -->
      <category code="001"/>
      <category code="002"/>
    </categories>
  </customer>
</back_to_ef>