Описание объектов API — различия между версиями

Материал из Mr.Doc
Перейти к: навигация, поиск
(→‎Типы цен(RefPriceType))
 
(не показано 26 промежуточных версий этого же участника)
Строка 1: Строка 1:
 
[[Category:API]]
 
[[Category:API]]
 
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
 
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
−
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
+
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
 
<div style="float:left; margin-right: 20px;">
 
<div style="float:left; margin-right: 20px;">
−
    <p style=" text-align:center;">'''Пример JSON'''</p>
+
'''Пример JSON'''
−
     <pre>{
+
     <pre>
 +
{
 
     "main_field_1": "value_1",
 
     "main_field_1": "value_1",
 
     "main_field_2": "value_2",
 
     "main_field_2": "value_2",
 
     "table_part_name": [
 
     "table_part_name": [
 
         {
 
         {
−
             "table_part_field_1": "value_3",
+
             "field_1": "value_3",
−
             "table_part_field_2": "value_4"
+
             "field_2": "value_4",
 +
            "field_3": "value_5"
 
         },
 
         },
 
         {
 
         {
−
             "table_part_field_1": "value_5",
+
             "field_1": "value_6",
−
             "table_part_field_2": "value_6"
+
            "field_2": "value_7",
 +
             "field_3": "value_8"
 
         }
 
         }
 
     ]
 
     ]
−
}</pre>
+
}
 +
    </pre>
 
</div>
 
</div>
 
<div style="float:left;">
 
<div style="float:left;">
−
    <p style=" text-align:center;">'''Пример XML'''</p>
+
'''Пример XML'''
 
     <pre>
 
     <pre>
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
Строка 28: Строка 32:
 
     <table_part_name list="true">
 
     <table_part_name list="true">
 
         <item>
 
         <item>
−
             <table_part_field_1>value_3</table_part_field_1>
+
             <field_1>value_3</field_1>
−
             <table_part_field_2>value_4</table_part_field_2>
+
             <field_2>value_4</field_2>
 +
            <field_3>value_5</field_3>
 
         </item>
 
         </item>
 
         <item>
 
         <item>
−
             <table_part_field_1>value_5</table_part_field_1>
+
             <field_1>value_6</field_1>
−
             <table_part_field_2>value_6</table_part_field_2>
+
             <field_2>value_7</field_2>
 +
            <field_3>value_8</field_3>
 
         </item>
 
         </item>
 
     </table_part_name>
 
     </table_part_name>
Строка 40: Строка 46:
 
</div>
 
</div>
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
 +
В примерах выше атрибут '''"table_part_name"''' - табличная часть, в которой два элемента. '''"field_1"''', '''"field_2"''' и '''"field_3"''' - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате '''"table_part_name.field_1"'''.
 +
== Справочники ==
 +
<!--
 +
------------------------------------------------------------- разделитель между справочниками ------------------------------------------------------------------------
 +
-->
 +
=== Организации (RefOrganization) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор элемента справочника.
 +
 +
|-
 +
!code
 +
|Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!name
 +
|Наименование элемента справочника.
 +
 +
|-
 +
!full_name
 +
|Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута '''"name"'''.
 +
 +
|-
 +
!is_predefined
 +
|Булево значение - признак предопределенного элемента системы.
 +
 +
|-
 +
!status_id
 +
|Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора элемента из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания элемента справочника в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в элемент справочника.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения элемента справочника в SQL формате.
 +
 +
|-
 +
!is_folder
 +
|Булево значение - признак группы в справочнике.
 +
 +
|-
 +
!parent_folder_id
 +
|Идентификатор родительской группы из данного справочника.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!inn
 +
|ИНН организации.
 +
 +
|-
 +
!kpp
 +
|КПП организации.
 +
 +
|-
 +
!is_vat_payer
 +
|Булево значение - признак плательщика НДС.
 +
 +
|-
 +
!type_id
 +
|Тип. Возможные значения: ЮрЛицо, ФизЛицо. Значение по умолчанию - "ЮрЛицо".
 +
 +
|-
 +
!prefix
 +
|Префикс для генерации номеров документов.
 +
 +
|-
 +
!base_bank_account_id
 +
|Идентификатор основного банковского счета организации из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!director_id
 +
|Идентификатор руководителя из справочника сотрудников '''RefPerson'''.
 +
 +
|-
 +
!chief_accountant_id
 +
|Идентификатор главного бухгалтера из справочника сотрудников '''RefPerson'''.
 +
 +
|-
 +
!certificate_date
 +
|Дата выдачи свидетельства о постановке на учет в формате SQL.
 +
 +
|-
 +
!certificate_number
 +
|Номер свидетельства о постановке на учет.
 +
 +
|-
 +
!phone
 +
|Телефон (11 цифр).
 +
 +
|-
 +
!email
 +
|Адрес электронной почты.
 +
 +
|-
 +
!legal_address_id
 +
|Идентификатор юридического адреса из справочника адресов '''RefAddress'''.
 +
 +
|-
 +
!actual_address_id
 +
|Идентификатор фактического адреса из справочника адресов '''RefAddress'''.
 +
 +
|-
 +
!other
 +
|Прочие контакты.
 +
 +
|}
 +
 +
<!--
 +
------------------------------------------------------------- разделитель между справочниками ------------------------------------------------------------------------
 +
-->
 +
