XML document format template
Element | Description | Type | Format | Required | Comment |
---|---|---|---|---|---|
file | Table 1.1 | ||||
name | File name | А | O | ||
format | Format ID | А | O | ||
format_version | Format version | А | O | ||
form | Form ID | A | O | ||
create | Create datetime | A | O | ||
author | File creator | A | O | ||
program | name of the program that created the file | А | O | ||
program_version | varsion of the program that created the file | А | O | ||
document | Document content | N | O | Состав элемента представлен в табл. 1.2 | |
document | Table 1.2 | ||||
id | document ID | A | O | ||
ext_id | identifier for the external system | A | O | ||
type | document type | A | R | ||
title | document title | A | R | ||
number | Document number | А | R | ||
date | Document date | А | YYYY-MM-DD | R | |
comment | document comment | А | O | ||
route | А | O | |||
status_code | А | O | |||
status_comment | status | А | O | ||
roles | participants | N | R | Details in table 3 | |
list_action | N | O | Details in table 4 | ||
list_attachment | N | O | Details in table 8 | ||
list_event | N | O | Details in table 7 | ||
list_item | N | O | Details in table 9 | ||
list_linkdoc | N | O | Details in table 5 | ||
list_param | N | O | Details in table 6 | ||
roles | Table 3 | ||||
consignee | N | O | Details in table 3.1 | ||
consignor | N | O | Details in table 3.1 | ||
department | department responsible for the document | N | O | Details in table 3.1 | |
org | your organization | N | R | Details in table 3.1 | |
partner | partner / customer / executor | N | R | Details in table 3.1 | |
user orgnization | user responsible for the document | N | O | Details in table 3.1 | |
participant | Table 3.1 | ||||
id | participants ID | A | O | ||
ext_id | identifier for the external system | A | O | ||
type | participants type | A | R | entity / bussinesman / employee / department | |
title | participants title | A | R | ||
entity | legal entity details | N (xor1) | O | Details in table 3.2 | |
businessman | businessman details | N (xor1) | O | Details in table 3.3 | |
employee | employee details | N (xor1) | O | Details in table 3.5 | |
department | department details | N (xor1) | O | Details in table 3.6 | |
entity | Table 3.2 | ||||
inn | primary taxpayer identifier | N | O | ||
kpp | secondary taxpayer identifier | N | O | ||
code | department code | N | O | ||
country | country code | N | O | ||
address_string | official address | N | O | ||
actual_address_string | N | O | |||
N | O | ||||
phone | N | O | |||
businesman | Table 3.3 | ||||
last_name | N | O | |||
first_name | N | O | |||
middle_name | N | O | |||
inn | primary taxpayer identifier | N | O | ||
code | department code | N | O | ||
country | country code | N | O | ||
address_string | official address | N | O | ||
actual_address_string | N | O | |||
N | O | ||||
phone | N | O | |||
employee | Table 3.4 | ||||
last_name | N | O | |||
first_name | N | O | |||
middle_name | N | O | |||
list_action | Table 4 | ||||
action | attachments of document | NM | O | Details in table 4.1 | |
action | Table 4.1 | ||||
name | action / event name | А | O | ||
comment | А | O | |||
stage_name | А | O | |||
attachments | N | O | Details in table 8 | ||
list_attachment | Table 8 | ||||
attachment | attachments of document | NM | O | Details in table 8.1 | |
attachment | Table 8.1 | ||||
id | file ID | A | O | ||
ext_id | identifier for the external system | A | O | ||
type | file type | A | R | attachment/service/signature/report | |
title | file title | A | R | ||
format | Format ID | А | O | ||
format_version | Format version | А | O | ||
download_link | link to download content | N | O | ||
download_pdf_link | link to download pdf preview | N | O | ||
web_view_link | link to go to the web interface | N | O | ||
file | attachment file | N | O | Details in table 8.4 | |
list_signature | electronic signatures of a document | N | O | Details in table 8.2 | |
list_signature | Table 8.2 | ||||
signature | NM | O | Details in table 8.3 | ||
signature | Table 8.3 | ||||
signer_name | signer name (last name + first name + middle name) | А | O | ||
signer_inn | signer name (last name + first name + middle name) | А | O | ||
org_name | organization name | А | O | ||
file | signature file | N | O | Details in table 8.4 | |
file | Table 8.4 | ||||
name | file name | А | O | ||
link | download link | А | O | ||
base64 | file data in base64 string | А | O | ||
list_event | Table 7 | ||||
event | attachments of document | NM | O | Details in table 7.1 | |
event | Table 7.1 | ||||
id | А | O | |||
name | event name | А | O | ||
comment | А | O | |||
stage_name | А | O | |||
datetime | А | yyyy-mm-dd HH:MM:SS | O | ||
attachments | signature file | N | O | Details in table 8 | |
list_item | Table 9 | ||||
item | items of document | NM | O | Details in table 9.1 | |
item | Table 9.1 | ||||
id | Item ID | A | O | ||
ext_id | identifier for the external system | A | O | ||
type | Item type | A | R | product / service | |
title | Item title | A | R | ||
gtin | А | O | |||
marking | А | O | tyres / shoes | ||
amount | А | O | |||
unit_code | А | O | |||
unit_name | А | O | |||
price | А | O | |||
sum | А | O | |||
tax_rate | А | O | |||
price_without_tax | А | O | |||
sum_without_tax | А | O | |||
list_param | N | O | Details in table 6 | ||
list_serial | N | O | Details in table 9.2 | ||
list_serial | Table 9.2 | ||||
serial | serial number or marking code | NM | S(255) | O | Details in table 9.3 |
serial | Table 9.3 | ||||
type | serial type. if not specified, considered as marking code. | А | 1/0 | O | |
check | code has been verified by scanning | А | 1/0 | O | |
list_linkdoc | Table 5 | ||||
linkdoc | links of document | NM | O | Details in table 5.1 | |
linkdoc | Table 5.1 | ||||
id | А | O | |||
type | А | O | |||
number | А | O | |||
date | А | O | |||
title | А | O | |||
list_param | Table 6 | ||||
param | NM | O | Details in table 9.1 | ||
param | Table 6.1 | ||||
name | А | S(255) | O | ||
value | А | S(255) | O |
Elem types:
- A - attribute
- N - node
- NM - list nodes
Elem required:
- O - optional
- R - required