Перейти к содержанию

Document#

Title: Document

Type object
Required No
Additional properties Not allowed

Description: Общие свойства документов

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - -
- number No string No - Номер документа
- date No string No - Дата документа
+ type No enum (of string) No - Тип документа
- direction No enum (of string) No - Тип документа

- `EXPORT`: экспортный
- `IMPORT`: импортный
+ customer No object No In customer.schema.json Customer
- agent No object No In agent.schema.json Agent
- canceledBy No object No In user.schema.json User
- notApprovalComment No string No - Комментарий при не согласовании документа
- userEmployee No object No Same as canceledBy User
- userCustomer No object No Same as canceledBy User
- createdAt No string No - Дата и время создания документа
- changedAt No string No - Дата и время последнего изменения документа
- notValidAfter No string No - Не действительно после
- files No array No - -

1. Property Document > id#

Type string
Required Yes
Format uuid

2. Property Document > number#

Type string
Required No

Description: Номер документа

3. Property Document > date#

Type string
Required No
Format date

Description: Дата документа

4. Property Document > type#

Type enum (of string)
Required Yes

Description: Тип документа

Must be one of: * "CONTRACT" * "ORDER" * "ADDITIONAL_AGREEMENT"

5. Property Document > direction#

Type enum (of string)
Required No

Description: Тип документа

  • EXPORT: экспортный
  • IMPORT: импортный

Must be one of: * "EXPORT" * "IMPORT"

6. Property Document > customer#

Title: Customer

Type object
Required Yes
Additional properties Not allowed
Defined in customer.schema.json

Description: Заказчик

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Уникальный идентификатор
- createdBy No string No - id пользователя, создавшего клиента
+ type No enum (of string) No - Тип заказчика

- `COMPANY`: юр.лицо
- `PERSON`: физ.лицо
- `IP`: индивидуальный предприниматель
+ status No enum (of string) No In common/_common.schema.json#/status Статус клиента
- statusPrevious No enum (of string) No Same as status Предыдущий статус клиента
- email No string No In common/_common.schema.json#/email E-mail клиента
+ partner No string No - Партнер
- signingType No enum (of string) No - Способ подписания документов

- `HANDWRITTEN`: подписание вручную
- `SIMPLE_ELECTRONIC`: ПЭП
- canRequestSubsidiary No boolean No - Может запрашивать согласование плательщика
- prioritySubsidiaries No array No - -

6.1. Property Document > customer > id#

Type string
Required Yes
Format uuid

Description: Уникальный идентификатор

6.2. Property Document > customer > createdBy#

Type string
Required No

Description: id пользователя, создавшего клиента

6.3. Property Document > customer > type#

Type enum (of string)
Required Yes

Description: Тип заказчика

  • COMPANY: юр.лицо
  • PERSON: физ.лицо
  • IP: индивидуальный предприниматель

Must be one of: * "COMPANY" * "PERSON" * "IP"

6.4. Property Document > customer > status#

Type enum (of string)
Required Yes
Defined in common/_common.schema.json#/status

Description: Статус клиента

Must be one of: * "ACTIVE" * "INACTIVE" * "INVITED"

6.5. Property Document > customer > statusPrevious#

Type enum (of string)
Required No
Same definition as status

Description: Предыдущий статус клиента

6.6. Property Document > customer > email#

Type string
Required No
Defined in common/_common.schema.json#/email

Description: E-mail клиента

Restrictions
Must match regular expression (?=^[\w\W]{0,255}$)^\s*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])\s*$ Test

6.7. Property Document > customer > partner#

Type string
Required Yes

Description: Партнер

6.8. Property Document > customer > signingType#

Type enum (of string)
Required No

Description: Способ подписания документов

  • HANDWRITTEN: подписание вручную
  • SIMPLE_ELECTRONIC: ПЭП

Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"

6.9. Property Document > customer > canRequestSubsidiary#

Type boolean
Required No

Description: Может запрашивать согласование плательщика

6.10. Property Document > customer > prioritySubsidiaries#

Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation N/A

7. Property Document > agent#

Title: Agent

Type object
Required No
Additional properties Not allowed
Defined in agent.schema.json