=== Контрагенты (RefContractor) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор элемента справочника.
 +
 +
|-
 +
!code
 +
|Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!name
 +
|Наименование элемента справочника.
 +
 +
|-
 +
!full_name
 +
|Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута '''"name"'''.
 +
 +
|-
 +
!is_predefined
 +
|Булево значение - признак предопределенного элемента системы.
 +
 +
|-
 +
!status_id
 +
|Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора элемента из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания элемента справочника в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в элемент справочника.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения элемента справочника в SQL формате.
 +
 +
|-
 +
!is_folder
 +
|Булево значение - признак группы в справочнике.
 +
 +
|-
 +
!parent_folder_id
 +
|Идентификатор родительской группы из данного справочника.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!inn
 +
|ИНН контрагента.
 +
 +
|-
 +
!kpp
 +
|КПП контрагента.
 +
 +
|-
 +
!type_id
 +
|Тип. Возможные значения: ЮрЛицо, ФизЛицо. Значение по умолчанию - "ЮрЛицо".
 +
 +
|-
 +
!first_name
 +
|Имя для физических лиц.
 +
 +
|-
 +
!last_name
 +
|Фамилия для физических лиц.
 +
 +
|-
 +
!patronymic
 +
|Отчество для физических лиц.
 +
 +
|-
 +
!base_bank_account_id
 +
|Идентификатор основного банковского счета контрагента из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!phone
 +
|Телефон (11 цифр).
 +
 +
|-
 +
!email
 +
|Адрес электронной почты.
 +
 +
|-
 +
!legal_address_id
 +
|Идентификатор юридического адреса из справочника адресов '''RefAddress'''.
 +
 +
|-
 +
!actual_address_id
 +
|Идентификатор фактического адреса из справочника адресов '''RefAddress'''.
 +
 +
|-
 +
!other
 +
|Прочие контакты.
 +
 +
|}
 +
 +
<!--
 +
------------------------------------------------------------- разделитель между справочниками ------------------------------------------------------------------------
 +
-->
 +
=== Договоры (RefContract) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор элемента справочника.
 +
 +
|-
 +
!code
 +
|Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!name
 +
|Наименование элемента справочника.
 +
 +
|-
 +
!full_name
 +
|Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута '''"name"'''.
 +
 +
|-
 +
!is_predefined
 +
|Булево значение - признак предопределенного элемента системы.
 +
 +
|-
 +
!status_id
 +
|Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора элемента из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания элемента справочника в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в элемент справочника.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения элемента справочника в SQL формате.
 +
 +
|-
 +
!is_folder
 +
|Булево значение - признак группы в справочнике.
 +
 +
|-
 +
!parent_folder_id
 +
|Идентификатор родительской группы из данного справочника.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!number
 +
|Номер бумажного варианта договора.
 +
 +
|-
 +
!date_time
 +
|Дата бумажного варианта договора в SQL формате.
 +
 +
|-
 +
!expiration_date
 +
|Срок истечения бумажного варианта договора в SQL формате.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''.
 +
 +
|-
 +
!contractor_id
 +
|Идентификатор контрагента из справочника '''RefContractor'''.
 +
 +
|-
 +
!type_id
 +
|Тип договора. Возможные значения: СПокупателем, СПоставщиком, СЭквайером, Прочее.
 +
 +
|-
 +
!calculation_type_id
 +
|Порядок расчетов. Возможные значения: ПоДоговоруВЦелом, ПоЗаказам.
 +
 +
|-
 +
!contract_status_id
 +
|Дополнительный информационный статус договора, который отражает текущее состояние бумажного варианта договора. Возможные значения: НеСогласован, Действует, Закрыт.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!is_prepayment
 +
|Булево значение - признак ведения расчетов по предоплате.
 +
 +
|}
 +
 +
<!--
 +
------------------------------------------------------------- разделитель между справочниками ------------------------------------------------------------------------
 +
-->
 +
=== Валюты (RefCurrency) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор элемента справочника.
 +
 +
|-
 +
!code
 +
|Числовой код валюты по общероссийскому классификатору валют.
 +
 +
|-
 +
!name
 +
|Символьный код валюты по общероссийскому классификатору валют.
 +
 +
|-
 +
!full_name
 +
|Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута '''"name"'''.
 +
 +
|-
 +
!is_predefined
 +
|Булево значение - признак предопределенного элемента системы.
 +
 +
|-
 +
!status_id
 +
|Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора элемента из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания элемента справочника в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в элемент справочника.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения элемента справочника в SQL формате.
 +
 +
|-
 +
!is_folder
 +
|Булево значение - признак группы в справочнике.
 +
 +
|-
 +
!parent_folder_id
 +
|Идентификатор родительской группы из данного справочника.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!integer_gender
 +
|Род целой части. Возможные значения: m, f, n (Мужской, Женский и Средний соответственно).
 +
 +
|-
 +
!fractional_gender
 +
|Род дробной части. Возможные значения: m, f, n (Мужской, Женский и Средний соответственно).
 +
 +
|-
 +
!integer_plural_rules
 +
|Правила склонения целой части, разделенные знаком "|".
 +
 +
|-
 +
!fractional_plural_rules
 +
|Правила склонения дробной части, разделенные знаком "|".
 +
 +
|-
 +
!fractional_precision
 +
|Количество знаков после запятой..
 +
 +
