Описание форматов документов в EdiAgent
Список документов и их краткое описание представлено ниже (Табл. 1).
| # | Тип документа | Имя, ссылка | Краткое описание | |
|---|---|---|---|---|
| 1 | Заказ | doc_order | Документ «Заказ» имеет заголовок, табличную часть товары и реквизитов | |
| 2 | ПКО | doc_get_money | ПКО, сбор денег. Имеет заголовок и общую сумму | |
| 5 | Мерчендайзинг | doc_merch | «Мерчендайзинг» имеет заголовок, табличную часть товаров и реквизитов. Так же имеет дополнительные реквизиты для товаров | |
| 7 | Возврат | doc_return | Документ «Возврат» имеет структуру аналогичную документу «Заказ» |
Табл. 1. Список документов
Детальное описание документов
Документ «Заказ»
Заголовок документа:
<header>
table name="doc_order"
</header>
Описание атрибутов представлено ниже (Табл. 2).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | uid | Строка(16) | Уникальный номер документа |
| 2 | doc_type_id | Число | Номер типа документа |
| 3 | organization_id | Строка(50) | Уникальный код организации, от лица которой введен документ |
| 4 | organization_name | Строка(255) | Нименование организации |
| 5 | trade_point_id | Строка(50) | Уникальный код торговой точки, на которую сделан заказ |
| 6 | trade_point_name | Строка(255) | Нименование торговой точки |
| 7 | trade_point_actual_address | Строка(255) | Адрес торговой точки |
| 8 | creator | Строка(50) | Уникальный код агента, от которого пришел документ |
| 9 | agent_name | Строка(255) | Имя агента |
| 10 | store_id | Строка(50) | Уникальный код склада |
| 11 | type_of_price_id | Строка(50) | Тип цены документа |
| 12 | discount_id | Строка(50) | Уникальный код скидки, которая применяется к документу |
| 13 | doc_sum | Число | Итоговая сумма по документу |
| 14 | local_status_id | Число | Статус документа. 1-черновик, 2-проведен, 3-подтвержден, 4-отклонен |
| 15 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания документа на устройстве агента |
| 16 | document_date | Дата, формат "2015-12-31T23:59:59" | Дата проведения документа на устройстве агента |
| 17 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 2. Атрибуты документа «Заказ»
Табличная часть «Товары»
<t_parts>
table name="doc_order_products" count="n" (n - количество строк табличной части)
<t_parts>
Описание атрибутов представлено ниже (Табл. 3).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | product_id | Строка(50) | Уникальный код товара |
| 2 | good_name | Строка(255) | Полное наименование товара |
| 3 | m_unit_id | Строка(50) | Уникальный код единицы измерения (ОКЕИ) |
| 4 | m_unit_by_good_id | Строка(255) | Уникальный код единицы измерения товара |
| 5 | quantity | Число | Количество единиц товара |
| 6 | price | Число | Цена за единицу товара |
| 7 | sum | Число | Сумма ( цена * кол-во ) |
| 8 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 3. Атрибуты табличной части «Товары»
Табличная часть «Реквизиты»
<t_parts>
table name="doc_order_requisites" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 4).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | requisite_id | Строка(50) | Уникальный код реквизита |
| 2 | requisite_name | Строка(255) | Полное наименование реквизита |
| 3 | req_value | Строка(255) или Число | Значение реквизита, могут применятся собственные реквизиты |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 4. Атрибуты табличной части «Реквизиты»
Табличная часть «Реквизиты товаров»
<t_parts>
table_name="doc_order_goods_req" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 5).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | requisite_id | Строка(50) | Уникальный код реквизита |
| 2 | goods_requisite_name | Строка(255) | Полное наименование реквизита |
| 3 | good_id | Строка(255) | Полное наименование реквизита |
| 4 | req_value | Строка(255) или Число | Значение реквизита, могут применятся собственные реквизиты |
| 5 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 5. Атрибуты табличной части «Реквизиты товаров»
Табличная часть «История документа»
<t_parts>
table_name="doc_history" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 6).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | operation | Строка | Может быть : RECEIVED, HOLD, ACCEPTED или DECLINED |
| 2 | operation_date | Дата, формат "2015-12-31T23:59:59" | Дата операции |
| 3 | comment | Строка(255) | Комментарий к операции |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 6. Атрибуты табличной части «История документа»
Табличная часть «Прикрепленные изображения»
<t_parts>
table name="photos" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 7).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | id | Строка(50) | Уникальный код фотографии |
| 2 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания фотографии |
| 3 | photo_file_path | Строка(50) | Имя файла на сервере |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 7. Атрибуты табличной части «Прикрипленные изображения»
Документ ПКО
Заголовок документа:
<header>
table_name="doc_get_money"
</header>
Описание атрибутов представлено ниже (Табл. 8).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | uid | Строка(16) | Уникальный номер документа |
| 2 | doc_type_id | Число | Номер типа документа |
| 3 | organization_id | Строка(50) | Уникальный код организации, от лица которой введен документ |
| 4 | organization_name | Строка(255) | Нименование организации |
| 5 | trade_point_id | Строка(50) | Уникальный код торговой точки, на которую сделан заказ |
| 6 | trade_point_name | Строка(255) | Нименование торговой точки |
| 7 | trade_point_actual_address | Строка(255) | Адрес торговой точки |
| 8 | creator | Строка(50) | Уникальный код агента, от которого пришел документ |
| 9 | agent_name | Строка(255) | Имя агента |
| 10 | doc_sum | Число | Итоговая сумма по документу |
| 11 | local_status_id | Число | Статус документа. 1-черновик, 2-проведен, 3-подтвержден, 4-отклонен |
| 12 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания документа на устройстве агента |
| 13 | document_date | Дата, формат "2015-12-31T23:59:59" | Дата проведения документа на устройстве агента |
| 14 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 8. Атрибуты документа ПКО
Табличная часть «История документа»
<t_parts>
table_name="doc_history" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 9).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | operation | Строка | Может быть : RECEIVED, HOLD, ACCEPTED или DECLINED |
| 2 | operation_date | Дата, формат "2015-12-31T23:59:59" | Дата операции |
| 3 | comment | Строка(255) | Комментарий к операции |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 9. Атрибуты табличной части «История документа»
Документ «Мерчендайзинг»
Заголовок документа:
<header>
table_name="doc_merch"
</header>
Описание атрибутов представлено ниже (Табл. 10).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | uid | Строка(16) | Уникальный номер документа |
| 2 | doc_type_id | Число | Номер типа документа |
| 3 | organization_id | Строка(50) | Уникальный код организации, от лица которой введен документ |
| 4 | organization_name | Строка(255) | Нименование организации |
| 5 | trade_point_id | Строка(50) | Уникальный код торговой точки, на которую сделан заказ |
| 6 | trade_point_name | Строка(255) | Нименование торговой точки |
| 7 | trade_point_actual_address | Строка(255) | Адрес торговой точки |
| 8 | creator | Строка(50) | Уникальный код агента, от которого пришел документ |
| 9 | agent_name | Строка(255) | Имя агента |
| 10 | doc_sum | Число | Итоговая сумма по документу |
| 11 | local_status_id | Число | Статус документа. 1-черновик, 2-проведен, 3-подтвержден, 4-отклонен |
| 12 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания документа на устройстве агента |
| 13 | document_date | Дата, формат "2015-12-31T23:59:59" | Дата проведения документа на устройстве агента |
| 14 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 10. Атрибуты документа «Мерчендайзинг»
Табличная часть «Товары»
<t_parts>
table name="doc_order_products" count="n" (n - количество строк табличной части)
<t_parts>
Описание атрибутов представлено ниже (Табл. 11).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | product_id | Строка(50) | Уникальный код товара |
| 2 | good_name | Строка(255) | Полное наименование товара |
| 3 | m_unit_id | Строка(50) | Уникальный код единицы измерения (ОКЕИ) |
| 4 | m_unit_by_good_id | Строка(255) | Уникальный код единицы измерения товара |
| 5 | quantity | Число | Количество единиц товара |
| 6 | price | Число | Цена за единицу товара |
| 7 | sum | Число | Сумма ( цена * кол-во ) |
| 8 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 11. Атрибуты табличной части «Товары»
Табличная часть «Реквизиты»
<t_parts>
table name="doc_merch_requisites" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 12).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | requisite_id | Строка(50) | Уникальный код реквизита |
| 2 | requisite_name | Строка(255) | Полное наименование реквизита |
| 3 | req_value | Строка(255) или Число | Значение реквизита, могут применятся собственные реквизиты |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 12. Атрибуты табличной части «Реквезиты»
Табличная часть «История документа»
<doc_history>
table name="doc_history" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 13).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | operation | Строка | Может быть : RECEIVED, HOLD, ACCEPTED или DECLINED |
| 2 | operation_date | Дата, формат "2015-12-31T23:59:59" | Дата операции |
| 3 | comment | Строка(255) | Комментарий к операции |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 13. Атрибуты табличной части «История документа»
Документ «Возврат»
Заголовок документа:
<header>
table_name="doc_return"
</header>
Описание атрибутов представлено ниже (Табл. 14).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | uid | Строка(16) | Уникальный номер документа |
| 2 | doc_type_id | Число | Номер типа документа |
| 3 | organization_id | Строка(50) | Уникальный код организации, от лица которой введен документ |
| 4 | organization_name | Строка(255) | Нименование организации |
| 5 | trade_point_id | Строка(50) | Уникальный код торговой точки, на которую сделан заказ |
| 6 | trade_point_name | Строка(255) | Нименование торговой точки |
| 7 | trade_point_actual_address | Строка(255) | Адрес торговой точки |
| 8 | creator | Строка(50) | Уникальный код агента, от которого пришел документ |
| 9 | agent_name | Строка(255) | Имя агента |
| 10 | store_id | Строка(50) | Уникальный код склада |
| 11 | type_of_price_id | Строка(50) | Тип цены документа |
| 12 | discount_id | Строка(50) | Уникальный код скидки, которая применяется к документу |
| 13 | doc_sum | Число | Итоговая сумма по документу |
| 14 | local_status_id | Число | Статус документа. 1-черновик, 2-проведен, 3-подтвержден, 4-отклонен |
| 15 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания документа на устройстве агента |
| 16 | document_date | Дата, формат "2015-12-31T23:59:59" | Дата проведения документа на устройстве агента |
| 17 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 14. Атрибуты документа «Возврат»
Табличная часть «Товары»
<t_parts>
table name="doc_return_products" count="n" (n - количество строк табличной части)
<t_parts>
Описание атрибутов представлено ниже (Табл. 15).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | product_id | Строка(50) | Уникальный код товара |
| 2 | good_name | Строка(255) | Полное наименование товара |
| 3 | m_unit_id | Строка(50) | Уникальный код единицы измерения |
| 4 | quantity | Число | Количество единиц товара |
| 5 | price | Число | Цена за единицу товара |
| 6 | sum | Число | Сумма ( цена * кол-во ) |
| 7 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 15. Атрибуты табличной части «Товары»
Табличная часть «Реквизиты»
<t_parts>
table_name="doc_return_requisites" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 16).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | requisite_id | Строка(50) | Уникальный код реквизита |
| 2 | requisite_name | Строка(255) | Полное наименование реквизита |
| 3 | req_value | Строка(255) или Число | Значение реквизита, могут применятся собственные реквизиты |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 16. Атрибуты табличной части «Реквизиты»
Табличная часть «Реквизиты товаров»
<t_parts>
table_name="doc_return_goods_req" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 17).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | requisite_id | Строка(50) | Уникальный код реквизита |
| 2 | requisite_name | Строка(255) | Полное наименование реквизита |
| 3 | good_id | Строка(255) | Полное наименование реквизита |
| 4 | req_value | Строка(255) или Число | Значение реквизита, могут применятся собственные реквизиты |
| 5 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 17. Атрибуты табличной части «Реквизиты товаров»
Табличная часть «История документа»
<t_parts>
table_name="doc_history" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 18).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | operation | Строка | Может быть : RECEIVED, HOLD, ACCEPTED или DECLINED |
| 2 | operation_date | Дата, формат "2015-12-31T23:59:59" | Дата операции |
| 3 | comment | Строка(255) | Комментарий к операции |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 18. Атрибуты табличной части «История документа»
Табличная часть «Прикрепленные изображения»
<t_parts>
table_name="photos" count="n" (n - количество строк табличной части)
</t_parts>
Описание атрибутов представлено ниже (Табл. 19).
| # | Атрибут | Тип | Краткое описание |
|---|---|---|---|
| 1 | id | Строка(50) | Уникальный код фотографии |
| 2 | date_create | Дата, формат "2015-12-31T23:59:59" | Дата создания фотографии |
| 3 | photo_file_path | Строка(50) | Имя файла на сервере |
| 4 | is_deleted | Число, 0 или 1 | Пометка удаления |
Табл. 19. Атрибуты табличной части «Прикрипленные изображения»