Description: Агент

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Уникальный идентификатор
- customer No object No - -
- fullName No string No - Название
- fullNameEnglish No string No - Название на английском языке
- inn No string No - ИНН
- kpp No string No - КПП
- ogrn No string No - ОГРН
- bankAccount No array of object No Same as bankAccounts Реквизиты банковского счета
- addressRegistration No object No Same as addressRegistrationEnglish Адрес регистрации
- addressRegistrationEnglish No object No Same as addressRegistrationEnglish Адрес регистрации на английском языке
- taxResidence No string No In common/_common.schema.json#/country Страна налогового резидентства
- representative No object No Same as representative Подписант
- stampPath No string No - Путь к файлу с изображением штампа
- additionalProperties No object No - -
- required No object No - -
+ status No enum (of string) No - Статус

- `ACTIVE`: действующий агент
- `INACTIVE`: заблокированный агент

7.1. Property Document > agent > id#

Type string
Required No
Format uuid

Description: Уникальный идентификатор

7.2. Property Document > agent > customer#

Type object
Required No
Additional properties Any type allowed

7.3. Property Document > agent > fullName#

Type string
Required No

Description: Название

7.4. Property Document > agent > fullNameEnglish#

Type string
Required No

Description: Название на английском языке

7.5. Property Document > agent > inn#

Type string
Required No

Description: ИНН

7.6. Property Document > agent > kpp#

Type string
Required No

Description: КПП

Restrictions
Min length 9
Max length 9
Must match regular expression ^[0-9]{9}$ Test

7.7. Property Document > agent > ogrn#

Type string
Required No

Description: ОГРН

7.8. Property Document > agent > bankAccount#

Type array of object
Required No
Same definition as bankAccounts

Description: Реквизиты банковского счета

7.9. Property Document > agent > addressRegistration#

Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

Description: Адрес регистрации

7.10. Property Document > agent > addressRegistrationEnglish#

Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

Description: Адрес регистрации на английском языке

7.11. Property Document > agent > taxResidence#

Type string
Required No
Defined in common/_common.schema.json#/country

Description: Страна налогового резидентства

Restrictions
Min length 3
Max length 3
Must match regular expression ^[A-Z]{3}$ Test

7.12. Property Document > agent > representative#

Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

7.13. Property Document > agent > stampPath#

Type string
Required No

Description: Путь к файлу с изображением штампа

7.14. Property Document > agent > additionalProperties#

Type object
Required No
Additional properties Any type allowed

7.15. Property Document > agent > required#

Type object
Required No
Additional properties Any type allowed

7.16. Property Document > agent > status#

Type enum (of string)
Required Yes

Description: Статус

  • ACTIVE: действующий агент
  • INACTIVE: заблокированный агент

Must be one of: * "ACTIVE" * "INACTIVE"

8. Property Document > canceledBy#

Title: User

Type object
Required No
Additional properties Any type allowed
Defined in user.schema.json

Description: Пользователь отменивший документ

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Уникальный идентификатор
+ type No enum (of string) No - Тип пользователя

- `CUSTOMER`: клиент
- `EMPLOYEE`: исполнитель
- `AGENT`: агент
- customer No object No Same as customer Customer
- employee No object No In employee.schema.json Employee
- agent No object No Same as agent Agent
+ email No string No Same as email E-mail пользователя
+ phone No string No - Номер мобильного телефона
+ role No enum (of string) No - Роль пользователя
+ status No enum (of string) No Same as status Статус пользователя
- statusPrevious No enum (of string) No Same as status Предыдущий статус пользователя
- statusReason No enum (of string) No - Причина установки текущего статуса

- `PASSWORD_MISTAKE`: ошибка ввода пароля
- `MANUAL_BLOCKED`: ручная блокировка
- passwordMistakeCounter No number No - Количество попыток ошибочного ввода пароля при входе в систему

8.1. Property Document > canceledBy > id#

Type string
Required Yes
Format uuid

Description: Уникальный идентификатор

8.2. Property Document > canceledBy > type#

Type enum (of string)
Required Yes

Description: Тип пользователя

  • CUSTOMER: клиент
  • EMPLOYEE: исполнитель
  • AGENT: агент

Must be one of: * "CUSTOMER" * "EMPLOYEE" * "AGENT"

8.3. Property Document > canceledBy > customer#

Title: Customer

Type object
Required No
Additional properties Not allowed
Same definition as customer

Description: Клиент

8.4. Property Document > canceledBy > employee#

Title: Employee

Type object
Required No
Additional properties Not allowed
Defined in employee.schema.json