|}
 +
 +
<!--
 +
------------------------------------------------------------- разделитель между справочниками ------------------------------------------------------------------------
 +
-->
 +
=== Типы цен (RefPriceType) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор элемента справочника.
 +
 +
|-
 +
!code
 +
|Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!name
 +
|Наименование элемента справочника.
 +
 +
|-
 +
!full_name
 +
|Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута '''"name"'''.
 +
 +
|-
 +
!is_predefined
 +
|Булево значение - признак предопределенного элемента системы.
 +
 +
|-
 +
!status_id
 +
|Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора элемента из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания элемента справочника в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в элемент справочника.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения элемента справочника в SQL формате.
 +
 +
|-
 +
!is_folder
 +
|Булево значение - признак группы в справочнике.
 +
 +
|-
 +
!parent_folder_id
 +
|Идентификатор родительской группы из данного справочника.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!is_dynamic
 +
|Булево значение - признак расчета цен автоматически на основании другого типа цен.
 +
 +
|-
 +
!base_price_type_id
 +
|Идентификатор базового типа цен из справочника '''RefPriceType'''.
 +
 +
|-
 +
!percent
 +
|Наценка по отношению к базовому типу цен.
 +
 +
|}
 +
 
== Документы ==
 
== Документы ==
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
=== Оприходование товаров (DocAcceptance) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
 +
 +
|-
 +
!date_time
 +
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
 +
 +
|-
 +
!number
 +
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!status_id
 +
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!price_type_id
 +
|Идентификатор типа цен из справочника '''RefPriceType'''.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!products.product_id
 +
|Идентификатор товара из справочника '''RefNomenclature'''.
 +
 +
|-
 +
!products.sku_id
 +
|Идентификатор модификации товара из справочника '''RefSku'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанного товара.
 +
 +
|-
 +
!products.unit_id
 +
|Идентификатор единицы измерения товара из справочника '''RefUnit'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанного товара.
 +
 +
|-
 +
!products.factor
 +
|Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной  единицы измерения.
 +
 +
|-
 +
!products.quantity
 +
|Количество указанного товара.
 +
 +
|-
 +
!products.price
 +
|Цена указанного товара.
 +
 +
|-
 +
!products.sum
 +
|Сумма указанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
 +
 +
|-
 +
!products.vat_rate_id
 +
|Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
 +
 +
|-
 +
!products.vat_sum
 +
|Сумма НДС указанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
 +
 +
|}
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
=== Поступление денежных средств через эквайера (DocAcquiringIn) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
 +
 +
|-
 +
!date_time
 +
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
 +
 +
|-
 +
!number
 +
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!status_id
 +
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
 +
 +
|-
 +
!contractor_id
 +
|Идентификатор контрагента из справочника '''RefContractor'''.
 +
 +
|-
 +
!contract_id
 +
|Идентификатор договора с контрагентом из справочника '''RefContract'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
 +
 +
|-
 +
!acquiring_contract_id
 +
|Идентификатор договора с эквайером из справочника '''RefContract'''.
 +
 +
|-
 +
!acquiring_payment_type_id
 +
|Идентификатор вида оплаты через эквайера из справочника '''RefAcquiringPaymentType'''.
 +
 +
|-
 +
!concession_percent
 +
|Процент торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет заполнен на основании данных в виде оплаты.
 +
 +
|-
 +
!concession_sum
 +
|Сумма торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет рассчитан автоматически на основании суммы документа и процента торговой уступки.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!document_basis_id
 +
|Идентификатор документа основания.
 +
 +
|-
 +
!document_basis_type_id
 +
|Тип документа основания. Возможные значения: DocSaleOrder и DocSale.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!details.sale_order_id
 +
|Идентификатор заказа покупателя '''DocSaleOrder'''.
 +
 +
|-
 +
!details.sum
 +
|Сумма платежа.
 +
 +
|-
 +
!details.vat_rate_id
 +
|Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
 +
 +
|-
 +
!details.vat_sum
 +
|Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.
 +
 +
|}
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
=== Возврат денежных средств через эквайера (DocAcquiringOut) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
 +
 +
|-
 +
!date_time
 +
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
 +
 +
|-
 +
!number
 +
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!status_id
 +
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
 +
 +
|-
 +
!contractor_id
 +
|Идентификатор контрагента из справочника '''RefContractor'''.
 +
 +
|-
 +
!contract_id
 +
|Идентификатор договора с контрагентом из справочника '''RefContract'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
 +
 +
|-
 +
!acquiring_contract_id
 +
|Идентификатор договора с эквайером из справочника '''RefContract'''.
 +
 +
|-
 +
!acquiring_payment_type_id
 +
|Идентификатор вида оплаты через эквайера из справочника '''RefAcquiringPaymentType'''.
 +
 +
|-
 +
!concession_percent
 +
|Процент торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет заполнен на основании данных в виде оплаты.
 +
 +
|-
 +
!concession_sum
 +
|Сумма торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет рассчитан автоматически на основании суммы документа и процента торговой уступки.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!document_basis_id
 +
|Идентификатор документа основания.
 +
 +
|-
 +
!document_basis_type_id
 +
|Тип документа основания. Возможные значения: DocSaleOrder и DocSaleReturn.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!details.sale_order_id
 +
|Идентификатор заказа покупателя '''DocSaleOrder'''.
 +
 +
