Mr.Doc - Вклад участника [ru]

Справочная система Mr.Doc

2020-03-27T06:42:44Z

Super-admin:

;Начало работы
:[[Регистрация]]
:[[Общие принципы работы с документами]]
:[[Общие принципы работы со справочниками]]
:[[Заполнение данных организации]]
:[[Наполнение справочника контрагентов]]
:[[Наполнение справочника товаров]]
:[[Установка цен и наличия]]
:[[Ввод начальных остатков]]
;Справочники
:[[Договоры]]
:[[Модификации]]
:[[Статьи движения денежных средств]]
:[[Дополнительные статусы]]
;API
:[[Настройка доступа к API|Настройка доступа]]
:[[Описание объектов API|Описание объектов API]]
:[[Создание заказа покупателя через API|Как создать заказ покупателя]]
;Интеграция с интернет-магазинами
:[[Синхронизация с интернет-магазином Prestashop]]
;Интеграция с поставщиками
:[[Загрузка данных с сайтов поставщиков‎‎]]

Создание заказа покупателя через API

2014-07-05T08:38:56Z

Super-admin:

[[Category:API]]
Данная статья посвящена обмену данными с системой Mr.Doc через REST API интерфейс на примере создания заказа покупателя.

== Доступ к API ==
Перед выполнением операций с системой через API необходимо настроить права доступа для учетной записи, от которой будут производиться запросы. Подробнее об этом можно прочитать в разделе [[Настройка доступа к API]].

== Структура запроса ==
Создание заказа осуществляется посредством POST-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производиться обмен (JSON или XML соответственно).
В теле запроса должна содержаться информация о новом документе в выбранном формате.
=== Пример JSON ===
<syntaxhighlight lang=javascript>
{
"date_time": "2014-01-01 12:00:00",
"number": "SF-00001",
"status_id": "Черновик",
"organization_id": 1,
"contractor_id": 50,
"contract_id": 55,
"currency_id": 1,
"price_type_id": 2,
"is_price_include_vat": false,
"external_number": "SF-00001",
"products": [
{
"product_id": 113,
"sku_id": 145,
"unit_id": 113,
"factor": 1,
"quantity": 8,
"price": 250,
"sum": 2000,
"vat_rate_id": "БезНДС",
"vat_sum": 0
},
{
"product_id": 245,
"sku_id": 645,
"unit_id": 245,
"factor": 1,
"quantity": 1,
"price": 540,
"sum": 540,
"vat_rate_id": "БезНДС",
"vat_sum": 0
}
],
"services": [
{
"service_id": 5,
"sku_id": 5,
"unit_id": 5,
"factor": 1,
"quantity": 1,
"price": 550,
"sum": 550,
"vat_rate_id": "БезНДС",
"vat_sum": 0,
"execution_address_id": 198,
"execution_date_time": "2014-01-05 16:30:00"
}
]
}
</syntaxhighlight>

=== Пример XML ===
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<root>
<date_time>2014-01-01 12:00:00</date_time>
<number>SF-00001</number>
<status_id>Черновик</status_id>
<organization_id>1</organization_id>
<contractor_id>50</contractor_id>
<contract_id>55</contract_id>
<currency_id>1</currency_id>
<price_type_id>2</price_type_id>
<is_price_include_vat>0</is_price_include_vat>
<external_number>SF-00001</external_number>
<products list="true">
<item>
<product_id>113</product_id>
<sku_id>145</sku_id>
<unit_id>113</unit_id>
<factor>1</factor>
<quantity>8</quantity>
<price>250</price>
<sum>2000</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
<item>
<product_id>245</product_id>
<sku_id>645</sku_id>
<unit_id>245</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>540</price>
<sum>540</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
</products>
<services list="true">
<item>
<service_id>5</service_id>
<sku_id>5</sku_id>
<unit_id>5</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>550</price>
<sum>550</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
<execution_address_id>198</execution_address_id>
<execution_date_time>2014-01-05 16:30:00</execution_date_time>
</item>
</services>
</root>
</syntaxhighlight>

=== Атрибуты ===
Следующие атрибуты являются обязательными к заполнению:
* contractor_id
* products.product_id
* products.quantity
* products.price
* products.vat_rate_id
* services.service_id
* services.quantity
* services.price
* services.vat_rate_id
Остальные атрибуты в случае их отсутствия будут вычислены автоматически заполнены значениями по умолчанию.
Отсутствующим атрибутом считается тот, для которого отсутствует соответствующий ключ в переданных данных, а не только его значение. В примере ниже атрибут '''number''' является отсутствующим, а '''date_time''' просто с пустым значением.
<pre>
{
"date_time": "",
"status_id": "Черновик",
"organization_id": 1
}
</pre>