Description: Сотрудник

Property Pattern Type Deprecated Definition Title/Description
+ fio No object No Same as fio ФИО

8.4.1. Property Document > canceledBy > employee > fio#

Type object
Required Yes
Additional properties Not allowed
Same definition as fio

Description: ФИО

8.5. Property Document > canceledBy > agent#

Title: Agent

Type object
Required No
Additional properties Not allowed
Same definition as agent

Description: Agent

8.6. Property Document > canceledBy > email#

Type string
Required Yes
Same definition as email

Description: E-mail пользователя

8.7. Property Document > canceledBy > phone#

Type string
Required Yes

Description: Номер мобильного телефона

Restrictions
Must match regular expression ^(79)\d{9}$ Test

8.8. Property Document > canceledBy > role#

Type enum (of string)
Required Yes

Description: Роль пользователя

Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"

8.9. Property Document > canceledBy > status#

Type enum (of string)
Required Yes
Same definition as status

Description: Статус пользователя

8.10. Property Document > canceledBy > statusPrevious#

Type enum (of string)
Required No
Same definition as status

Description: Предыдущий статус пользователя

8.11. Property Document > canceledBy > statusReason#

Type enum (of string)
Required No

Description: Причина установки текущего статуса

  • PASSWORD_MISTAKE: ошибка ввода пароля
  • MANUAL_BLOCKED: ручная блокировка

Must be one of: * "PASSWORD_MISTAKE" * "MANUAL_BLOCKED"

8.12. Property Document > canceledBy > passwordMistakeCounter#

Type number
Required No

Description: Количество попыток ошибочного ввода пароля при входе в систему

9. Property Document > notApprovalComment#

Type string
Required No

Description: Комментарий при не согласовании документа

10. Property Document > userEmployee#

Title: User

Type object
Required No
Additional properties Any type allowed
Same definition as canceledBy

Description: Пользователь исполнителя

11. Property Document > userCustomer#

Title: User

Type object
Required No
Additional properties Any type allowed
Same definition as canceledBy

Description: Последний пользователь клиента изменивший документ

12. Property Document > createdAt#

Type string
Required No
Format datetime

Description: Дата и время создания документа

13. Property Document > changedAt#

Type string
Required No
Format datetime

Description: Дата и время последнего изменения документа

14. Property Document > notValidAfter#

Type string
Required No
Format date

Description: Не действительно после

15. Property Document > files#

Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
File Метаданные файла документа в системе

15.1. Document > files > File#

Title: File

Type object
Required No
Additional properties Not allowed
Defined in file.schema.json

Description: Метаданные файла документа в системе

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Идентификатор файла
- template No object No In template.schema.json File
+ type No enum (of string) No - Вид документа.

- `CONTRACT` Контракт / инвойс
- `INVOICE`: Инвойс
- `ORDER`: Заявка
- `REPORT` - `Отчёт`
- `AGREEMENT` - Договор
- `OTHER` - Прочие документы
- `CONFIRMATION` - Подтверждающие документы
- `INSTRUCTION` - Поручение
- `ADDITIONAL_AGREEMENT` - Доп.соглашение
+ name No string No - Отображаемое название файла
+ path No string No - Путь к файлу в хранилище объектов
- context No string No - Данные, которые использовались для генерации файла
+ status No enum (of string) No - Статус
+ document No object No Same as Document Document
+ isGenerated No boolean No - Признак генерации файла системой
- signature No array of object No - Платежные поручения

15.1.1. Property Document > files > File > id#

Type string
Required No
Format uuid

Description: Идентификатор файла

15.1.2. Property Document > files > File > template#

Title: File

Type object
Required No
Additional properties Not allowed
Defined in template.schema.json

Description: Шаблон по которому сгенерирован файл

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Идентификатор шаблона
+ name No string No - Название
+ type No enum (of string) No - Вид документа
+ path No string No - Путь к файлу шаблона в хранилище объектов
15.1.2.1. Property Document > files > File > template > id#
Type string
Required Yes
Format uuid

Description: Идентификатор шаблона

15.1.2.2. Property Document > files > File > template > name#
Type string
Required Yes
Format uuid

Description: Название

15.1.2.3. Property Document > files > File > template > type#
Type enum (of string)
Required Yes

Description: Вид документа

