Описание объектов API
Материал из Mr.Doc
Версия от 11:00, 7 марта 2014; Super-admin (обсуждение | вклад)
Данная статья посвящена описанию доступных через API объектов и их атрибутов. Некоторые объекты системы имеют табличные части, в API они представлены, как вложенные индексированные массивы с элементами табличных частей.
Пример JSON
{ "main_field_1": "value_1", "main_field_2": "value_2", "table_part_name": [ { "field_1": "value_3", "field_2": "value_4", "field_3": "value_5" }, { "field_1": "value_6", "field_2": "value_7", "field_3": "value_8" } ] }
Пример XML
<?xml version="1.0" encoding="utf-8"?> <root> <main_field_1>value_1</main_field_1> <main_field_2>value_2</main_field_2> <table_part_name list="true"> <item> <field_1>value_3</field_1> <field_2>value_4</field_2> <field_3>value_5</field_3> </item> <item> <field_1>value_6</field_1> <field_2>value_7</field_2> <field_3>value_8</field_3> </item> </table_part_name> </root>
В примерах выше атрибут "table_part_name" - табличная часть, в которой два элемента. "field_1", "field_2" и "field_3" - реквизиты элементов табличной части. В данной статье реквизиты табличных частей будут именоваться в формате "table_part_name.field_1".
Документы
Оприходование товаров (DocAcceptance)
Имя атрибута | Описание |
---|---|
id | Идентификатор документа. |
date_time | Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой. |
number | Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически. |
status_id | Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик. |
organization_id | Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе. |
currency_id | Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль". |
price_type_id | Идентификатор типа цен из справочника RefPriceType. |
append_user_id | Идентификатор автора документа из справочника RefUser. |
append_date | Дата и время создания документа в SQL формате. |
change_user_id | Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ. |
change_date | Дата и время последнего изменения документа в SQL формате. |
responsible_user_id | Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя. |
sum | Сумма документа. |
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 | Сумма НДС указанного товара. При создании, в случае отсутствия в переданных данных будет рассчитана автоматически на основании количества, цены и ставки НДС. |
Заказ покупателя (DocSaleOrder)
Имя атрибута | Описание |
---|---|
id | Идентификатор документа. |
date_time | Дата документа в формате SQL. При создании, в случае отсутствия в переданных данных будет заполнена текущей датой. |
number | Учетный номер документа. При создании, в случае отсутствия в переданных данных будет сгенерирован автоматически. |
status_id | Статус документа. Возможные значения: ПомеченНаУдаление, Черновик, Проведен. Значение по умолчанию - Черновик. |
organization_id | Идентификатор собственной организации из справочника RefOrganization. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первой организации в системе. |
contractor_id | Идентификатор покупателя из справочника RefContractor. |
contract_id | Идентификатор договора с покупателем из справочника RefContract. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором первого договора с указанным покупателем в системе. При отсутствии такового, будет автоматически создан новый договор. |
currency_id | Идентификатор валюты из справочника RefCurrency. Значение по умолчанию - идентификатор валюты "Российский рубль". |
price_type_id | Идентификатор типа цен из справочника RefPriceType. |
is_price_include_vat | Булево значение - признак включение НДС в стоимость товаров и услуг. |
external_number | Номер заказа покупателя из внешней системы. |
append_user_id | Идентификатор автора документа из справочника RefUser. |
append_date | Дата и время создания документа в SQL формате. |
change_user_id | Идентификатор пользователя из справочника RefUser, который внес последние изменения в документ. |
change_date | Дата и время последнего изменения документа в SQL формате. |
responsible_user_id | Идентификатор пользователя из справочника RefUser, который является ответственным за документ. При создании, в случае отсутствия в переданных данных будет заполнен идентификатором текущего авторизованного пользователя. |
document_basis_id | Идентификатор документа основания. |
document_basis_type_id | Тип документа основания. Возможные значения: (Отсутствуют). |
sum | Сумма документа. |
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 формате. |