Contract#
- 1. Property
Contract > contract > id - 2. Property
Contract > contract > number - 3. Property
Contract > contract > date - 4. Property
Contract > contract > type - 5. Property
Contract > contract > direction - 6. Property
Contract > contract > customer - 6.1. Property
Contract > contract > customer > id - 6.2. Property
Contract > contract > customer > createdBy - 6.3. Property
Contract > contract > customer > type - 6.4. Property
Contract > contract > customer > status - 6.5. Property
Contract > contract > customer > statusPrevious - 6.6. Property
Contract > contract > customer > email - 6.7. Property
Contract > contract > customer > partner - 6.8. Property
Contract > contract > customer > signingType - 6.9. Property
Contract > contract > customer > canRequestSubsidiary - 6.10. Property
Contract > contract > customer > prioritySubsidiaries - 7. Property
Contract > contract > agent - 7.1. Property
Contract > contract > agent > id - 7.2. Property
Contract > contract > agent > customer - 7.3. Property
Contract > contract > agent > fullName - 7.4. Property
Contract > contract > agent > fullNameEnglish - 7.5. Property
Contract > contract > agent > inn - 7.6. Property
Contract > contract > agent > kpp - 7.7. Property
Contract > contract > agent > ogrn - 7.8. Property
Contract > contract > agent > bankAccount - 7.9. Property
Contract > contract > agent > addressRegistration - 7.10. Property
Contract > contract > agent > addressRegistrationEnglish - 7.11. Property
Contract > contract > agent > taxResidence - 7.12. Property
Contract > contract > agent > representative - 7.13. Property
Contract > contract > agent > stampPath - 7.14. Property
Contract > contract > agent > additionalProperties - 7.15. Property
Contract > contract > agent > required - 7.16. Property
Contract > contract > agent > status - 8. Property
Contract > contract > canceledBy - 8.1. Property
Contract > contract > canceledBy > id - 8.2. Property
Contract > contract > canceledBy > type - 8.3. Property
Contract > contract > canceledBy > customer - 8.4. Property
Contract > contract > canceledBy > employee - 8.5. Property
Contract > contract > canceledBy > agent - 8.6. Property
Contract > contract > canceledBy > email - 8.7. Property
Contract > contract > canceledBy > phone - 8.8. Property
Contract > contract > canceledBy > role - 8.9. Property
Contract > contract > canceledBy > status - 8.10. Property
Contract > contract > canceledBy > statusPrevious - 8.11. Property
Contract > contract > canceledBy > statusReason - 8.12. Property
Contract > contract > canceledBy > passwordMistakeCounter - 9. Property
Contract > contract > notApprovalComment - 10. Property
Contract > contract > userEmployee - 11. Property
Contract > contract > userCustomer - 12. Property
Contract > contract > createdAt - 13. Property
Contract > contract > changedAt - 14. Property
Contract > contract > notValidAfter - 15. Property
Contract > contract > files - 15.1. Contract > contract > files > File
- 15.1.1. Property
Contract > contract > files > File > id - 15.1.2. Property
Contract > contract > files > File > template - 15.1.2.1. Property
Contract > contract > files > File > template > id - 15.1.2.2. Property
Contract > contract > files > File > template > name - 15.1.2.3. Property
Contract > contract > files > File > template > type - 15.1.2.4. Property
Contract > contract > files > File > template > path - 15.1.3. Property
Contract > contract > files > File > type - 15.1.4. Property
Contract > contract > files > File > name - 15.1.5. Property
Contract > contract > files > File > path - 15.1.6. Property
Contract > contract > files > File > context - 15.1.7. Property
Contract > contract > files > File > status - 15.1.8. Property
Contract > contract > files > File > document - 15.1.9. Property
Contract > contract > files > File > isGenerated - 15.1.10. Property
Contract > contract > files > File > signature - 15.1.10.1. Contract > contract > files > File > signature > signature items
- 15.1.10.1.1. Property
Contract > contract > files > File > signature > signature items > operationId - 15.1.10.1.2. Property
Contract > contract > files > File > signature > signature items > signingType - 15.1.10.1.3. Property
Contract > contract > files > File > signature > signature items > user - 15.1.10.1.4. Property
Contract > contract > files > File > signature > signature items > userRole - 15.1.10.1.5. Property
Contract > contract > files > File > signature > signature items > signedAt - 15.1.10.1.6. Property
Contract > contract > files > File > signature > signature items > smsCode - 15.1.10.1.7. Property
Contract > contract > files > File > signature > signature items > phone - 15.1.10.1.8. Property
Contract > contract > files > File > signature > signature items > inn - 15.1.10.1.9. Property
Contract > contract > files > File > signature > signature items > kpp - 15.1.10.1.10. Property
Contract > contract > files > File > signature > signature items > name - 15.1.10.1.11. Property
Contract > contract > files > File > signature > signature items > fio
- 15.1.10.1.1. Property
- 15.1.1. Property
- 16. Property
Contract > contract - 16.1. Property
Contract > contract > id - 16.2. Property
Contract > contract > number - 16.3. Property
Contract > contract > date - 16.4. Property
Contract > contract > type - 16.5. Property
Contract > contract > direction - 16.6. Property
Contract > contract > customer- 16.6.1. Property
Contract > contract > customer > id - 16.6.2. Property
Contract > contract > customer > createdBy - 16.6.3. Property
Contract > contract > customer > type - 16.6.4. Property
Contract > contract > customer > status - 16.6.5. Property
Contract > contract > customer > statusPrevious - 16.6.6. Property
Contract > contract > customer > email - 16.6.7. Property
Contract > contract > customer > partner - 16.6.8. Property
Contract > contract > customer > signingType - 16.6.9. Property
Contract > contract > customer > canRequestSubsidiary - 16.6.10. Property
Contract > contract > customer > prioritySubsidiaries
- 16.6.1. Property
- 16.7. Property
Contract > contract > agent- 16.7.1. Property
Contract > contract > agent > id - 16.7.2. Property
Contract > contract > agent > customer - 16.7.3. Property
Contract > contract > agent > fullName - 16.7.4. Property
Contract > contract > agent > fullNameEnglish - 16.7.5. Property
Contract > contract > agent > inn - 16.7.6. Property
Contract > contract > agent > kpp - 16.7.7. Property
Contract > contract > agent > ogrn - 16.7.8. Property
Contract > contract > agent > bankAccount - 16.7.9. Property
Contract > contract > agent > addressRegistration - 16.7.10. Property
Contract > contract > agent > addressRegistrationEnglish - 16.7.11. Property
Contract > contract > agent > taxResidence - 16.7.12. Property
Contract > contract > agent > representative - 16.7.13. Property
Contract > contract > agent > stampPath - 16.7.14. Property
Contract > contract > agent > additionalProperties - 16.7.15. Property
Contract > contract > agent > required - 16.7.16. Property
Contract > contract > agent > status
- 16.7.1. Property
- 16.8. Property
Contract > contract > canceledBy- 16.8.1. Property
Contract > contract > canceledBy > id - 16.8.2. Property
Contract > contract > canceledBy > type - 16.8.3. Property
Contract > contract > canceledBy > customer - 16.8.4. Property
Contract > contract > canceledBy > employee - 16.8.4.1. Property
Contract > contract > canceledBy > employee > fio - 16.8.5. Property
Contract > contract > canceledBy > agent - 16.8.6. Property
Contract > contract > canceledBy > email - 16.8.7. Property
Contract > contract > canceledBy > phone - 16.8.8. Property
Contract > contract > canceledBy > role - 16.8.9. Property
Contract > contract > canceledBy > status - 16.8.10. Property
Contract > contract > canceledBy > statusPrevious - 16.8.11. Property
Contract > contract > canceledBy > statusReason - 16.8.12. Property
Contract > contract > canceledBy > passwordMistakeCounter
- 16.8.1. Property
- 16.9. Property
Contract > contract > notApprovalComment - 16.10. Property
Contract > contract > userEmployee - 16.11. Property
Contract > contract > userCustomer - 16.12. Property
Contract > contract > createdAt - 16.13. Property
Contract > contract > changedAt - 16.14. Property
Contract > contract > notValidAfter - 16.15. Property
Contract > contract > files- 16.15.1. Contract > contract > files > File
- 16.15.1.1. Property
Contract > contract > files > File > id - 16.15.1.2. Property
Contract > contract > files > File > template - 16.15.1.3. Property
Contract > contract > files > File > type - 16.15.1.4. Property
Contract > contract > files > File > name - 16.15.1.5. Property
Contract > contract > files > File > path - 16.15.1.6. Property
Contract > contract > files > File > context - 16.15.1.7. Property
Contract > contract > files > File > status - 16.15.1.8. Property
Contract > contract > files > File > document - 16.15.1.9. Property
Contract > contract > files > File > isGenerated - 16.15.1.10. Property
Contract > contract > files > File > signature- 16.15.1.10.1. Contract > contract > files > File > signature > signature items
- 16.15.1.10.1.1. Property
Contract > contract > files > File > signature > signature items > operationId - 16.15.1.10.1.2. Property
Contract > contract > files > File > signature > signature items > signingType - 16.15.1.10.1.3. Property
Contract > contract > files > File > signature > signature items > user - 16.15.1.10.1.4. Property
Contract > contract > files > File > signature > signature items > userRole - 16.15.1.10.1.5. Property
Contract > contract > files > File > signature > signature items > signedAt - 16.15.1.10.1.6. Property
Contract > contract > files > File > signature > signature items > smsCode - 16.15.1.10.1.7. Property
Contract > contract > files > File > signature > signature items > phone - 16.15.1.10.1.8. Property
Contract > contract > files > File > signature > signature items > inn - 16.15.1.10.1.9. Property
Contract > contract > files > File > signature > signature items > kpp - 16.15.1.10.1.10. Property
Contract > contract > files > File > signature > signature items > name - 16.15.1.10.1.11. Property
Contract > contract > files > File > signature > signature items > fio
- 16.16. Property
Contract > contract > form - 16.17. Property
Contract > contract > status - 17. Property
Contract > form - 18. Property
Contract > status
Title: Contract
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in |
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 | - | - |
| - contract | No | object | No | In document-contract.schema.json | Contract |
| - form | No | enum (of string) | No | - | Форма дополнительного соглашения |
| - status | No | enum (of string) | No | - | Статус дополнительного соглашения |
1. Property Contract > contract > id#
| Type | string |
| Required | Yes |
| Format | uuid |
2. Property Contract > contract > number#
| Type | string |
| Required | No |
Description: Номер документа
3. Property Contract > contract > date#
| Type | string |
| Required | No |
| Format | date |
Description: Дата документа
4. Property Contract > contract > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип документа
Must be one of: * "CONTRACT" * "ORDER" * "ADDITIONAL_AGREEMENT"
5. Property Contract > contract > direction#
| Type | enum (of string) |
| Required | No |
Description: Тип документа
EXPORT: экспортныйIMPORT: импортный
Must be one of: * "EXPORT" * "IMPORT"
6. Property Contract > contract > 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 | Предыдущий статус клиента |
| 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 Contract > contract > customer > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
6.2. Property Contract > contract > customer > createdBy#
| Type | string |
| Required | No |
Description: id пользователя, создавшего клиента
6.3. Property Contract > contract > customer > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип заказчика
COMPANY: юр.лицоPERSON: физ.лицоIP: индивидуальный предприниматель
Must be one of: * "COMPANY" * "PERSON" * "IP"
6.4. Property Contract > contract > 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 Contract > contract > customer > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус клиента
6.6. Property Contract > contract > 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 Contract > contract > customer > partner#
| Type | string |
| Required | Yes |
Description: Партнер
6.8. Property Contract > contract > customer > signingType#
| Type | enum (of string) |
| Required | No |
Description: Способ подписания документов
HANDWRITTEN: подписание вручнуюSIMPLE_ELECTRONIC: ПЭП
Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"
6.9. Property Contract > contract > customer > canRequestSubsidiary#
| Type | boolean |
| Required | No |
Description: Может запрашивать согласование плательщика
6.10. Property Contract > contract > 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 Contract > contract > 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 Contract > contract > agent > id#
| Type | string |
| Required | No |
| Format | uuid |
Description: Уникальный идентификатор
7.2. Property Contract > contract > agent > customer#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
7.3. Property Contract > contract > agent > fullName#
| Type | string |
| Required | No |
Description: Название
7.4. Property Contract > contract > agent > fullNameEnglish#
| Type | string |
| Required | No |
Description: Название на английском языке
7.5. Property Contract > contract > agent > inn#
| Type | string |
| Required | No |
Description: ИНН
7.6. Property Contract > contract > 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 Contract > contract > agent > ogrn#
| Type | string |
| Required | No |
Description: ОГРН
7.8. Property Contract > contract > agent > bankAccount#
| Type | array of object |
| Required | No |
| Same definition as | bankAccounts |
Description: Реквизиты банковского счета
7.9. Property Contract > contract > agent > addressRegistration#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации
7.10. Property Contract > contract > agent > addressRegistrationEnglish#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации на английском языке
7.11. Property Contract > contract > 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 Contract > contract > agent > representative#
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | representative |
Description: Подписант
7.13. Property Contract > contract > agent > stampPath#
| Type | string |
| Required | No |
Description: Путь к файлу с изображением штампа
7.14. Property Contract > contract > agent > additionalProperties#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
7.15. Property Contract > contract > agent > required#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
7.16. Property Contract > contract > agent > status#
| Type | enum (of string) |
| Required | Yes |
Description: Статус
ACTIVE: действующий агентINACTIVE: заблокированный агент
Must be one of: * "ACTIVE" * "INACTIVE"
8. Property Contract > contract > 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 |
| 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 Contract > contract > canceledBy > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
8.2. Property Contract > contract > canceledBy > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип пользователя
CUSTOMER: клиентEMPLOYEE: исполнительAGENT: агент
Must be one of: * "CUSTOMER" * "EMPLOYEE" * "AGENT"
8.3. Property Contract > contract > canceledBy > customer#
Title: Customer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | customer |
Description: Клиент
8.4. Property Contract > contract > 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 Contract > contract > canceledBy > employee > fio#
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | fio |
Description: ФИО
8.5. Property Contract > contract > canceledBy > agent#
Title: Agent
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | agent |
Description: Agent
8.6. Property Contract > contract > canceledBy > email#
| Type | string |
| Required | Yes |
| Same definition as |
Description: E-mail пользователя
8.7. Property Contract > contract > canceledBy > phone#
| Type | string |
| Required | Yes |
Description: Номер мобильного телефона
| Restrictions | |
|---|---|
| Must match regular expression | ^(79)\d{9}$ Test |
8.8. Property Contract > contract > canceledBy > role#
| Type | enum (of string) |
| Required | Yes |
Description: Роль пользователя
Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"
8.9. Property Contract > contract > canceledBy > status#
| Type | enum (of string) |
| Required | Yes |
| Same definition as | status |
Description: Статус пользователя
8.10. Property Contract > contract > canceledBy > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус пользователя
8.11. Property Contract > contract > canceledBy > statusReason#
| Type | enum (of string) |
| Required | No |
Description: Причина установки текущего статуса
PASSWORD_MISTAKE: ошибка ввода пароляMANUAL_BLOCKED: ручная блокировка
Must be one of: * "PASSWORD_MISTAKE" * "MANUAL_BLOCKED"
8.12. Property Contract > contract > canceledBy > passwordMistakeCounter#
| Type | number |
| Required | No |
Description: Количество попыток ошибочного ввода пароля при входе в систему
9. Property Contract > contract > notApprovalComment#
| Type | string |
| Required | No |
Description: Комментарий при не согласовании документа
10. Property Contract > contract > userEmployee#
Title: User
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | canceledBy |
Description: Пользователь исполнителя
11. Property Contract > contract > userCustomer#
Title: User
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | canceledBy |
Description: Последний пользователь клиента изменивший документ
12. Property Contract > contract > createdAt#
| Type | string |
| Required | No |
| Format | datetime |
Description: Дата и время создания документа
13. Property Contract > contract > changedAt#
| Type | string |
| Required | No |
| Format | datetime |
Description: Дата и время последнего изменения документа
14. Property Contract > contract > notValidAfter#
| Type | string |
| Required | No |
| Format | date |
Description: Не действительно после
15. Property Contract > contract > 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. Contract > contract > 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 contract | Document |
| + isGenerated | No | boolean | No | - | Признак генерации файла системой |
| - signature | No | array of object | No | - | Платежные поручения |
15.1.1. Property Contract > contract > files > File > id#
| Type | string |
| Required | No |
| Format | uuid |
Description: Идентификатор файла
15.1.2. Property Contract > contract > 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 Contract > contract > files > File > template > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Идентификатор шаблона
15.1.2.2. Property Contract > contract > files > File > template > name#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Название
15.1.2.3. Property Contract > contract > 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 Contract > contract > files > File > template > path#
| Type | string |
| Required | Yes |
Description: Путь к файлу шаблона в хранилище объектов
15.1.3. Property Contract > contract > 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 Contract > contract > files > File > name#
| Type | string |
| Required | Yes |
Description: Отображаемое название файла
15.1.5. Property Contract > contract > files > File > path#
| Type | string |
| Required | Yes |
Description: Путь к файлу в хранилище объектов
15.1.6. Property Contract > contract > files > File > context#
| Type | string |
| Required | No |
Description: Данные, которые использовались для генерации файла
15.1.7. Property Contract > contract > files > File > status#
| Type | enum (of string) |
| Required | Yes |
Description: Статус
Must be one of: * "ACTIVE" * "DELETED"
15.1.8. Property Contract > contract > files > File > document#
Title: Document
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | contract |
Description: Ссылка на документ
15.1.9. Property Contract > contract > files > File > isGenerated#
| Type | boolean |
| Required | Yes |
Description: Признак генерации файла системой
15.1.10. Property Contract > contract > 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. Contract > contract > 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 Contract > contract > files > File > signature > signature items > operationId#
| Type | string |
| Required | No |
Description: Номер операции
15.1.10.1.2. Property Contract > contract > 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 Contract > contract > 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 Contract > contract > 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 Contract > contract > files > File > signature > signature items > signedAt#
| Type | string |
| Required | Yes |
| Format | date-time |
Description: Дата и время подписания документы
15.1.10.1.6. Property Contract > contract > files > File > signature > signature items > smsCode#
| Type | string |
| Required | No |
Description: Код из СМС которым
15.1.10.1.7. Property Contract > contract > files > File > signature > signature items > phone#
| Type | string |
| Required | No |
Description: Номер телефона на который отправили СМС
15.1.10.1.8. Property Contract > contract > files > File > signature > signature items > inn#
| Type | string |
| Required | No |
Description: ИНН
15.1.10.1.9. Property Contract > contract > files > File > signature > signature items > kpp#
| Type | string |
| Required | No |
Description: КПП
15.1.10.1.10. Property Contract > contract > files > File > signature > signature items > name#
| Type | string |
| Required | No |
Description: Наименование
15.1.10.1.11. Property Contract > contract > files > File > signature > signature items > fio#
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | fio |
Description: ФИО подписавшего
16. Property Contract > contract#
Title: Contract
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Defined in | document-contract.schema.json |
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 | - | - |
| - form | No | enum (of string) | No | - | Форма договора |
| - status | No | enum (of string) | No | - | Статус договора |
16.1. Property Contract > contract > id#
| Type | string |
| Required | Yes |
| Format | uuid |
16.2. Property Contract > contract > number#
| Type | string |
| Required | No |
Description: Номер документа
16.3. Property Contract > contract > date#
| Type | string |
| Required | No |
| Format | date |
Description: Дата документа
16.4. Property Contract > contract > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип документа
Must be one of: * "CONTRACT" * "ORDER" * "ADDITIONAL_AGREEMENT"
16.5. Property Contract > contract > direction#
| Type | enum (of string) |
| Required | No |
Description: Тип документа
EXPORT: экспортныйIMPORT: импортный
Must be one of: * "EXPORT" * "IMPORT"
16.6. Property Contract > contract > 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 | Предыдущий статус клиента |
| 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 | - | - |
16.6.1. Property Contract > contract > customer > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
16.6.2. Property Contract > contract > customer > createdBy#
| Type | string |
| Required | No |
Description: id пользователя, создавшего клиента
16.6.3. Property Contract > contract > customer > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип заказчика
COMPANY: юр.лицоPERSON: физ.лицоIP: индивидуальный предприниматель
Must be one of: * "COMPANY" * "PERSON" * "IP"
16.6.4. Property Contract > contract > customer > status#
| Type | enum (of string) |
| Required | Yes |
| Defined in | common/_common.schema.json#/status |
Description: Статус клиента
Must be one of: * "ACTIVE" * "INACTIVE" * "INVITED"
16.6.5. Property Contract > contract > customer > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус клиента
16.6.6. Property Contract > contract > 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 |
16.6.7. Property Contract > contract > customer > partner#
| Type | string |
| Required | Yes |
Description: Партнер
16.6.8. Property Contract > contract > customer > signingType#
| Type | enum (of string) |
| Required | No |
Description: Способ подписания документов
HANDWRITTEN: подписание вручнуюSIMPLE_ELECTRONIC: ПЭП
Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"
16.6.9. Property Contract > contract > customer > canRequestSubsidiary#
| Type | boolean |
| Required | No |
Description: Может запрашивать согласование плательщика
16.6.10. Property Contract > contract > 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 |
16.7. Property Contract > contract > 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`: заблокированный агент |
16.7.1. Property Contract > contract > agent > id#
| Type | string |
| Required | No |
| Format | uuid |
Description: Уникальный идентификатор
16.7.2. Property Contract > contract > agent > customer#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
16.7.3. Property Contract > contract > agent > fullName#
| Type | string |
| Required | No |
Description: Название
16.7.4. Property Contract > contract > agent > fullNameEnglish#
| Type | string |
| Required | No |
Description: Название на английском языке
16.7.5. Property Contract > contract > agent > inn#
| Type | string |
| Required | No |
Description: ИНН
16.7.6. Property Contract > contract > agent > kpp#
| Type | string |
| Required | No |
Description: КПП
| Restrictions | |
|---|---|
| Min length | 9 |
| Max length | 9 |
| Must match regular expression | ^[0-9]{9}$ Test |
16.7.7. Property Contract > contract > agent > ogrn#
| Type | string |
| Required | No |
Description: ОГРН
16.7.8. Property Contract > contract > agent > bankAccount#
| Type | array of object |
| Required | No |
| Same definition as | bankAccounts |
Description: Реквизиты банковского счета
16.7.9. Property Contract > contract > agent > addressRegistration#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации
16.7.10. Property Contract > contract > agent > addressRegistrationEnglish#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации на английском языке
16.7.11. Property Contract > contract > 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 |
16.7.12. Property Contract > contract > agent > representative#
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | representative |
Description: Подписант
16.7.13. Property Contract > contract > agent > stampPath#
| Type | string |
| Required | No |
Description: Путь к файлу с изображением штампа
16.7.14. Property Contract > contract > agent > additionalProperties#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
16.7.15. Property Contract > contract > agent > required#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
16.7.16. Property Contract > contract > agent > status#
| Type | enum (of string) |
| Required | Yes |
Description: Статус
ACTIVE: действующий агентINACTIVE: заблокированный агент
Must be one of: * "ACTIVE" * "INACTIVE"
16.8. Property Contract > contract > 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 |
| 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 | - | Количество попыток ошибочного ввода пароля при входе в систему |
16.8.1. Property Contract > contract > canceledBy > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
16.8.2. Property Contract > contract > canceledBy > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип пользователя
CUSTOMER: клиентEMPLOYEE: исполнительAGENT: агент
Must be one of: * "CUSTOMER" * "EMPLOYEE" * "AGENT"
16.8.3. Property Contract > contract > canceledBy > customer#
Title: Customer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | customer |
Description: Клиент
16.8.4. Property Contract > contract > 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 | ФИО |
16.8.4.1. Property Contract > contract > canceledBy > employee > fio#
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | fio |
Description: ФИО
16.8.5. Property Contract > contract > canceledBy > agent#
Title: Agent
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | agent |
Description: Agent
16.8.6. Property Contract > contract > canceledBy > email#
| Type | string |
| Required | Yes |
| Same definition as |
Description: E-mail пользователя
16.8.7. Property Contract > contract > canceledBy > phone#
| Type | string |
| Required | Yes |
Description: Номер мобильного телефона
| Restrictions | |
|---|---|
| Must match regular expression | ^(79)\d{9}$ Test |
16.8.8. Property Contract > contract > canceledBy > role#
| Type | enum (of string) |
| Required | Yes |
Description: Роль пользователя
Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"
16.8.9. Property Contract > contract > canceledBy > status#
| Type | enum (of string) |
| Required | Yes |
| Same definition as | status |
Description: Статус пользователя
16.8.10. Property Contract > contract > canceledBy > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус пользователя
16.8.11. Property Contract > contract > canceledBy > statusReason#
| Type | enum (of string) |
| Required | No |
Description: Причина установки текущего статуса
PASSWORD_MISTAKE: ошибка ввода пароляMANUAL_BLOCKED: ручная блокировка
Must be one of: * "PASSWORD_MISTAKE" * "MANUAL_BLOCKED"
16.8.12. Property Contract > contract > canceledBy > passwordMistakeCounter#
| Type | number |
| Required | No |
Description: Количество попыток ошибочного ввода пароля при входе в систему
16.9. Property Contract > contract > notApprovalComment#
| Type | string |
| Required | No |
Description: Комментарий при не согласовании документа
16.10. Property Contract > contract > userEmployee#
Title: User
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | canceledBy |
Description: Пользователь исполнителя
16.11. Property Contract > contract > userCustomer#
Title: User
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | canceledBy |
Description: Последний пользователь клиента изменивший документ
16.12. Property Contract > contract > createdAt#
| Type | string |
| Required | No |
| Format | datetime |
Description: Дата и время создания документа
16.13. Property Contract > contract > changedAt#
| Type | string |
| Required | No |
| Format | datetime |
Description: Дата и время последнего изменения документа
16.14. Property Contract > contract > notValidAfter#
| Type | string |
| Required | No |
| Format | date |
Description: Не действительно после
16.15. Property Contract > contract > 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 | Метаданные файла документа в системе |
16.15.1. Contract > contract > 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 contract | Document |
| + isGenerated | No | boolean | No | - | Признак генерации файла системой |
| - signature | No | array of object | No | - | Платежные поручения |
16.15.1.1. Property Contract > contract > files > File > id#
| Type | string |
| Required | No |
| Format | uuid |
Description: Идентификатор файла
16.15.1.2. Property Contract > contract > 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 | - | Путь к файлу шаблона в хранилище объектов |
16.15.1.2.1. Property Contract > contract > files > File > template > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Идентификатор шаблона
16.15.1.2.2. Property Contract > contract > files > File > template > name#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Название
16.15.1.2.3. Property Contract > contract > 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"
16.15.1.2.4. Property Contract > contract > files > File > template > path#
| Type | string |
| Required | Yes |
Description: Путь к файлу шаблона в хранилище объектов
16.15.1.3. Property Contract > contract > 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"
16.15.1.4. Property Contract > contract > files > File > name#
| Type | string |
| Required | Yes |
Description: Отображаемое название файла
16.15.1.5. Property Contract > contract > files > File > path#
| Type | string |
| Required | Yes |
Description: Путь к файлу в хранилище объектов
16.15.1.6. Property Contract > contract > files > File > context#
| Type | string |
| Required | No |
Description: Данные, которые использовались для генерации файла
16.15.1.7. Property Contract > contract > files > File > status#
| Type | enum (of string) |
| Required | Yes |
Description: Статус
Must be one of: * "ACTIVE" * "DELETED"
16.15.1.8. Property Contract > contract > files > File > document#
Title: Document
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | contract |
Description: Ссылка на документ
16.15.1.9. Property Contract > contract > files > File > isGenerated#
| Type | boolean |
| Required | Yes |
Description: Признак генерации файла системой
16.15.1.10. Property Contract > contract > 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 | - |
16.15.1.10.1. Contract > contract > 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 | ФИО подписавшего |
16.15.1.10.1.1. Property Contract > contract > files > File > signature > signature items > operationId#
| Type | string |
| Required | No |
Description: Номер операции
16.15.1.10.1.2. Property Contract > contract > files > File > signature > signature items > signingType#
| Type | enum (of string) |
| Required | Yes |
Description: Способ подписания документов
HANDWRITTEN: подписание вручнуюSIMPLE_ELECTRONIC: ПЭП
Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"
16.15.1.10.1.3. Property Contract > contract > files > File > signature > signature items > user#
Title: User
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Same definition as | canceledBy |
Description: Пользователь
16.15.1.10.1.4. Property Contract > contract > files > File > signature > signature items > userRole#
| Type | enum (of string) |
| Required | Yes |
Description: Роль пользователя
Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"
16.15.1.10.1.5. Property Contract > contract > files > File > signature > signature items > signedAt#
| Type | string |
| Required | Yes |
| Format | date-time |
Description: Дата и время подписания документы
16.15.1.10.1.6. Property Contract > contract > files > File > signature > signature items > smsCode#
| Type | string |
| Required | No |
Description: Код из СМС которым
16.15.1.10.1.7. Property Contract > contract > files > File > signature > signature items > phone#
| Type | string |
| Required | No |
Description: Номер телефона на который отправили СМС
16.15.1.10.1.8. Property Contract > contract > files > File > signature > signature items > inn#
| Type | string |
| Required | No |
Description: ИНН
16.15.1.10.1.9. Property Contract > contract > files > File > signature > signature items > kpp#
| Type | string |
| Required | No |
Description: КПП
16.15.1.10.1.10. Property Contract > contract > files > File > signature > signature items > name#
| Type | string |
| Required | No |
Description: Наименование
16.15.1.10.1.11. Property Contract > contract > files > File > signature > signature items > fio#
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | fio |
Description: ФИО подписавшего
16.16. Property Contract > contract > form#
| Type | enum (of string) |
| Required | No |
Description: Форма договора
Must be one of: * "STANDARD" * "INDIVIDUAL"
16.17. Property Contract > contract > status#
| Type | enum (of string) |
| Required | No |
Description: Статус договора
Must be one of: * "DRAFT" * "AGENT_SIGNING" * "CUSTOMER_SIGNING" * "CONTRACTOR_ADJUSTMENT" * "CONTRACTOR_VERIFICATION" * "SIGNED" * "CLOSED" * "CANCELLED"
17. Property Contract > form#
| Type | enum (of string) |
| Required | No |
Description: Форма дополнительного соглашения
Must be one of: * "STANDARD" * "INDIVIDUAL"
18. Property Contract > status#
| Type | enum (of string) |
| Required | No |
Description: Статус дополнительного соглашения
Must be one of: * "DRAFT" * "AGENT_SIGNING" * "CUSTOMER_SIGNING" * "CONTRACTOR_ADJUSTMENT" * "CONTRACTOR_VERIFICATION" * "SIGNED" * "CLOSED" * "CANCELLED"
Generated using json-schema-for-humans on 2025-02-11 at 14:28:18 +0000