|-
 +
!details.sum
 +
|Сумма возврата.
 +
 +
|-
 +
!details.vat_rate_id
 +
|Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
 +
 +
|-
 +
!details.vat_sum
 +
|Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.
 +
 +
|}
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
=== Платежное поручение входящее (DocBankOrderIn) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
 +
 +
|-
 +
!date_time
 +
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
 +
 +
|-
 +
!number
 +
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!status_id
 +
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
 +
 +
|-
 +
!contractor_id
 +
|Идентификатор контрагента из справочника '''RefContractor'''.
 +
 +
|-
 +
!contract_id
 +
|Идентификатор договора с контрагентом из справочника '''RefContract'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
 +
 +
|-
 +
!contractor_bank_account_id
 +
|Идентификатор банковского счета контрагента из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!organization_bank_account_id
 +
|Идентификатор банковского счета собственной организации из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!type_id
 +
|Вид операции. Возможные значения: ОплатаОтПокупателя, ВозвратОтПоставщика, ПоступлениеОтЭквайера и ПрочееПоступление.
 +
 +
|-
 +
!incoming_number
 +
|Номер первичного документа, полученного из банка.
 +
 +
|-
 +
!incoming_date
 +
|Дата первичного документа, полученного из банка в SQL формате.
 +
 +
|-
 +
!is_processed
 +
|Булево значение, которое отражает факт проведения документа в банке.
 +
 +
|-
 +
!process_date
 +
|Дата в SQL формате, которая отражает дату проведения документа банком.
 +
 +
|-
 +
!text_basis
 +
|Назначение платежа.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!document_basis_id
 +
|Идентификатор документа основания.
 +
 +
|-
 +
!document_basis_type_id
 +
|Тип документа основания. Возможные значения: DocSaleOrder, DocSale, DocPurchaseOrder и DocPurchaseReturn.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!details.document_basis_id
 +
|Идентификатор заказа покупателя '''DocSaleOrder''' или заказа поставщику '''DocPurchaseOrder'''.
 +
 +
|-
 +
!details.document_basis_type_id
 +
|Идентификатор типа заказа покупателя. Возможные значения: DocSaleOrder и DocPurchaseOrder.
 +
 +
|-
 +
!details.money_flow_item_id
 +
|Идентификатор статьи движения денежных средств из справочника '''RefMoneyFlowItem'''.
 +
 +
|-
 +
!details.sum
 +
|Сумма поступления.
 +
 +
|-
 +
!details.vat_rate_id
 +
|Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
 +
 +
|-
 +
!details.vat_sum
 +
|Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.
 +
 +
|}
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
=== Платежное поручение исходящее (DocBankOrderOut) ===
 +
{| class="wikitable"
 +
|-
 +
!Имя атрибута
 +
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
 +
 +
|-
 +
!date_time
 +
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
 +
 +
|-
 +
!number
 +
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
 +
 +
|-
 +
!status_id
 +
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
 +
 +
|-
 +
!organization_id
 +
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
 +
 +
|-
 +
!contractor_id
 +
|Идентификатор контрагента из справочника '''RefContractor'''.
 +
 +
|-
 +
!contract_id
 +
|Идентификатор договора с контрагентом из справочника '''RefContract'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
 +
 +
|-
 +
!contractor_bank_account_id
 +
|Идентификатор банковского счета контрагента из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!organization_bank_account_id
 +
|Идентификатор банковского счета собственной организации из справочника '''RefBankAccount'''.
 +
 +
|-
 +
!type_id
 +
|Вид операции. Возможные значения: ОплатаПоставщику, ВозвратПокупателю, ВозвратЭквайеру и ПрочееСписание.
 +
 +
|-
 +
!incoming_number
 +
|Номер первичного документа, полученного из банка.
 +
 +
|-
 +
!incoming_date
 +
|Дата первичного документа, полученного из банка в SQL формате.
 +
 +
|-
 +
!is_processed
 +
|Булево значение, которое отражает факт проведения документа в банке.
 +
 +
|-
 +
!process_date
 +
|Дата в SQL формате, которая отражает дату проведения документа банком.
 +
 +
|-
 +
!text_basis
 +
|Назначение платежа.
 +
 +
|-
 +
!currency_id
 +
|Идентификатор валюты из справочника '''RefCurrency'''. Значение по умолчанию - идентификатор валюты "Российский рубль".
 +
 +
|-
 +
!document_basis_id
 +
|Идентификатор документа основания.
 +
 +
|-
 +
!document_basis_type_id
 +
|Тип документа основания. Возможные значения: DocSaleOrder, DocSale, DocPurchaseOrder и DocPurchaseReturn.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
 +
 +
|-
 +
!details.document_basis_id
 +
|Идентификатор заказа покупателя '''DocSaleOrder''' или заказа поставщику '''DocPurchaseOrder'''.
 +
 +
|-
 +
!details.document_basis_type_id
 +
|Идентификатор типа заказа покупателя. Возможные значения: DocSaleOrder и DocPurchaseOrder.
 +
 +
|-
 +
!details.money_flow_item_id
 +
|Идентификатор статьи движения денежных средств из справочника '''RefMoneyFlowItem'''.
 +
 +
|-
 +
!details.sum
 +
|Сумма списания.
 +
 +
|-
 +
!details.vat_rate_id
 +
|Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
 +
 +
|-
 +
!details.vat_sum
 +
|Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.
 +
 +
|}
 +
<!--
 +
------------------------------------------------------------- разделитель между документами ---------------------------------------------------------------------------
 +
-->
 +
 
=== Заказ покупателя (DocSaleOrder) ===
 
=== Заказ покупателя (DocSaleOrder) ===
 
{| class="wikitable"
 
{| class="wikitable"
Строка 46: Строка 1143:
 
!Имя атрибута
 
!Имя атрибута
 
!Описание
 
!Описание
 +
 +
|-
 +
!id
 +
|Идентификатор документа.
  
 
|-
 
|-
 
!date_time
 
!date_time
−
|Дата заказа покупателю в формате SQL. В случае отсутствия в переданных данных будет заполнена текущей датой.
+
|Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
  
 
|-
 
|-
 
!number
 
!number
−
|Учетный номер документа. В случае отсутствия в переданных данных будет сгенерирован автоматически.
+
|Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
  
 
|-
 
|-
 
!status_id
 
!status_id
−
|Статус заказа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
+
|Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
  
 
|-
 
|-
 
!organization_id
 
!organization_id
−
|Идентификатор собственной организации из справочника '''RefOrganization'''. В случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
+
|Идентификатор собственной организации из справочника '''RefOrganization'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
  
 
|-
 
|-
Строка 69: Строка 1170:
 
|-
 
|-
 
!contract_id
 
!contract_id
−
|Идентификатор договора с покупателем из справочника '''RefContract'''. В случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным покупателем в системе. При отсутствии такового, будет автоматически создан новый договор.
+
|Идентификатор договора с покупателем из справочника '''RefContract'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным покупателем в системе. При отсутствии такового, будет автоматически создан новый договор.
  
 
|-
 
|-
Строка 77: Строка 1178:
 
|-
 
|-
 
!price_type_id
 
!price_type_id
−
|Идентификатор типа цен из справочника '''RefPriceType''' - необязательный атрибут.
+
|Идентификатор типа цен из справочника '''RefPriceType'''.
  
 
|-
 
|-
Строка 86: Строка 1187:
 
!external_number
 
!external_number
 
|Номер заказа покупателя из внешней системы.
 
|Номер заказа покупателя из внешней системы.
 +
 +
|-
 +
!append_user_id
 +
|Идентификатор автора документа из справочника '''RefUser'''.
 +
 +
|-
 +
!append_date
 +
|Дата и время создания документа в SQL формате.
 +
 +
|-
 +
!change_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который внес последние изменения в документ.
 +
 +
|-
 +
!change_date
 +
|Дата и время последнего изменения документа в SQL формате.
 +
 +
|-
 +
!responsible_user_id
 +
|Идентификатор пользователя из справочника '''RefUser''', который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
 +
 +
|-
 +
!document_basis_id
 +
|Идентификатор документа основания.
 +
 +
|-
 +
!document_basis_type_id
 +
|Тип документа основания. Возможные значения: (Отсутствуют).
 +
 +
|-
 +
!sum
 +
|Сумма документа.
 +
 +
|-
 +
!comment
 +
|Поле с произвольным текстом.
  
 
|-
 
|-
Строка 93: Строка 1230:
 
|-
 
|-
 
!products.sku_id
 
!products.sku_id
−
|Идентификатор модификации товара из справочника '''RefSku'''. В случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанного товара.
+
|Идентификатор модификации товара из справочника '''RefSku'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанного товара.
  
 
|-
 
|-
 
!products.unit_id
 
!products.unit_id
−
|Идентификатор единицы измерения товара из справочника '''RefUnit'''. В случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанного товара.
+
|Идентификатор единицы измерения товара из справочника '''RefUnit'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанного товара.
  
 
|-
 
|-
 
!products.factor
 
!products.factor
−
|Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. В случае отсутствия в переданных данных будет заполнен коэффициентом указанной  единицы измерения.
+
|Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной  единицы измерения.
  
 
|-
 
|-
Строка 113: Строка 1250:
 
|-
 
|-
 
!products.sum
 
!products.sum
−
|Сумма заказанного товара. В случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
+
|Сумма заказанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
  
 
|-
 
|-
Строка 121: Строка 1258:
 
|-
 
|-
 
!products.vat_sum
 
!products.vat_sum
−
|Сумма НДС заказанного товара. В случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
+
|Сумма НДС заказанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
  
 
|-
 
|-
Строка 129: Строка 1266:
 
|-
 
|-
 
!services.sku_id
 
!services.sku_id
−
|Идентификатор модификации услуги из справочника '''RefSku'''. В случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанной услуги.
+
|Идентификатор модификации услуги из справочника '''RefSku'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанной услуги.
  
 
|-
 
|-
 
!services.unit_id
 
!services.unit_id
−
|Идентификатор единицы измерения услуги из справочника '''RefUnit'''. В случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанной услуги.
+
|Идентификатор единицы измерения услуги из справочника '''RefUnit'''. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанной услуги.
  
 
|-
 
|-
 
!services.factor
 
!services.factor
−
|Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. В случае отсутствия в переданных данных будет заполнен коэффициентом указанной  единицы измерения.
+
|Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной  единицы измерения.
  
 
|-
 
|-
Строка 149: Строка 1286:
 
|-
 
|-
 
!services.sum
 
!services.sum
−
|Сумма заказанных услуг. В случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
+
|Сумма заказанных услуг. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
  
 
|-
 
|-
Строка 157: Строка 1294:
 
|-
 
|-
 
!services.vat_sum
 
!services.vat_sum
−
|Сумма НДС заказанных услуг. В случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
+
|Сумма НДС заказанных услуг. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
  
 
|-
 
|-

Текущая версия на 17:51, 11 марта 2014

Данная статья посвящена описанию доступных через API объектов и их атрибутов. Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.

Пример JSON 

{
    "main_field_1": "value_1",
    "main_field_2": "value_2",
    "table_part_name": [
        {
            "field_1": "value_3",
            "field_2": "value_4",
            "field_3": "value_5"
        },
        {
            "field_1": "value_6",
            "field_2": "value_7",
            "field_3": "value_8"
        }
    ]
}

Пример XML 

<?xml version="1.0" encoding="utf-8"?>
<root>
    <main_field_1>value_1</main_field_1>
    <main_field_2>value_2</main_field_2>
    <table_part_name list="true">
        <item>
            <field_1>value_3</field_1>
            <field_2>value_4</field_2>
            <field_3>value_5</field_3>
        </item>
        <item>
            <field_1>value_6</field_1>
            <field_2>value_7</field_2>
            <field_3>value_8</field_3>
        </item>
    </table_part_name>
</root>

В примерах выше атрибут "table_part_name" - табличная часть, в которой два элемента. "field_1", "field_2" и "field_3" - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате "table_part_name.field_1".

Справочники

Организации (RefOrganization)

Имя атрибута Описание
id Идентификатор элемента справочника.
code Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
name Наименование элемента справочника.
full_name Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута "name".
is_predefined Булево значение - признак предопределенного элемента системы.
status_id Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
append_user_id Идентификатор автора элемента из справочника RefUser.
append_date Дата и время создания элемента справочника в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в элемент справочника.
change_date Дата и время последнего изменения элемента справочника в SQL формате.
is_folder Булево значение - признак группы в справочнике.
parent_folder_id Идентификатор родительской группы из данного справочника.
comment Поле с произвольным текстом.
inn ИНН организации.
kpp КПП организации.
is_vat_payer Булево значение - признак плательщика НДС.
type_id Тип. Возможные значения: ЮрЛицо, ФизЛицо. Значение по умолчанию - "ЮрЛицо".
prefix Префикс для генерации номеров документов.
base_bank_account_id Идентификатор основного банковского счета организации из справочника RefBankAccount.
director_id Идентификатор руководителя из справочника сотрудников RefPerson.
chief_accountant_id Идентификатор главного бухгалтера из справочника сотрудников RefPerson.
certificate_date Дата выдачи свидетельства о постановке на учет в формате SQL.
certificate_number Номер свидетельства о постановке на учет.
phone Телефон (11 цифр).
email Адрес электронной почты.
legal_address_id Идентификатор юридического адреса из справочника адресов RefAddress.
actual_address_id Идентификатор фактического адреса из справочника адресов RefAddress.
other Прочие контакты.

Контрагенты (RefContractor)

Имя атрибута Описание
id Идентификатор элемента справочника.
code Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
name Наименование элемента справочника.
full_name Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута "name".
is_predefined Булево значение - признак предопределенного элемента системы.
status_id Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
append_user_id Идентификатор автора элемента из справочника RefUser.
append_date Дата и время создания элемента справочника в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в элемент справочника.
change_date Дата и время последнего изменения элемента справочника в SQL формате.
is_folder Булево значение - признак группы в справочнике.
parent_folder_id Идентификатор родительской группы из данного справочника.
comment Поле с произвольным текстом.
inn ИНН контрагента.
kpp КПП контрагента.
type_id Тип. Возможные значения: ЮрЛицо, ФизЛицо. Значение по умолчанию - "ЮрЛицо".
first_name Имя для физических лиц.
last_name Фамилия для физических лиц.
patronymic Отчество для физических лиц.
base_bank_account_id Идентификатор основного банковского счета контрагента из справочника RefBankAccount.
phone Телефон (11 цифр).
email Адрес электронной почты.
legal_address_id Идентификатор юридического адреса из справочника адресов RefAddress.
actual_address_id Идентификатор фактического адреса из справочника адресов RefAddress.
other Прочие контакты.

Договоры (RefContract)

Имя атрибута Описание
id Идентификатор элемента справочника.
code Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
name Наименование элемента справочника.
full_name Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута "name".
is_predefined Булево значение - признак предопределенного элемента системы.
status_id Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
append_user_id Идентификатор автора элемента из справочника RefUser.
append_date Дата и время создания элемента справочника в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в элемент справочника.
change_date Дата и время последнего изменения элемента справочника в SQL формате.
is_folder Булево значение - признак группы в справочнике.
parent_folder_id Идентификатор родительской группы из данного справочника.
comment Поле с произвольным текстом.
number Номер бумажного варианта договора.
date_time Дата бумажного варианта договора в SQL формате.
expiration_date Срок истечения бумажного варианта договора в SQL формате.
organization_id Идентификатор собственной организации из справочника RefOrganization.
contractor_id Идентификатор контрагента из справочника RefContractor.
type_id Тип договора. Возможные значения: СПокупателем, СПоставщиком, СЭквайером, Прочее.
calculation_type_id Порядок расчетов. Возможные значения: ПоДоговоруВЦелом, ПоЗаказам.
contract_status_id Дополнительный информационный статус договора, который отражает текущее состояние бумажного варианта договора. Возможные значения: НеСогласован, Действует, Закрыт.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
is_prepayment Булево значение - признак ведения расчетов по предоплате.

Валюты (RefCurrency)

Имя атрибута Описание
id Идентификатор элемента справочника.
code Числовой код валюты по общероссийскому классификатору валют.
name Символьный код валюты по общероссийскому классификатору валют.
full_name Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута "name".
is_predefined Булево значение - признак предопределенного элемента системы.
status_id Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
append_user_id Идентификатор автора элемента из справочника RefUser.
append_date Дата и время создания элемента справочника в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в элемент справочника.
change_date Дата и время последнего изменения элемента справочника в SQL формате.
is_folder Булево значение - признак группы в справочнике.
parent_folder_id Идентификатор родительской группы из данного справочника.
comment Поле с произвольным текстом.
integer_gender Род целой части. Возможные значения: m, f, n (Мужской, Женский и Средний соответственно).
fractional_gender Род дробной части. Возможные значения: m, f, n (Мужской, Женский и Средний соответственно).
integer_plural_rules ".
fractional_plural_rules ".
fractional_precision Количество знаков после запятой..

Типы цен (RefPriceType)

Имя атрибута Описание
id Идентификатор элемента справочника.
code Учетный код элемента справочника. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
name Наименование элемента справочника.
full_name Полное наименование элемента справочника. При создании, в случае отсутствия в переданных данных будет заполнен данными из атрибута "name".
is_predefined Булево значение - признак предопределенного элемента системы.
status_id Статус элемента справочника. Возможные значения: ПомеченНаУдаление, Активен. Значение по умолчанию - Активен.
append_user_id Идентификатор автора элемента из справочника RefUser.
append_date Дата и время создания элемента справочника в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в элемент справочника.
change_date Дата и время последнего изменения элемента справочника в SQL формате.
is_folder Булево значение - признак группы в справочнике.
parent_folder_id Идентификатор родительской группы из данного справочника.
comment Поле с произвольным текстом.
is_dynamic Булево значение - признак расчета цен автоматически на основании другого типа цен.
base_price_type_id Идентификатор базового типа цен из справочника RefPriceType.
percent Наценка по отношению к базовому типу цен.

Документы

Оприходование товаров (DocAcceptance)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
price_type_id Идентификатор типа цен из справочника RefPriceType.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
sum Сумма документа.
comment Поле с произвольным текстом.
products.product_id Идентификатор товара из справочника RefNomenclature.
products.sku_id Идентификатор модификации товара из справочника RefSku. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанного товара.
products.unit_id Идентификатор единицы измерения товара из справочника RefUnit. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанного товара.
products.factor Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной единицы измерения.
products.quantity Количество указанного товара.
products.price Цена указанного товара.
products.sum Сумма указанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
products.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
products.vat_sum Сумма НДС указанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.

Поступление денежных средств через эквайера (DocAcquiringIn)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
contractor_id Идентификатор контрагента из справочника RefContractor.
contract_id Идентификатор договора с контрагентом из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
acquiring_contract_id Идентификатор договора с эквайером из справочника RefContract.
acquiring_payment_type_id Идентификатор вида оплаты через эквайера из справочника RefAcquiringPaymentType.
concession_percent Процент торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет заполнен на основании данных в виде оплаты.
concession_sum Сумма торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет рассчитан автоматически на основании суммы документа и процента торговой уступки.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
document_basis_id Идентификатор документа основания.
document_basis_type_id Тип документа основания. Возможные значения: DocSaleOrder и DocSale.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
sum Сумма документа.
comment Поле с произвольным текстом.
details.sale_order_id Идентификатор заказа покупателя DocSaleOrder.
details.sum Сумма платежа.
details.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
details.vat_sum Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.

Возврат денежных средств через эквайера (DocAcquiringOut)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
contractor_id Идентификатор контрагента из справочника RefContractor.
contract_id Идентификатор договора с контрагентом из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
acquiring_contract_id Идентификатор договора с эквайером из справочника RefContract.
acquiring_payment_type_id Идентификатор вида оплаты через эквайера из справочника RefAcquiringPaymentType.
concession_percent Процент торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет заполнен на основании данных в виде оплаты.
concession_sum Сумма торговой уступки отчисляемый в пользу эквайера. При создании, в случае отсутствия в переданных данных будет рассчитан автоматически на основании суммы документа и процента торговой уступки.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
document_basis_id Идентификатор документа основания.
document_basis_type_id Тип документа основания. Возможные значения: DocSaleOrder и DocSaleReturn.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
sum Сумма документа.
comment Поле с произвольным текстом.
details.sale_order_id Идентификатор заказа покупателя DocSaleOrder.
details.sum Сумма возврата.
details.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
details.vat_sum Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.

Платежное поручение входящее (DocBankOrderIn)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
contractor_id Идентификатор контрагента из справочника RefContractor.
contract_id Идентификатор договора с контрагентом из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
contractor_bank_account_id Идентификатор банковского счета контрагента из справочника RefBankAccount.
organization_bank_account_id Идентификатор банковского счета собственной организации из справочника RefBankAccount.
type_id Вид операции. Возможные значения: ОплатаОтПокупателя, ВозвратОтПоставщика, ПоступлениеОтЭквайера и ПрочееПоступление.
incoming_number Номер первичного документа, полученного из банка.
incoming_date Дата первичного документа, полученного из банка в SQL формате.
is_processed Булево значение, которое отражает факт проведения документа в банке.
process_date Дата в SQL формате, которая отражает дату проведения документа банком.
text_basis Назначение платежа.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
document_basis_id Идентификатор документа основания.
document_basis_type_id Тип документа основания. Возможные значения: DocSaleOrder, DocSale, DocPurchaseOrder и DocPurchaseReturn.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
sum Сумма документа.
comment Поле с произвольным текстом.
details.document_basis_id Идентификатор заказа покупателя DocSaleOrder или заказа поставщику DocPurchaseOrder.
details.document_basis_type_id Идентификатор типа заказа покупателя. Возможные значения: DocSaleOrder и DocPurchaseOrder.
details.money_flow_item_id Идентификатор статьи движения денежных средств из справочника RefMoneyFlowItem.
details.sum Сумма поступления.
details.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
details.vat_sum Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.

Платежное поручение исходящее (DocBankOrderOut)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
contractor_id Идентификатор контрагента из справочника RefContractor.
contract_id Идентификатор договора с контрагентом из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным контрагентом в системе. При отсутствии такового, будет автоматически создан новый договор.
contractor_bank_account_id Идентификатор банковского счета контрагента из справочника RefBankAccount.
organization_bank_account_id Идентификатор банковского счета собственной организации из справочника RefBankAccount.
type_id Вид операции. Возможные значения: ОплатаПоставщику, ВозвратПокупателю, ВозвратЭквайеру и ПрочееСписание.
incoming_number Номер первичного документа, полученного из банка.
incoming_date Дата первичного документа, полученного из банка в SQL формате.
is_processed Булево значение, которое отражает факт проведения документа в банке.
process_date Дата в SQL формате, которая отражает дату проведения документа банком.
text_basis Назначение платежа.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
document_basis_id Идентификатор документа основания.
document_basis_type_id Тип документа основания. Возможные значения: DocSaleOrder, DocSale, DocPurchaseOrder и DocPurchaseReturn.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
sum Сумма документа.
comment Поле с произвольным текстом.
details.document_basis_id Идентификатор заказа покупателя DocSaleOrder или заказа поставщику DocPurchaseOrder.
details.document_basis_type_id Идентификатор типа заказа покупателя. Возможные значения: DocSaleOrder и DocPurchaseOrder.
details.money_flow_item_id Идентификатор статьи движения денежных средств из справочника RefMoneyFlowItem.
details.sum Сумма списания.
details.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
details.vat_sum Сумма НДС. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании суммы и ставки НДС.

Заказ покупателя (DocSaleOrder)

Имя атрибута Описание
id Идентификатор документа.
date_time Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой.
number Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически.
status_id Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик.
organization_id Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе.
contractor_id Идентификатор покупателя из справочника RefContractor.
contract_id Идентификатор договора с покупателем из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным покупателем в системе. При отсутствии такового, будет автоматически создан новый договор.
currency_id Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль".
price_type_id Идентификатор типа цен из справочника RefPriceType.
is_price_include_vat Булево значение - признак включение НДС в стоимость товаров и услуг.
external_number Номер заказа покупателя из внешней системы.
append_user_id Идентификатор автора документа из справочника RefUser.
append_date Дата и время создания документа в SQL формате.
change_user_id Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ.
change_date Дата и время последнего изменения документа в SQL формате.
responsible_user_id Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя.
document_basis_id Идентификатор документа основания.
document_basis_type_id Тип документа основания. Возможные значения: (Отсутствуют).
sum Сумма документа.
comment Поле с произвольным текстом.
products.product_id Идентификатор товара из справочника RefNomenclature.
products.sku_id Идентификатор модификации товара из справочника RefSku. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанного товара.
products.unit_id Идентификатор единицы измерения товара из справочника RefUnit. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанного товара.
products.factor Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной единицы измерения.
products.quantity Количество заказанного товара.
products.price Цена заказанного товара.
products.sum Сумма заказанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
products.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
products.vat_sum Сумма НДС заказанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
services.service_id Идентификатор услуги из справочника RefNomenclature.
services.sku_id Идентификатор модификации услуги из справочника RefSku. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором основной модификации указанной услуги.
services.unit_id Идентификатор единицы измерения услуги из справочника RefUnit. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором базовой единицы измерения указанной услуги.
services.factor Коэффициент - кол-во базовых единиц измерения номенклатуры в текущей единице измерения. При создании, в случае отсутствия в переданных данных будет заполнен коэффициентом указанной единицы измерения.
services.quantity Количество заказанных услуг.
services.price Цена заказанной услуги.
services.sum Сумма заказанных услуг. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
services.vat_rate_id Ставка НДС. Возможные значения: НДС18, НДС18_118, НДС10, НДС10_110, НДС0, БезНДС.
services.vat_sum Сумма НДС заказанных услуг. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС.
services.execution_address_id Идентификатор адреса из справочника RefAddress, по которому будет оказана услуга. Например, адрес доставки.
services.execution_date_time Планируемая дата и время оказания услуги в SQL формате.
Источник — «http://wiki.mrdoc.org/index.php?title=Описание_объектов_API&oldid=293»