Must be one of: * "AGREEMENT_IMPORT" * "AGREEMENT_EXPORT" * "INVOICE_IMPORT" * "INVOICE_COMMODITY_EXPORT" * "INVOICE_SERVICES_EXPORT" * "INSTRUCTION_EXPORT" * "REPORT_IMPORT" * "REPORT_EXPORT"

15.1.2.4. Property Document > files > File > template > path#
Type string
Required Yes

Description: Путь к файлу шаблона в хранилище объектов

15.1.3. Property Document > files > File > type#

Type enum (of string)
Required Yes

Description: Вид документа.

  • CONTRACT Контракт / инвойс
  • INVOICE: Инвойс
  • ORDER: Заявка
  • REPORT - Отчёт
  • AGREEMENT - Договор
  • OTHER - Прочие документы
  • CONFIRMATION - Подтверждающие документы
  • INSTRUCTION - Поручение
  • ADDITIONAL_AGREEMENT - Доп.соглашение

Must be one of: * "CONTRACT" * "INVOICE" * "AGREEMENT" * "ORDER" * "REPORT" * "OTHER" * "CONFIRMATION" * "INSTRUCTION" * "ADDITIONAL_AGREEMENT"

15.1.4. Property Document > files > File > name#

Type string
Required Yes

Description: Отображаемое название файла

15.1.5. Property Document > files > File > path#

Type string
Required Yes

Description: Путь к файлу в хранилище объектов

15.1.6. Property Document > files > File > context#

Type string
Required No

Description: Данные, которые использовались для генерации файла

15.1.7. Property Document > files > File > status#

Type enum (of string)
Required Yes

Description: Статус

Must be one of: * "ACTIVE" * "DELETED"

15.1.8. Property Document > files > File > document#

Title: Document

Type object
Required Yes
Additional properties Not allowed
Same definition as Document

Description: Ссылка на документ

15.1.9. Property Document > files > File > isGenerated#

Type boolean
Required Yes

Description: Признак генерации файла системой

15.1.10. Property Document > files > File > signature#

Type array of object
Required No

Description: Платежные поручения

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
signature items -
15.1.10.1. Document > files > File > signature > signature items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- operationId No string No - Номер операции
+ signingType No enum (of string) No - Способ подписания документов

- `HANDWRITTEN`: подписание вручную
- `SIMPLE_ELECTRONIC`: ПЭП
+ user No object No Same as canceledBy User
+ userRole No enum (of string) No - Роль пользователя
+ signedAt No string No - Дата и время подписания документы
- smsCode No string No - Код из СМС которым
- phone No string No - Номер телефона на который отправили СМС
- inn No string No - ИНН
- kpp No string No - КПП
- name No string No - Наименование
+ fio No object No Same as fio ФИО подписавшего
15.1.10.1.1. Property Document > files > File > signature > signature items > operationId#
Type string
Required No

Description: Номер операции

15.1.10.1.2. Property Document > files > File > signature > signature items > signingType#
Type enum (of string)
Required Yes

Description: Способ подписания документов

  • HANDWRITTEN: подписание вручную
  • SIMPLE_ELECTRONIC: ПЭП

Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"

15.1.10.1.3. Property Document > files > File > signature > signature items > user#

Title: User

Type object
Required Yes
Additional properties Any type allowed
Same definition as canceledBy

Description: Пользователь

15.1.10.1.4. Property Document > files > File > signature > signature items > userRole#
Type enum (of string)
Required Yes

Description: Роль пользователя

Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"

15.1.10.1.5. Property Document > files > File > signature > signature items > signedAt#
Type string
Required Yes
Format date-time

Description: Дата и время подписания документы

15.1.10.1.6. Property Document > files > File > signature > signature items > smsCode#
Type string
Required No

Description: Код из СМС которым

15.1.10.1.7. Property Document > files > File > signature > signature items > phone#
Type string
Required No

Description: Номер телефона на который отправили СМС

15.1.10.1.8. Property Document > files > File > signature > signature items > inn#
Type string
Required No

Description: ИНН

15.1.10.1.9. Property Document > files > File > signature > signature items > kpp#
Type string
Required No

Description: КПП

15.1.10.1.10. Property Document > files > File > signature > signature items > name#
Type string
Required No

Description: Наименование

15.1.10.1.11. Property Document > files > File > signature > signature items > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

Description: ФИО подписавшего


Generated using json-schema-for-humans on 2025-02-11 at 14:28:18 +0000