{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

== Получение идентификаторов атрибутов-ссылок ==
Так как в качестве большинства атрибутов используются идентификаторы, целесообразно предварительно получить эти идентификаторы.
Рассмотрим получение идентификатора на примере атрибута '''"Покупатель"'''.
=== Поиск элемента в справочнике ===
Получение списка покупателей осуществляется посредством GET-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производится обмен (JSON или XML соответственно).
В качестве GET-параметров стоит указать набор полей, который необходимо вернуть и фильтр, по которому необходимо найти требуемого покупателя.
==== Пример JSON ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
{
"result": [
{
"id": "2",
"type_id": "ЮрЛицо"
}
]
}
</pre>

==== Пример XML ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result list="true">
<item>
<id><![CDATA[2]]></id>
<type_id><![CDATA[ЮрЛицо]]></type_id>
</item>
</result>
</root>
</pre>

=== Создание элемента справочника ===
В случае отсутствия необходимого покупателя в справочнике, его можно создать посредством POST-запроса на эти же адреса, аналогично созданию заказа покупателя, описанного в данной статье.
Ответом на POST-запрос будет идентификатор вновь созданной записи.
==== Пример JSON ====
<pre>
{
"result": {
"id": 583
}
}
</pre>
==== Пример XML ====
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>
<id><![CDATA[583]]></id>
</result>
</root>
</pre>
Более подробно о атрибутах объектов системы можно прочитать в статье [[Описание объектов API]]

Создание заказа покупателя через API

2014-03-11T16:12:44Z

Super-admin:

[[Category:API]]
Данная статья посвящена обмену данными с системой Mr.Doc через REST API интерфейс на примере создания заказа покупателя.

== Доступ к API ==
Перед выполнением операций с системой через API необходимо настроить права доступа для учетной записи, от которой будут производиться запросы. Подробнее об этом можно прочитать в разделе [[Настройка доступа к API]].

== Структура запроса ==
Создание заказа осуществляется посредством PUT-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производиться обмен (JSON или XML соответственно).
В теле запроса должна содержаться информация о новом документе в выбранном формате.
=== Пример JSON ===
<syntaxhighlight lang=javascript>
{
"date_time": "2014-01-01 12:00:00",
"number": "SF-00001",
"status_id": "Черновик",
"organization_id": 1,
"contractor_id": 50,
"contract_id": 55,
"currency_id": 1,
"price_type_id": 2,
"is_price_include_vat": false,
"external_number": "SF-00001",
"products": [
{
"product_id": 113,
"sku_id": 145,
"unit_id": 113,
"factor": 1,
"quantity": 8,
"price": 250,
"sum": 2000,
"vat_rate_id": "БезНДС",
"vat_sum": 0
},
{
"product_id": 245,
"sku_id": 645,
"unit_id": 245,
"factor": 1,
"quantity": 1,
"price": 540,
"sum": 540,
"vat_rate_id": "БезНДС",
"vat_sum": 0
}
],
"services": [
{
"service_id": 5,
"sku_id": 5,
"unit_id": 5,
"factor": 1,
"quantity": 1,
"price": 550,
"sum": 550,
"vat_rate_id": "БезНДС",
"vat_sum": 0,
"execution_address_id": 198,
"execution_date_time": "2014-01-05 16:30:00"
}
]
}
</syntaxhighlight>

=== Пример XML ===
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<root>
<date_time>2014-01-01 12:00:00</date_time>
<number>SF-00001</number>
<status_id>Черновик</status_id>
<organization_id>1</organization_id>
<contractor_id>50</contractor_id>
<contract_id>55</contract_id>
<currency_id>1</currency_id>
<price_type_id>2</price_type_id>
<is_price_include_vat>0</is_price_include_vat>
<external_number>SF-00001</external_number>
<products list="true">
<item>
<product_id>113</product_id>
<sku_id>145</sku_id>
<unit_id>113</unit_id>
<factor>1</factor>
<quantity>8</quantity>
<price>250</price>
<sum>2000</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
<item>
<product_id>245</product_id>
<sku_id>645</sku_id>
<unit_id>245</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>540</price>
<sum>540</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
</products>
<services list="true">
<item>
<service_id>5</service_id>
<sku_id>5</sku_id>
<unit_id>5</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>550</price>
<sum>550</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
<execution_address_id>198</execution_address_id>
<execution_date_time>2014-01-05 16:30:00</execution_date_time>
</item>
</services>
</root>
</syntaxhighlight>

=== Атрибуты ===
Следующие атрибуты являются обязательными к заполнению:
* contractor_id
* products.product_id
* products.quantity
* products.price
* products.vat_rate_id
* services.service_id
* services.quantity
* services.price
* services.vat_rate_id
Остальные атрибуты в случае их отсутствия будут вычислены автоматически заполнены значениями по умолчанию.
Отсутствующим атрибутом считается тот, для которого отсутствует соответствующий ключ в переданных данных, а не только его значение. В примере ниже атрибут '''number''' является отсутствующим, а '''date_time''' просто с пустым значением.
<pre>
{
"date_time": "",
"status_id": "Черновик",
"organization_id": 1
}
</pre>

{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

== Получение идентификаторов атрибутов-ссылок ==
Так как в качестве большинства атрибутов используются идентификаторы, целесообразно предварительно получить эти идентификаторы.
Рассмотрим получение идентификатора на примере атрибута '''"Покупатель"'''.
=== Поиск элемента в справочнике ===
Получение списка покупателей осуществляется посредством GET-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производится обмен (JSON или XML соответственно).
В качестве GET-параметров стоит указать набор полей, который необходимо вернуть и фильтр, по которому необходимо найти требуемого покупателя.
==== Пример JSON ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
{
"result": [
{
"id": "2",
"type_id": "ЮрЛицо"
}
]
}
</pre>

==== Пример XML ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result list="true">
<item>
<id><![CDATA[2]]></id>
<type_id><![CDATA[ЮрЛицо]]></type_id>
</item>
</result>
</root>
</pre>

=== Создание элемента справочника ===
В случае отсутствия необходимого покупателя в справочнике, его можно создать посредством PUT-запроса на эти же адреса, аналогично созданию заказа покупателя, описанного в данной статье.
Ответом на PUT-запрос будет идентификатор вновь созданной записи.
==== Пример JSON ====
<pre>
{
"result": {
"id": 583
}
}
</pre>
==== Пример XML ====
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>
<id><![CDATA[583]]></id>
</result>
</root>
</pre>
Более подробно о атрибутах объектов системы можно прочитать в статье [[Описание объектов API]]

MediaWiki:Geshi.css

2014-03-11T15:35:34Z

Super-admin: Новая страница: «/* CSS-код, размещённый здесь, будет применён для подсветки синтаксиса GeSHI */ div.mw-geshi div,pre { font…»

/* CSS-код, размещённый здесь, будет применён для подсветки синтаксиса GeSHI */
div.mw-geshi div,pre {
font-family: monospace, "Courier New" !important;
font-size:13px;
}

Создание заказа покупателя через API

2014-03-11T15:31:27Z

Super-admin: /* Пример XML */

[[Category:API]]
Данная статья посвящена обмену данными с системой Mr.Doc через REST API интерфейс на примере создания заказа покупателя.

== Доступ к API ==
Перед выполнением операций с системой через API необходимо настроить права доступа для учетной записи, от которой будут производиться запросы. Подробнее об этом можно прочитать в разделе [[Настройка доступа к API]].

== Структура запроса ==
Создание заказа осуществляется посредством PUT-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производиться обмен (JSON или XML соответственно).
В теле запроса должна содержаться информация о новом документе в выбранном формате.
=== Пример JSON ===
<pre>
{
"date_time": "2014-01-01 12:00:00",
"number": "SF-00001",
"status_id": "Черновик",
"organization_id": 1,
"contractor_id": 50,
"contract_id": 55,
"currency_id": 1,
"price_type_id": 2,
"is_price_include_vat": false,
"external_number": "SF-00001",
"products": [
{
"product_id": 113,
"sku_id": 145,
"unit_id": 113,
"factor": 1,
"quantity": 8,
"price": 250,
"sum": 2000,
"vat_rate_id": "БезНДС",
"vat_sum": 0
},
{
"product_id": 245,
"sku_id": 645,
"unit_id": 245,
"factor": 1,
"quantity": 1,
"price": 540,
"sum": 540,
"vat_rate_id": "БезНДС",
"vat_sum": 0
}
],
"services": [
{
"service_id": 5,
"sku_id": 5,
"unit_id": 5,
"factor": 1,
"quantity": 1,
"price": 550,
"sum": 550,
"vat_rate_id": "БезНДС",
"vat_sum": 0,
"execution_address_id": 198,
"execution_date_time": "2014-01-05 16:30:00"
}
]
}
</pre>

=== Пример XML ===
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<root>
<date_time>2014-01-01 12:00:00</date_time>
<number>SF-00001</number>
<status_id>Черновик</status_id>
<organization_id>1</organization_id>
<contractor_id>50</contractor_id>
<contract_id>55</contract_id>
<currency_id>1</currency_id>
<price_type_id>2</price_type_id>
<is_price_include_vat>0</is_price_include_vat>
<external_number>SF-00001</external_number>
<products list="true">
<item>
<product_id>113</product_id>
<sku_id>145</sku_id>
<unit_id>113</unit_id>
<factor>1</factor>
<quantity>8</quantity>
<price>250</price>
<sum>2000</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
<item>
<product_id>245</product_id>
<sku_id>645</sku_id>
<unit_id>245</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>540</price>
<sum>540</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
</products>
<services list="true">
<item>
<service_id>5</service_id>
<sku_id>5</sku_id>
<unit_id>5</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>550</price>
<sum>550</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
<execution_address_id>198</execution_address_id>
<execution_date_time>2014-01-05 16:30:00</execution_date_time>
</item>
</services>
</root>
</syntaxhighlight>

=== Атрибуты ===
Следующие атрибуты являются обязательными к заполнению:
* contractor_id
* products.product_id
* products.quantity
* products.price
* products.vat_rate_id
* services.service_id
* services.quantity
* services.price
* services.vat_rate_id
Остальные атрибуты в случае их отсутствия будут вычислены автоматически заполнены значениями по умолчанию.
Отсутствующим атрибутом считается тот, для которого отсутствует соответствующий ключ в переданных данных, а не только его значение. В примере ниже атрибут '''number''' является отсутствующим, а '''date_time''' просто с пустым значением.
<pre>
{
"date_time": "",
"status_id": "Черновик",
"organization_id": 1
}
</pre>

{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

== Получение идентификаторов атрибутов-ссылок ==
Так как в качестве большинства атрибутов используются идентификаторы, целесообразно предварительно получить эти идентификаторы.
Рассмотрим получение идентификатора на примере атрибута '''"Покупатель"'''.
=== Поиск элемента в справочнике ===
Получение списка покупателей осуществляется посредством GET-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производится обмен (JSON или XML соответственно).
В качестве GET-параметров стоит указать набор полей, который необходимо вернуть и фильтр, по которому необходимо найти требуемого покупателя.
==== Пример JSON ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
{
"result": [
{
"id": "2",
"type_id": "ЮрЛицо"
}
]
}
</pre>

==== Пример XML ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result list="true">
<item>
<id><![CDATA[2]]></id>
<type_id><![CDATA[ЮрЛицо]]></type_id>
</item>
</result>
</root>
</pre>

=== Создание элемента справочника ===
В случае отсутствия необходимого покупателя в справочнике, его можно создать посредством PUT-запроса на эти же адреса, аналогично созданию заказа покупателя, описанного в данной статье.
Ответом на PUT-запрос будет идентификатор вновь созданной записи.
==== Пример JSON ====
<pre>
{
"result": {
"id": 583
}
}
</pre>
==== Пример XML ====
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>
<id><![CDATA[583]]></id>
</result>
</root>
</pre>
Более подробно о атрибутах объектов системы можно прочитать в статье [[Описание объектов API]]

Создание заказа покупателя через API

2014-03-11T15:31:10Z

Super-admin: /* Пример XML */

[[Category:API]]
Данная статья посвящена обмену данными с системой Mr.Doc через REST API интерфейс на примере создания заказа покупателя.

== Доступ к API ==
Перед выполнением операций с системой через API необходимо настроить права доступа для учетной записи, от которой будут производиться запросы. Подробнее об этом можно прочитать в разделе [[Настройка доступа к API]].

== Структура запроса ==
Создание заказа осуществляется посредством PUT-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производиться обмен (JSON или XML соответственно).
В теле запроса должна содержаться информация о новом документе в выбранном формате.
=== Пример JSON ===
<pre>
{
"date_time": "2014-01-01 12:00:00",
"number": "SF-00001",
"status_id": "Черновик",
"organization_id": 1,
"contractor_id": 50,
"contract_id": 55,
"currency_id": 1,
"price_type_id": 2,
"is_price_include_vat": false,
"external_number": "SF-00001",
"products": [
{
"product_id": 113,
"sku_id": 145,
"unit_id": 113,
"factor": 1,
"quantity": 8,
"price": 250,
"sum": 2000,
"vat_rate_id": "БезНДС",
"vat_sum": 0
},
{
"product_id": 245,
"sku_id": 645,
"unit_id": 245,
"factor": 1,
"quantity": 1,
"price": 540,
"sum": 540,
"vat_rate_id": "БезНДС",
"vat_sum": 0
}
],
"services": [
{
"service_id": 5,
"sku_id": 5,
"unit_id": 5,
"factor": 1,
"quantity": 1,
"price": 550,
"sum": 550,
"vat_rate_id": "БезНДС",
"vat_sum": 0,
"execution_address_id": 198,
"execution_date_time": "2014-01-05 16:30:00"
}
]
}
</pre>

=== Пример XML ===
<syntaxhighlight lang=c>
<?xml version="1.0" encoding="utf-8"?>
<root>
<date_time>2014-01-01 12:00:00</date_time>
<number>SF-00001</number>
<status_id>Черновик</status_id>
<organization_id>1</organization_id>
<contractor_id>50</contractor_id>
<contract_id>55</contract_id>
<currency_id>1</currency_id>
<price_type_id>2</price_type_id>
<is_price_include_vat>0</is_price_include_vat>
<external_number>SF-00001</external_number>
<products list="true">
<item>
<product_id>113</product_id>
<sku_id>145</sku_id>
<unit_id>113</unit_id>
<factor>1</factor>
<quantity>8</quantity>
<price>250</price>
<sum>2000</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
<item>
<product_id>245</product_id>
<sku_id>645</sku_id>
<unit_id>245</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>540</price>
<sum>540</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
</products>
<services list="true">
<item>
<service_id>5</service_id>
<sku_id>5</sku_id>
<unit_id>5</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>550</price>
<sum>550</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
<execution_address_id>198</execution_address_id>
<execution_date_time>2014-01-05 16:30:00</execution_date_time>
</item>
</services>
</root>
</syntaxhighlight>

=== Атрибуты ===
Следующие атрибуты являются обязательными к заполнению:
* contractor_id
* products.product_id
* products.quantity
* products.price
* products.vat_rate_id
* services.service_id
* services.quantity
* services.price
* services.vat_rate_id
Остальные атрибуты в случае их отсутствия будут вычислены автоматически заполнены значениями по умолчанию.
Отсутствующим атрибутом считается тот, для которого отсутствует соответствующий ключ в переданных данных, а не только его значение. В примере ниже атрибут '''number''' является отсутствующим, а '''date_time''' просто с пустым значением.
<pre>
{
"date_time": "",
"status_id": "Черновик",
"organization_id": 1
}
</pre>

{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

== Получение идентификаторов атрибутов-ссылок ==
Так как в качестве большинства атрибутов используются идентификаторы, целесообразно предварительно получить эти идентификаторы.
Рассмотрим получение идентификатора на примере атрибута '''"Покупатель"'''.
=== Поиск элемента в справочнике ===
Получение списка покупателей осуществляется посредством GET-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производится обмен (JSON или XML соответственно).
В качестве GET-параметров стоит указать набор полей, который необходимо вернуть и фильтр, по которому необходимо найти требуемого покупателя.
==== Пример JSON ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
{
"result": [
{
"id": "2",
"type_id": "ЮрЛицо"
}
]
}
</pre>

==== Пример XML ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result list="true">
<item>
<id><![CDATA[2]]></id>
<type_id><![CDATA[ЮрЛицо]]></type_id>
</item>
</result>
</root>
</pre>

=== Создание элемента справочника ===
В случае отсутствия необходимого покупателя в справочнике, его можно создать посредством PUT-запроса на эти же адреса, аналогично созданию заказа покупателя, описанного в данной статье.
Ответом на PUT-запрос будет идентификатор вновь созданной записи.
==== Пример JSON ====
<pre>
{
"result": {
"id": 583
}
}
</pre>
==== Пример XML ====
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>
<id><![CDATA[583]]></id>
</result>
</root>
</pre>
Более подробно о атрибутах объектов системы можно прочитать в статье [[Описание объектов API]]

Создание заказа покупателя через API

2014-03-11T15:28:08Z

Super-admin: /* Пример XML */

[[Category:API]]
Данная статья посвящена обмену данными с системой Mr.Doc через REST API интерфейс на примере создания заказа покупателя.

== Доступ к API ==
Перед выполнением операций с системой через API необходимо настроить права доступа для учетной записи, от которой будут производиться запросы. Подробнее об этом можно прочитать в разделе [[Настройка доступа к API]].

== Структура запроса ==
Создание заказа осуществляется посредством PUT-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/DocSaleOrder.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производиться обмен (JSON или XML соответственно).
В теле запроса должна содержаться информация о новом документе в выбранном формате.
=== Пример JSON ===
<pre>
{
"date_time": "2014-01-01 12:00:00",
"number": "SF-00001",
"status_id": "Черновик",
"organization_id": 1,
"contractor_id": 50,
"contract_id": 55,
"currency_id": 1,
"price_type_id": 2,
"is_price_include_vat": false,
"external_number": "SF-00001",
"products": [
{
"product_id": 113,
"sku_id": 145,
"unit_id": 113,
"factor": 1,
"quantity": 8,
"price": 250,
"sum": 2000,
"vat_rate_id": "БезНДС",
"vat_sum": 0
},
{
"product_id": 245,
"sku_id": 645,
"unit_id": 245,
"factor": 1,
"quantity": 1,
"price": 540,
"sum": 540,
"vat_rate_id": "БезНДС",
"vat_sum": 0
}
],
"services": [
{
"service_id": 5,
"sku_id": 5,
"unit_id": 5,
"factor": 1,
"quantity": 1,
"price": 550,
"sum": 550,
"vat_rate_id": "БезНДС",
"vat_sum": 0,
"execution_address_id": 198,
"execution_date_time": "2014-01-05 16:30:00"
}
]
}
</pre>

=== Пример XML ===
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<root>
<date_time>2014-01-01 12:00:00</date_time>
<number>SF-00001</number>
<status_id>Черновик</status_id>
<organization_id>1</organization_id>
<contractor_id>50</contractor_id>
<contract_id>55</contract_id>
<currency_id>1</currency_id>
<price_type_id>2</price_type_id>
<is_price_include_vat>0</is_price_include_vat>
<external_number>SF-00001</external_number>
<products list="true">
<item>
<product_id>113</product_id>
<sku_id>145</sku_id>
<unit_id>113</unit_id>
<factor>1</factor>
<quantity>8</quantity>
<price>250</price>
<sum>2000</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
<item>
<product_id>245</product_id>
<sku_id>645</sku_id>
<unit_id>245</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>540</price>
<sum>540</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
</item>
</products>
<services list="true">
<item>
<service_id>5</service_id>
<sku_id>5</sku_id>
<unit_id>5</unit_id>
<factor>1</factor>
<quantity>1</quantity>
<price>550</price>
<sum>550</sum>
<vat_rate_id>БезНДС</vat_rate_id>
<vat_sum>0</vat_sum>
<execution_address_id>198</execution_address_id>
<execution_date_time>2014-01-05 16:30:00</execution_date_time>
</item>
</services>
</root>
</syntaxhighlight>

=== Атрибуты ===
Следующие атрибуты являются обязательными к заполнению:
* contractor_id
* products.product_id
* products.quantity
* products.price
* products.vat_rate_id
* services.service_id
* services.quantity
* services.price
* services.vat_rate_id
Остальные атрибуты в случае их отсутствия будут вычислены автоматически заполнены значениями по умолчанию.
Отсутствующим атрибутом считается тот, для которого отсутствует соответствующий ключ в переданных данных, а не только его значение. В примере ниже атрибут '''number''' является отсутствующим, а '''date_time''' просто с пустым значением.
<pre>
{
"date_time": "",
"status_id": "Черновик",
"organization_id": 1
}
</pre>

{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

== Получение идентификаторов атрибутов-ссылок ==
Так как в качестве большинства атрибутов используются идентификаторы, целесообразно предварительно получить эти идентификаторы.
Рассмотрим получение идентификатора на примере атрибута '''"Покупатель"'''.
=== Поиск элемента в справочнике ===
Получение списка покупателей осуществляется посредством GET-запроса на один из адресов:
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>''
* ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>''
в зависимости от того, в каком формате будет производится обмен (JSON или XML соответственно).
В качестве GET-параметров стоит указать набор полей, который необходимо вернуть и фильтр, по которому необходимо найти требуемого покупателя.
==== Пример JSON ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">json</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
{
"result": [
{
"id": "2",
"type_id": "ЮрЛицо"
}
]
}
</pre>

==== Пример XML ====
URL: ''https://<span style="color:red;">company_name</span>.mrdoc.org/api/1/RefContractor.<span style="color:red;">xml</span>?fields[]=id&fields[]=type_id&filters[email][]="sale@askona.ru"''

Ответ:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result list="true">
<item>
<id><![CDATA[2]]></id>
<type_id><![CDATA[ЮрЛицо]]></type_id>
</item>
</result>
</root>
</pre>

=== Создание элемента справочника ===
В случае отсутствия необходимого покупателя в справочнике, его можно создать посредством PUT-запроса на эти же адреса, аналогично созданию заказа покупателя, описанного в данной статье.
Ответом на PUT-запрос будет идентификатор вновь созданной записи.
==== Пример JSON ====
<pre>
{
"result": {
"id": 583
}
}
</pre>
==== Пример XML ====
<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>
<id><![CDATA[583]]></id>
</result>
</root>
</pre>
Более подробно о атрибутах объектов системы можно прочитать в статье [[Описание объектов API]]

Описание объектов API

2014-03-11T14:51:51Z

Super-admin: /* Типы цен(RefPriceType) */

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-11T14:51:33Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-11T10:38:34Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Количество знаков после запятой..

|-
!contractor_id
|Идентификатор контрагента из справочника '''RefContractor'''.

|-
!type_id
|Тип договора. Возможные значения: СПокупателем, СПоставщиком, СЭквайером, Прочее.

|-
!calculation_type_id
|Порядок расчетов. Возможные значения: ПоДоговоруВЦелом, ПоЗаказам.

|}
== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-11T09:25:29Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Булево значение - признак ведения расчетов по предоплате.

|}
== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-11T08:18:01Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Прочие контакты.

|}

== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-11T08:08:46Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|КПП организации.

|-
!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
|Прочие контакты.

|}

== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-07T14:45:05Z

Super-admin: /* Организации (RefOrganization) */

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Прочие контакты.

|}

== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-07T14:21:37Z

Super-admin: /* Организации (RefOrganization) */

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Префикс для генерации номеров документов.

|}

== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-07T14:19:46Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"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"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
</pre>
</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
|Префикс для генерации номеров документов.

|}
== Документы ==

=== Оприходование товаров (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) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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 формате.

|}

Описание объектов API

2014-03-07T13:08:43Z

Super-admin:

Описание объектов API

2014-03-07T11:24:45Z

Super-admin:

Описание объектов API

2014-03-07T10:44:41Z

Super-admin:

Описание объектов API

2014-03-07T10:37:58Z

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

Описание объектов API

2014-03-07T09:32:52Z

Super-admin:

Описание объектов API

2014-03-07T08:00:23Z

Super-admin:

Описание объектов API

2014-03-07T07:25:19Z

Super-admin:

Описание объектов API

2014-03-07T07:21:54Z

Super-admin:

Описание объектов API

2014-03-06T14:38:12Z

Super-admin: /* Заказ покупателя (DocSaleOrder) */

Описание объектов API

2014-03-06T11:56:42Z

Super-admin:

Описание объектов API

2014-03-06T11:55:53Z

Super-admin:

Описание объектов API

2014-03-06T11:48:26Z

Super-admin:

Описание объектов API

2014-03-06T11:25:26Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4",
"table_part_field_3": "value_5"
},
{
"table_part_field_1": "value_6",
"table_part_field_2": "value_7",
"table_part_field_3": "value_8"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
<table_part_field_3>value_5</table_part_field_3>
</item>
<item>
<table_part_field_1>value_6</table_part_field_1>
<table_part_field_2>value_7</table_part_field_2>
<table_part_field_3>value_8</table_part_field_3>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
В примерах выше атрибут '''"table_part_name"''' - табличная часть, в которой два элемента. '''"table_part_field_1"''', '''"table_part_field_2"''' и '''"table_part_field_3"''' - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате '''"table_part_name.table_part_field_1"'''.
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T11:24:37Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4",
"table_part_field_3": "value_5"
},
{
"table_part_field_1": "value_6",
"table_part_field_2": "value_7",
"table_part_field_3": "value_8"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
<table_part_field_3>value_5</table_part_field_3>
</item>
<item>
<table_part_field_1>value_6</table_part_field_1>
<table_part_field_2>value_7</table_part_field_2>
<table_part_field_3>value_8</table_part_field_3>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
В примерах выше атрибут '''"table_part_name"''' - табличная часть, в которой два элемента. '''"table_part_field_1"''', '''"table_part_field_2"''' и '''"table_part_field_3"''' - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате "table_part_name.table_part_field_1".
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T11:24:01Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4",
"table_part_field_3": "value_5"
},
{
"table_part_field_1": "value_6",
"table_part_field_2": "value_7",
"table_part_field_3": "value_8"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
<table_part_field_3>value_5</table_part_field_3>
</item>
<item>
<table_part_field_1>value_6</table_part_field_1>
<table_part_field_2>value_7</table_part_field_2>
<table_part_field_3>value_8</table_part_field_3>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
В примерах выше атрибут "table_part_name" - табличная часть, в которой два элемента. "table_part_field_1", "table_part_field_2" и "table_part_field_3" - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате "table_part_name.table_part_field_1".
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T10:58:20Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T10:57:53Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
'''Пример XML'''
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:50:55Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
<p style=" text-align:center;">'''Пример XML'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:50:18Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}</pre>
</div>
<div style="float:left;">
<p style=" text-align:center;">'''Пример XML'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:47:19Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; margin-right: 20px;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
<p style=" text-align:center;">'''Пример XML'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:47:07Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left;">
<p style=" text-align:center; margin-right: 20px;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
<p style=" text-align:center;">'''Пример XML'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:12:06Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left; margin-left: 20px;">
<p style=" text-align:center;">'''Пример XML'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:11:05Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="float:left;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
<?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>
<table_part_field_1>value_3</table_part_field_1>
<table_part_field_2>value_4</table_part_field_2>
</item>
<item>
<table_part_field_1>value_5</table_part_field_1>
<table_part_field_2>value_6</table_part_field_2>
</item>
</table_part_name>
</root>
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T09:08:49Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left;">
<p style=" text-align:center;">'''Пример JSON'''</p>
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
<div style="clear:both;"></div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T08:55:29Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; text-align:center;">
'''Пример JSON'''
<pre>
{
"main_field_1": "value_1",
"main_field_2": "value_2",
"table_part_name": [
{
"table_part_field_1": "value_3",
"table_part_field_2": "value_4"
},
{
"table_part_field_1": "value_5",
"table_part_field_2": "value_6"
}
]
}
</pre>
</div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T08:52:06Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
<div style="float:left; text-align:center;">
'''Пример JSON'''
<pre>
{"main_field_1":"value_1","main_field_2":"value_2","table_part_name":[{"table_part_field_1":"value_3","table_part_field_2":"value_4"},{"table_part_field_1":"value_5","table_part_field_2":"value_6"}]}
</pre>
</div>
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-06T05:57:23Z

Super-admin:

[[Category:API]]
Данная статья посвящена описанию доступных через API объектов и их атрибутов.
Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей.
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-05T15:07:27Z

Super-admin:

Данная статья посвящена описанию доступных через API объектов и их атрибутов.
== Документы ==
=== Заказ покупателя (DocSaleOrder) ===
{| class="wikitable"
|-
!Имя атрибута
!Описание

|-
!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
|Номер заказа покупателя из внешней системы.

|-
!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 формате.

|}

Описание объектов API

2014-03-05T14:51:41Z

Super-admin: Новая страница: «Данная статья посвящена описанию доступных через API объектов и их атрибутов.»

Данная статья посвящена описанию доступных через API объектов и их атрибутов.

Справочная система Mr.Doc

2014-03-05T14:38:44Z

Super-admin:

;Начало работы
:[[Регистрация]]
:[[Общие принципы работы с документами]]
:[[Общие принципы работы со справочниками]]
:[[Заполнение данных организации]]
:[[Наполнение справочника контрагентов]]
:[[Наполнение справочника товаров]]
:[[Установка цен и наличия]]
:[[Ввод начальных остатков]]
;Справочники
:[[Договоры]]
:[[Модификации]]
:[[Статьи движения денежных средств]]
:[[Дополнительные статусы]]
;API
:[[Настройка доступа к API|Настройка доступа]]
:[[Создание заказа покупателя через API|Как создать заказ покупателя]]

Настройка доступа к API

2014-03-05T14:19:21Z

Super-admin:

[[Category:API]]
Для работы с API интерфейсом необходимо настроить соответствующие права доступа к системе.

== Создание роли ==
[[Файл:form_role.png|thumb|Карточка роли]]
Начать стоит с создания соответствующей роли, используя для этого пункт меню '''"Справочники - Роли пользователей"'''.
В форме создаваемой роли, на вкладке '''"Другие операции"''' нужно отметить необходимые операции с префиксом '''"API"'''.

== Создание пользователя ==
[[Файл:form_user.png|thumb|Карточка пользователя]]
Далее, через пункт меню '''"Справочники - Пользователи"''' необходимо создать пользователя, от имени которого будет осуществляться доступ к API.
В форме нового пользователя необходимо заполнить обязательные реквизиты и на вкладке '''"Связанные роли"''' отметить, созданную на предыдущем этапе роль.
Обратите внимание, что в системе существует предопределенная роль "Администраторы системы", пользователи которой имеют доступ ко всему функционалу системы, в том числе и API интерфейсу. Ответственно относитесь к сохранности паролей пользователей данной роли.

== Авторизация ==
Для работы с API требуется BASIC-авторизация, это подразумевает передачу логина и пароля указанных на предыдущем шаге в заголовках каждого запроса к API.

Настройка доступа к API

2014-03-05T14:16:31Z

Super-admin:

[[Category:API]]
Для работы с API интерфейсом необходимо настроить соответствующие права доступа к системе.

== Создание роли ==
[[Файл:form_role.png|thumb|Карточка роли]]
Начать стоит с создания соответствующей роли, используя для этого пункт меню '''"Справочники - Роли пользователей"'''.
В форме создаваемой роли, на вкладке '''"Другие операции"''' нужно отметить необходимые операции с префиксом '''"API"'''.

== Создание пользователя ==
[[Файл:form_user.png|thumb|Карточка пользователя]]
Далее, через пункт меню '''"Справочники - Пользователи"''' необходимо создать пользователя, от имени которого будет осуществляться доступ к API.
В форме нового пользователя необходимо заполнить обязательные реквизиты и на вкладке '''"Связанные роли"''' отметить, созданную на предыдущем этапе роль.
Обратите внимание, что в системе существует предопределенная роль "Администраторы системы", пользователи которой имеют доступ ко всему функционалу системы, в том числе и API интерфейсу. Ответственно относитесь к сохранности паролей пользователей данной роли.

== Авторизация ==
Для работы с API требуется BASIC-авторизация, это подразумевает передачу логина и пароля указанного на предыдущем шаге в заголовках каждого запроса к API.

Файл:Form user.png

2014-03-05T12:14:38Z

Super-admin:

Файл:Form role.png

2014-03-05T12:13:36Z

Super-admin: