Описание объектов API — различия между версиями
Материал из Mr.Doc
| Строка 1: | Строка 1: | ||
[[Category:API]] | [[Category:API]] | ||
Данная статья посвящена описанию доступных через API объектов и их атрибутов. | Данная статья посвящена описанию доступных через API объектов и их атрибутов. | ||
| − | Некоторые объекты системы имеют табличные части, в API они представлены как вложенные индексированные массивы с элементами табличных частей. | + | Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей. |
<div style="float:left; margin-right: 20px;"> | <div style="float:left; margin-right: 20px;"> | ||
'''Пример JSON''' | '''Пример JSON''' | ||
Версия 14:48, 6 марта 2014
Данная статья посвящена описанию доступных через API объектов и их атрибутов. Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
Пример JSON
{
"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"
}
]
}
Пример XML
<?xml version="1.0" encoding="utf-8"?>
<root>
<main_field_1>value_1</main_field_1>
<main_field_2>value_2</main_field_2>
<table_part_name list="true">
<item>
<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>
В примерах выше атрибут "table_part_name" - табличная часть, в которой два элемента. "table_part_field_1", "table_part_field_2" и "table_part_field_3" - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате "table_part_name.table_part_field_1".
Документы
Заказ покупателя (DocSaleOrder)
| Имя атрибута | Описание |
|---|---|
| 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 формате. |
