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

chat#

Title: chat
Type object
Required No
Additional properties Any type allowed

Description: Содержит метаданные чата

Property Pattern Type Deprecated Definition Title/Description
- Id No string No - Идентификатор чата
- order No object No In document-order.schema.json Order
- messages No array No - Сообщения

1. Property chat > Id#
Type string
Required No
Format uuid

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

2. Property chat > order#

Title: Order
Type object
Required No
Additional properties Not allowed
Defined in document-order.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 Заказчик
- 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 - -
+ status No enum (of string) No - Статус
- submittedAt No string No - Дата и время отправки клиентом исполнителю
- verifiedAt No string No - Дата и время отклонения/одобрения исполнителем
- contract No object No In document-contract.schema.json Contract
- reportDate No string No - Дата отчёта
- subagent No object No In subagent.schema.json Subagent
- subsidiary No object No In subsidiary.schema.json Subsidiary
- subsidiaryBankAccount No array of object No Same as bankAccount Счет плательщика
- preferredSubsidiary No object No - Предпочитаемый плательщик
+ counterparty No object No - Информация о контрагенте
+ payment No object No - Информация о платеже
- additionalInfo No object No - Дополнительная информация
- isBelowCost No boolean No - Агентское вознаграждение ниже себестоимости
- commission No object No - Агентское вознаграждение
- paymentOrder No array of object No - Платежные поручения
- specification No array of object No - Товары, услуги

2.1. Property chat > order > contract > id#
Type string
Required Yes
Format uuid

2.2. Property chat > order > contract > number#
Type string
Required No

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

2.3. Property chat > order > contract > date#
Type string
Required No
Format date

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

2.4. Property chat > order > contract > type#
Type enum (of string)
Required Yes

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

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

2.5. Property chat > order > contract > direction#
Type enum (of string)
Required No

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

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

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

2.6. Property chat > order > contract > customer#
Type object
Required Yes
Additional properties Any type allowed
Defined in customer.schema.json

Description: Заказчик

2.7. Property chat > order > 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 In common/_common.schema.json#/bankAccount Реквизиты банковского счета
- addressRegistration No object No In common/_common.schema.json#/address Адрес регистрации
- addressRegistrationEnglish No object No Same as addressRegistration Адрес регистрации на английском языке
- 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`: заблокированный агент

2.7.1. Property chat > order > contract > agent > id#
Type string
Required No
Format uuid

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

2.7.2. Property chat > order > contract > agent > customer#
Type object
Required No
Additional properties Any type allowed

2.7.3. Property chat > order > contract > agent > fullName#
Type string
Required No

Description: Название

2.7.4. Property chat > order > contract > agent > fullNameEnglish#
Type string
Required No

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

2.7.5. Property chat > order > contract > agent > inn#
Type string
Required No

Description: ИНН

2.7.6. Property chat > order > contract > agent > kpp#
Type string
Required No

Description: КПП

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

2.7.7. Property chat > order > contract > agent > ogrn#
Type string
Required No

Description: ОГРН

2.7.8. Property chat > order > contract > agent > bankAccount#
Type array of object
Required No
Defined in common/_common.schema.json#/bankAccount

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

Array restrictions
Min items 0
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
bankAccount items -
2.7.8.1. chat > order > contract > agent > bankAccount > bankAccount items#
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- isPriority No boolean No - Признак приоритетного счета в указанной валюте
+ number No string No - Номер счета
- bank No object No - Банк РФ
- foreignBank No object No - Банк из списка SWIFT
- bankAccountType No enum (of string) No - -
- currency No object No - -
- status No enum (of string) No - Статус

- `ACTIVE`: активный
- `INACTIVE`: заблокированный
2.7.8.1.1. Property chat > order > contract > agent > bankAccount > bankAccount items > isPriority#
Type boolean
Required No

Description: Признак приоритетного счета в указанной валюте

2.7.8.1.2. Property chat > order > contract > agent > bankAccount > bankAccount items > number#
Type string
Required Yes

Description: Номер счета

Restrictions
Max length 50
Must match regular expression ^[0-9a-zA-Z]+$ Test
2.7.8.1.3. Property chat > order > contract > agent > bankAccount > bankAccount items > bank#
Type object
Required No
Additional properties Any type allowed

Description: Банк РФ

2.7.8.1.4. Property chat > order > contract > agent > bankAccount > bankAccount items > foreignBank#
Type object
Required No
Additional properties Any type allowed

Description: Банк из списка SWIFT

2.7.8.1.5. Property chat > order > contract > agent > bankAccount > bankAccount items > bankAccountType#
Type enum (of string)
Required No

Must be one of: * "RUS" * "FOREIGN"

2.7.8.1.6. Property chat > order > contract > agent > bankAccount > bankAccount items > currency#
Type object
Required No
Additional properties Any type allowed
2.7.8.1.7. Property chat > order > contract > agent > bankAccount > bankAccount items > status#
Type enum (of string)
Required No

Description: Статус

  • ACTIVE: активный
  • INACTIVE: заблокированный

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

2.7.9. Property chat > order > contract > agent > addressRegistration#
Type object
Required No
Additional properties Any type allowed
Defined in common/_common.schema.json#/address

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

Property Pattern Type Deprecated Definition Title/Description
- address No string No - Адрес
- zipCode No string No - Почтовый индекс
- additionalProperties No object No - -
- required No object No - -
2.7.9.1. Property chat > order > contract > agent > addressRegistration > address#
Type string
Required No

Description: Адрес

2.7.9.2. Property chat > order > contract > agent > addressRegistration > zipCode#
Type string
Required No

Description: Почтовый индекс

2.7.9.3. Property chat > order > contract > agent > addressRegistration > additionalProperties#
Type object
Required No
Additional properties Any type allowed
2.7.9.4. Property chat > order > contract > agent > addressRegistration > required#
Type object
Required No
Additional properties Any type allowed

2.7.10. Property chat > order > contract > agent > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistration

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

2.7.11. Property chat > order > 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

2.7.12. Property chat > order > contract > agent > representative#
Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

2.7.13. Property chat > order > contract > agent > stampPath#
Type string
Required No

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

2.7.14. Property chat > order > contract > agent > additionalProperties#
Type object
Required No
Additional properties Any type allowed

2.7.15. Property chat > order > contract > agent > required#
Type object
Required No
Additional properties Any type allowed

2.7.16. Property chat > order > contract > agent > status#
Type enum (of string)
Required Yes

Description: Статус

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

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

2.8. Property chat > order > 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 In customer.schema.json Клиент
- employee No object No In employee.schema.json Employee
- agent No object No Same as agent Agent
+ email No string No In common/_common.schema.json#/email E-mail пользователя
+ phone No string No - Номер мобильного телефона
+ role No enum (of string) No - Роль пользователя
+ status No enum (of string) No In common/_common.schema.json#/status Статус пользователя
- statusPrevious No enum (of string) No Same as status Предыдущий статус пользователя
- statusReason No enum (of string) No - Причина установки текущего статуса

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

2.8.1. Property chat > order > contract > canceledBy > id#
Type string
Required Yes
Format uuid

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

2.8.2. Property chat > order > contract > canceledBy > type#
Type enum (of string)
Required Yes

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

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

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

2.8.3. Property chat > order > contract > canceledBy > customer#
Type object
Required No
Additional properties Any type allowed
Defined in customer.schema.json

Description: Клиент

2.8.4. Property chat > order > 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 ФИО
2.8.4.1. Property chat > order > contract > canceledBy > employee > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

Description: ФИО

2.8.5. Property chat > order > contract > canceledBy > agent#

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

Description: Agent

2.8.6. Property chat > order > contract > canceledBy > email#
Type string
Required Yes
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

2.8.7. Property chat > order > contract > canceledBy > phone#
Type string
Required Yes

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

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

2.8.8. Property chat > order > contract > canceledBy > role#
Type enum (of string)
Required Yes

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

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

2.8.9. Property chat > order > contract > canceledBy > status#
Type enum (of string)
Required Yes
Defined in common/_common.schema.json#/status

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

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

2.8.10. Property chat > order > contract > canceledBy > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

2.8.11. Property chat > order > contract > canceledBy > statusReason#
Type enum (of string)
Required No

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

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

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

2.8.12. Property chat > order > contract > canceledBy > passwordMistakeCounter#
Type number
Required No

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

2.9. Property chat > order > contract > notApprovalComment#
Type string
Required No

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

2.10. Property chat > order > contract > userEmployee#

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

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

2.11. Property chat > order > contract > userCustomer#

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

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

2.12. Property chat > order > contract > createdAt#
Type string
Required No
Format datetime

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

2.13. Property chat > order > contract > changedAt#
Type string
Required No
Format datetime

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

2.14. Property chat > order > contract > notValidAfter#
Type string
Required No
Format date

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

2.15. Property chat > order > 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 Метаданные файла документа в системе

2.15.1. chat > order > 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 - Платежные поручения
2.15.1.1. Property chat > order > contract > files > File > id#
Type string
Required No
Format uuid

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

2.15.1.2. Property chat > order > 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 - Путь к файлу шаблона в хранилище объектов
2.15.1.2.1. Property chat > order > contract > files > File > template > id#
Type string
Required Yes
Format uuid

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

2.15.1.2.2. Property chat > order > contract > files > File > template > name#
Type string
Required Yes
Format uuid

Description: Название

2.15.1.2.3. Property chat > order > 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"

2.15.1.2.4. Property chat > order > contract > files > File > template > path#
Type string
Required Yes

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

2.15.1.3. Property chat > order > 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"

2.15.1.4. Property chat > order > contract > files > File > name#
Type string
Required Yes

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

2.15.1.5. Property chat > order > contract > files > File > path#
Type string
Required Yes

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

2.15.1.6. Property chat > order > contract > files > File > context#
Type string
Required No

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

2.15.1.7. Property chat > order > contract > files > File > status#
Type enum (of string)
Required Yes

Description: Статус

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

2.15.1.8. Property chat > order > contract > files > File > document#

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

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

2.15.1.9. Property chat > order > contract > files > File > isGenerated#
Type boolean
Required Yes

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

2.15.1.10. Property chat > order > 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 -
2.15.1.10.1. chat > order > 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 ФИО подписавшего
2.15.1.10.1.1. Property chat > order > contract > files > File > signature > signature items > operationId#
Type string
Required No

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

2.15.1.10.1.2. Property chat > order > contract > files > File > signature > signature items > signingType#
Type enum (of string)
Required Yes

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

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

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

2.15.1.10.1.3. Property chat > order > contract > files > File > signature > signature items > user#

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

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

2.15.1.10.1.4. Property chat > order > contract > files > File > signature > signature items > userRole#
Type enum (of string)
Required Yes

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

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

2.15.1.10.1.5. Property chat > order > contract > files > File > signature > signature items > signedAt#
Type string
Required Yes
Format date-time

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

2.15.1.10.1.6. Property chat > order > contract > files > File > signature > signature items > smsCode#
Type string
Required No

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

2.15.1.10.1.7. Property chat > order > contract > files > File > signature > signature items > phone#
Type string
Required No

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

2.15.1.10.1.8. Property chat > order > contract > files > File > signature > signature items > inn#
Type string
Required No

Description: ИНН

2.15.1.10.1.9. Property chat > order > contract > files > File > signature > signature items > kpp#
Type string
Required No

Description: КПП

2.15.1.10.1.10. Property chat > order > contract > files > File > signature > signature items > name#
Type string
Required No

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

2.15.1.10.1.11. Property chat > order > contract > files > File > signature > signature items > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

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

2.16. Property chat > order > status#
Type enum (of string)
Required Yes

Description: Статус

Must be one of: * "DRAFT" * "NEW" * "CUSTOMER_ADJUSTMENT" * "CUSTOMER_APPROVAL" * "CONTRACTOR_ADJUSTMENT" * "INVOICE_PREPARATION" * "AWAITING_FUNDS" * "EXECUTION" * "CUSTOMER_REPORT_SIGNING" * "REPORT_ADJUSTMENT" * "RECEIPT_CONFIRMATION" * "DONE" * "CANCELLED" * "INVOICE_ADJUSTMENT" * "SENT_FUNDS" * "RECEIVED_FUNDS" * "INSTRUCTION_PREPARATION" * "CUSTOMER_INSTRUCTION_SIGNING" * "INSTRUCTION_ADJUSTMENT" * "CONTRACTOR_REPORT_VERIFICATION" * "DRAFT_CONTRACTOR" * "REPORT_PREPARATION"

2.17. Property chat > order > submittedAt#
Type string
Required No
Format datetime

Description: Дата и время отправки клиентом исполнителю

2.18. Property chat > order > verifiedAt#
Type string
Required No
Format datetime

Description: Дата и время отклонения/одобрения исполнителем

2.19. Property chat > order > 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 Заказчик
- 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 - Статус договора

2.19.1. Property chat > order > contract > id#
Type string
Required Yes
Format uuid

2.19.2. Property chat > order > contract > number#
Type string
Required No

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

2.19.3. Property chat > order > contract > date#
Type string
Required No
Format date

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

2.19.4. Property chat > order > contract > type#
Type enum (of string)
Required Yes

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

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

2.19.5. Property chat > order > contract > direction#
Type enum (of string)
Required No

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

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

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

2.19.6. Property chat > order > contract > customer#
Type object
Required Yes
Additional properties Any type allowed
Defined in customer.schema.json

Description: Заказчик

2.19.7. Property chat > order > 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 In common/_common.schema.json#/bankAccount Реквизиты банковского счета
- addressRegistration No object No In common/_common.schema.json#/address Адрес регистрации
- addressRegistrationEnglish No object No Same as addressRegistration Адрес регистрации на английском языке
- 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`: заблокированный агент
2.19.7.1. Property chat > order > contract > agent > id#
Type string
Required No
Format uuid

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

2.19.7.2. Property chat > order > contract > agent > customer#
Type object
Required No
Additional properties Any type allowed
2.19.7.3. Property chat > order > contract > agent > fullName#
Type string
Required No

Description: Название

2.19.7.4. Property chat > order > contract > agent > fullNameEnglish#
Type string
Required No

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

2.19.7.5. Property chat > order > contract > agent > inn#
Type string
Required No

Description: ИНН

2.19.7.6. Property chat > order > contract > agent > kpp#
Type string
Required No

Description: КПП

Restrictions
Min length 9
Max length 9
Must match regular expression ^[0-9]{9}$ Test
2.19.7.7. Property chat > order > contract > agent > ogrn#
Type string
Required No

Description: ОГРН

2.19.7.8. Property chat > order > contract > agent > bankAccount#
Type array of object
Required No
Defined in common/_common.schema.json#/bankAccount

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

Array restrictions
Min items 0
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
bankAccount items -
2.19.7.8.1. chat > order > contract > agent > bankAccount > bankAccount items#
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- isPriority No boolean No - Признак приоритетного счета в указанной валюте
+ number No string No - Номер счета
- bank No object No - Банк РФ
- foreignBank No object No - Банк из списка SWIFT
- bankAccountType No enum (of string) No - -
- currency No object No - -
- status No enum (of string) No - Статус

- `ACTIVE`: активный
- `INACTIVE`: заблокированный
2.19.7.8.1.1. Property chat > order > contract > agent > bankAccount > bankAccount items > isPriority#
Type boolean
Required No

Description: Признак приоритетного счета в указанной валюте

2.19.7.8.1.2. Property chat > order > contract > agent > bankAccount > bankAccount items > number#
Type string
Required Yes

Description: Номер счета

Restrictions
Max length 50
Must match regular expression ^[0-9a-zA-Z]+$ Test
2.19.7.8.1.3. Property chat > order > contract > agent > bankAccount > bankAccount items > bank#
Type object
Required No
Additional properties Any type allowed

Description: Банк РФ

2.19.7.8.1.4. Property chat > order > contract > agent > bankAccount > bankAccount items > foreignBank#
Type object
Required No
Additional properties Any type allowed

Description: Банк из списка SWIFT

2.19.7.8.1.5. Property chat > order > contract > agent > bankAccount > bankAccount items > bankAccountType#
Type enum (of string)
Required No

Must be one of: * "RUS" * "FOREIGN"

2.19.7.8.1.6. Property chat > order > contract > agent > bankAccount > bankAccount items > currency#
Type object
Required No
Additional properties Any type allowed
2.19.7.8.1.7. Property chat > order > contract > agent > bankAccount > bankAccount items > status#
Type enum (of string)
Required No

Description: Статус

  • ACTIVE: активный
  • INACTIVE: заблокированный

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

2.19.7.9. Property chat > order > contract > agent > addressRegistration#
Type object
Required No
Additional properties Any type allowed
Defined in common/_common.schema.json#/address

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

Property Pattern Type Deprecated Definition Title/Description
- address No string No - Адрес
- zipCode No string No - Почтовый индекс
- additionalProperties No object No - -
- required No object No - -
2.19.7.9.1. Property chat > order > contract > agent > addressRegistration > address#
Type string
Required No

Description: Адрес

2.19.7.9.2. Property chat > order > contract > agent > addressRegistration > zipCode#
Type string
Required No

Description: Почтовый индекс

2.19.7.9.3. Property chat > order > contract > agent > addressRegistration > additionalProperties#
Type object
Required No
Additional properties Any type allowed
2.19.7.9.4. Property chat > order > contract > agent > addressRegistration > required#
Type object
Required No
Additional properties Any type allowed
2.19.7.10. Property chat > order > contract > agent > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistration

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

2.19.7.11. Property chat > order > 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
2.19.7.12. Property chat > order > contract > agent > representative#
Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

2.19.7.13. Property chat > order > contract > agent > stampPath#
Type string
Required No

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

2.19.7.14. Property chat > order > contract > agent > additionalProperties#
Type object
Required No
Additional properties Any type allowed
2.19.7.15. Property chat > order > contract > agent > required#
Type object
Required No
Additional properties Any type allowed
2.19.7.16. Property chat > order > contract > agent > status#
Type enum (of string)
Required Yes

Description: Статус

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

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

2.19.8. Property chat > order > 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 In customer.schema.json Клиент
- employee No object No In employee.schema.json Employee
- agent No object No Same as agent Agent
+ email No string No In common/_common.schema.json#/email E-mail пользователя
+ phone No string No - Номер мобильного телефона
+ role No enum (of string) No - Роль пользователя
+ status No enum (of string) No In common/_common.schema.json#/status Статус пользователя
- statusPrevious No enum (of string) No Same as status Предыдущий статус пользователя
- statusReason No enum (of string) No - Причина установки текущего статуса

- `PASSWORD_MISTAKE`: ошибка ввода пароля
- `MANUAL_BLOCKED`: ручная блокировка
- passwordMistakeCounter No number No - Количество попыток ошибочного ввода пароля при входе в систему
2.19.8.1. Property chat > order > contract > canceledBy > id#
Type string
Required Yes
Format uuid

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

2.19.8.2. Property chat > order > contract > canceledBy > type#
Type enum (of string)
Required Yes

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

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

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

2.19.8.3. Property chat > order > contract > canceledBy > customer#
Type object
Required No
Additional properties Any type allowed
Defined in customer.schema.json

Description: Клиент

2.19.8.4. Property chat > order > 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 ФИО
2.19.8.4.1. Property chat > order > contract > canceledBy > employee > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

Description: ФИО

2.19.8.5. Property chat > order > contract > canceledBy > agent#

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

Description: Agent

2.19.8.6. Property chat > order > contract > canceledBy > email#
Type string
Required Yes
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
2.19.8.7. Property chat > order > contract > canceledBy > phone#
Type string
Required Yes

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

Restrictions
Must match regular expression ^(79)\d{9}$ Test
2.19.8.8. Property chat > order > contract > canceledBy > role#
Type enum (of string)
Required Yes

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

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

2.19.8.9. Property chat > order > contract > canceledBy > status#
Type enum (of string)
Required Yes
Defined in common/_common.schema.json#/status

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

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

2.19.8.10. Property chat > order > contract > canceledBy > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

2.19.8.11. Property chat > order > contract > canceledBy > statusReason#
Type enum (of string)
Required No

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

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

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

2.19.8.12. Property chat > order > contract > canceledBy > passwordMistakeCounter#
Type number
Required No

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

2.19.9. Property chat > order > contract > notApprovalComment#
Type string
Required No

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

2.19.10. Property chat > order > contract > userEmployee#

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

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

2.19.11. Property chat > order > contract > userCustomer#

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

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

2.19.12. Property chat > order > contract > createdAt#
Type string
Required No
Format datetime

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

2.19.13. Property chat > order > contract > changedAt#
Type string
Required No
Format datetime

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

2.19.14. Property chat > order > contract > notValidAfter#
Type string
Required No
Format date

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

2.19.15. Property chat > order > 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 Метаданные файла документа в системе
2.19.15.1. chat > order > 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 - Платежные поручения
2.19.15.1.1. Property chat > order > contract > files > File > id#
Type string
Required No
Format uuid

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

2.19.15.1.2. Property chat > order > 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 - Путь к файлу шаблона в хранилище объектов
2.19.15.1.2.1. Property chat > order > contract > files > File > template > id#
Type string
Required Yes
Format uuid

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

2.19.15.1.2.2. Property chat > order > contract > files > File > template > name#
Type string
Required Yes
Format uuid

Description: Название

2.19.15.1.2.3. Property chat > order > 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"

2.19.15.1.2.4. Property chat > order > contract > files > File > template > path#
Type string
Required Yes

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

2.19.15.1.3. Property chat > order > 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"

2.19.15.1.4. Property chat > order > contract > files > File > name#
Type string
Required Yes

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

2.19.15.1.5. Property chat > order > contract > files > File > path#
Type string
Required Yes

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

2.19.15.1.6. Property chat > order > contract > files > File > context#
Type string
Required No

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

2.19.15.1.7. Property chat > order > contract > files > File > status#
Type enum (of string)
Required Yes

Description: Статус

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

2.19.15.1.8. Property chat > order > contract > files > File > document#

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

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

2.19.15.1.9. Property chat > order > contract > files > File > isGenerated#
Type boolean
Required Yes

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

2.19.15.1.10. Property chat > order > 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 -
2.19.15.1.10.1. chat > order > 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 ФИО подписавшего
2.19.15.1.10.1.1. Property chat > order > contract > files > File > signature > signature items > operationId#
Type string
Required No

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

2.19.15.1.10.1.2. Property chat > order > contract > files > File > signature > signature items > signingType#
Type enum (of string)
Required Yes

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

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

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

2.19.15.1.10.1.3. Property chat > order > contract > files > File > signature > signature items > user#

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

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

2.19.15.1.10.1.4. Property chat > order > contract > files > File > signature > signature items > userRole#
Type enum (of string)
Required Yes

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

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

2.19.15.1.10.1.5. Property chat > order > contract > files > File > signature > signature items > signedAt#
Type string
Required Yes
Format date-time

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

2.19.15.1.10.1.6. Property chat > order > contract > files > File > signature > signature items > smsCode#
Type string
Required No

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

2.19.15.1.10.1.7. Property chat > order > contract > files > File > signature > signature items > phone#
Type string
Required No

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

2.19.15.1.10.1.8. Property chat > order > contract > files > File > signature > signature items > inn#
Type string
Required No

Description: ИНН

2.19.15.1.10.1.9. Property chat > order > contract > files > File > signature > signature items > kpp#
Type string
Required No

Description: КПП

2.19.15.1.10.1.10. Property chat > order > contract > files > File > signature > signature items > name#
Type string
Required No

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

2.19.15.1.10.1.11. Property chat > order > contract > files > File > signature > signature items > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

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

2.19.16. Property chat > order > contract > form#
Type enum (of string)
Required No

Description: Форма договора

Must be one of: * "STANDARD" * "INDIVIDUAL"

2.19.17. Property chat > order > 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"

2.20. Property chat > order > reportDate#
Type string
Required No
Format date

Description: Дата отчёта

2.21. Property chat > order > subagent#

Title: Subagent
Type object
Required No
Additional properties Not allowed
Defined in subagent.schema.json

Description: Субагент

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Идентификатор
- fullNameEnglish No string No - Название на английском языке
+ status No enum (of string) No - Статус

- `ACTIVE`: Активен
- `INACTIVE`: Заблокирован
- agents No array No - Связанные агенты
- limits No array No - Лимита субагента
- costs No array No - Себестоимость платежкй субагента
- subsidiaries No array No - Связанные плательщики и получатели

2.21.1. Property chat > order > subagent > id#
Type string
Required No
Format UUID

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

2.21.2. Property chat > order > subagent > fullNameEnglish#
Type string
Required No

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

2.21.3. Property chat > order > subagent > status#
Type enum (of string)
Required Yes

Description: Статус

  • ACTIVE: Активен
  • INACTIVE: Заблокирован

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

2.21.4. Property chat > order > subagent > agents#
Type array
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
agents items -
2.21.4.1. chat > order > subagent > agents > agents items#
Type object
Required No
Additional properties Any type allowed

2.21.5. Property chat > order > subagent > limits#
Type array
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
limits items -
2.21.5.1. chat > order > subagent > limits > limits items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- currency No string No In common/_common.schema.json#/currency Валюта лимита
- amount No number No - Сумма лимита
2.21.5.1.1. Property chat > order > subagent > limits > limits items > currency#
Type string
Required No
Defined in common/_common.schema.json#/currency

Description: Валюта лимита

Restrictions
Min length 3
Max length 3
Must match regular expression ^[A-Z]{3}$ Test
2.21.5.1.2. Property chat > order > subagent > limits > limits items > amount#
Type number
Required No

Description: Сумма лимита

Restrictions
Multiple of 0.01
Minimum ≥ 0

2.21.6. Property chat > order > subagent > costs#
Type array
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
costs items -
2.21.6.1. chat > order > subagent > costs > costs items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- currency No string No Same as currency Валюта платежа
- minAmount No number No - Нижняя граница диапазона
- maxAmount No number No - Верхняя граница диапазона
- percent No number No - Размер себестоимости, указывается в %
2.21.6.1.1. Property chat > order > subagent > costs > costs items > currency#
Type string
Required No
Same definition as currency

Description: Валюта платежа

2.21.6.1.2. Property chat > order > subagent > costs > costs items > minAmount#
Type number
Required No

Description: Нижняя граница диапазона

Restrictions
Multiple of 0.01
Minimum ≥ 0
2.21.6.1.3. Property chat > order > subagent > costs > costs items > maxAmount#
Type number
Required No

Description: Верхняя граница диапазона

Restrictions
Multiple of 0.01
Minimum ≥ 0
2.21.6.1.4. Property chat > order > subagent > costs > costs items > percent#
Type number
Required No

Description: Размер себестоимости, указывается в %

Restrictions
Multiple of 0.0001

2.21.7. Property chat > order > subagent > subsidiaries#
Type array
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
subsidiaries items -
2.21.7.1. chat > order > subagent > subsidiaries > subsidiaries items#
Type object
Required No
Additional properties Any type allowed

2.22. Property chat > order > subsidiary#

Title: Subsidiary
Type object
Required No
Additional properties Not allowed
Defined in subsidiary.schema.json

Description: Плательщик/Получатель

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Идентификатор
- subagent No object No - Связанный субагент
- canUseInImport No boolean No - Использовать в импортных заявках
- canUseInExport No boolean No - Использовать в экспортных заявках
- fullNameEnglish No string No - Название на английском языке
- addressRegistrationEnglish No object No Same as addressRegistration Адрес регистрации на английском языке
- bankAccounts No array of object No Same as bankAccount Реквизиты банковского счета
- representative No object No - Подписант
- stampPath No string No - Путь к файлу с изображением штампа
+ status No enum (of string) No - Статус

- `ACTIVE`: Активен
- `INACTIVE`: Заблокирован

2.22.1. Property chat > order > subsidiary > id#
Type string
Required No
Format UUID

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

2.22.2. Property chat > order > subsidiary > subagent#
Type object
Required No
Additional properties Any type allowed

Description: Связанный субагент

2.22.3. Property chat > order > subsidiary > canUseInImport#
Type boolean
Required No

Description: Использовать в импортных заявках

2.22.4. Property chat > order > subsidiary > canUseInExport#
Type boolean
Required No

Description: Использовать в экспортных заявках

2.22.5. Property chat > order > subsidiary > fullNameEnglish#
Type string
Required No

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

2.22.6. Property chat > order > subsidiary > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistration

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

2.22.7. Property chat > order > subsidiary > bankAccounts#
Type array of object
Required No
Same definition as bankAccount

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

2.22.8. Property chat > order > subsidiary > representative#
Type object
Required No
Additional properties Any type allowed

Description: Подписант

Property Pattern Type Deprecated Definition Title/Description
- fioEnglish No object No In #/fio Subsidiary
- signPath No string No - Путь к файлу с изображением подписи
2.22.8.1. Property chat > order > subsidiary > representative > fioEnglish#

Title: Subsidiary
Type object
Required No
Additional properties Not allowed
Defined in #/fio

Description: ФИО на английском языке

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Идентификатор
- subagent No object No - Связанный субагент
- canUseInImport No boolean No - Использовать в импортных заявках
- canUseInExport No boolean No - Использовать в экспортных заявках
- fullNameEnglish No string No - Название на английском языке
- addressRegistrationEnglish No object No Same as addressRegistration Адрес регистрации на английском языке
- bankAccounts No array of object No Same as bankAccount Реквизиты банковского счета
- representative No object No - Подписант
- stampPath No string No - Путь к файлу с изображением штампа
+ status No enum (of string) No - Статус

- `ACTIVE`: Активен
- `INACTIVE`: Заблокирован
2.22.8.1.1. Property chat > order > subsidiary > representative > fioEnglish > id#
Type string
Required No
Format UUID

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

2.22.8.1.2. Property chat > order > subsidiary > representative > fioEnglish > subagent#
Type object
Required No
Additional properties Any type allowed

Description: Связанный субагент

2.22.8.1.3. Property chat > order > subsidiary > representative > fioEnglish > canUseInImport#
Type boolean
Required No

Description: Использовать в импортных заявках

2.22.8.1.4. Property chat > order > subsidiary > representative > fioEnglish > canUseInExport#
Type boolean
Required No

Description: Использовать в экспортных заявках

2.22.8.1.5. Property chat > order > subsidiary > representative > fioEnglish > fullNameEnglish#
Type string
Required No

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

2.22.8.1.6. Property chat > order > subsidiary > representative > fioEnglish > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistration

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

2.22.8.1.7. Property chat > order > subsidiary > representative > fioEnglish > bankAccounts#
Type array of object
Required No
Same definition as bankAccount

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

2.22.8.1.8. Property chat > order > subsidiary > representative > fioEnglish > representative#
Type object
Required No
Additional properties Any type allowed

Description: Подписант

Property Pattern Type Deprecated Definition Title/Description
- fioEnglish No object No Same as fioEnglish Subsidiary
- signPath No string No - Путь к файлу с изображением подписи
2.22.8.1.8.1. Property chat > order > subsidiary > representative > fioEnglish > representative > fioEnglish#

Title: Subsidiary
Type object
Required No
Additional properties Not allowed
Same definition as fioEnglish

Description: ФИО на английском языке

2.22.8.1.8.2. Property chat > order > subsidiary > representative > fioEnglish > representative > signPath#
Type string
Required No

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

2.22.8.1.9. Property chat > order > subsidiary > representative > fioEnglish > stampPath#
Type string
Required No

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

2.22.8.1.10. Property chat > order > subsidiary > representative > fioEnglish > status#
Type enum (of string)
Required Yes

Description: Статус

  • ACTIVE: Активен
  • INACTIVE: Заблокирован

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

2.22.8.2. Property chat > order > subsidiary > representative > signPath#
Type string
Required No

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

2.22.9. Property chat > order > subsidiary > stampPath#
Type string
Required No

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

2.22.10. Property chat > order > subsidiary > status#
Type enum (of string)
Required Yes

Description: Статус

  • ACTIVE: Активен
  • INACTIVE: Заблокирован

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

2.23. Property chat > order > subsidiaryBankAccount#
Type array of object
Required No
Same definition as bankAccount

Description: Счет плательщика

2.24. Property chat > order > preferredSubsidiary#
Type object
Required No
Additional properties Any type allowed

Description: Предпочитаемый плательщик

Property Pattern Type Deprecated Definition Title/Description
- isSpecified No boolean No - Указан Предпочитаемый плательщик
- country No string No Same as taxResidence Страна плательщика
- bank No object No In swift.schema.json Банк плательщика
- bankCountry No string No Same as taxResidence Страна банка плательщика
- comment No string No - Комментарий

2.24.1. Property chat > order > preferredSubsidiary > isSpecified#
Type boolean
Required No

Description: Указан Предпочитаемый плательщик

2.24.2. Property chat > order > preferredSubsidiary > country#
Type string
Required No
Same definition as taxResidence

Description: Страна плательщика

2.24.3. Property chat > order > preferredSubsidiary > bank#
Type object
Required No
Additional properties Any type allowed
Defined in swift.schema.json

Description: Банк плательщика

2.24.4. Property chat > order > preferredSubsidiary > bankCountry#
Type string
Required No
Same definition as taxResidence

Description: Страна банка плательщика

2.24.5. Property chat > order > preferredSubsidiary > comment#
Type string
Required No

Description: Комментарий

2.25. Property chat > order > counterparty#
Type object
Required Yes
Additional properties Any type allowed

Description: Информация о контрагенте

Property Pattern Type Deprecated Definition Title/Description
+ name No string No - Наименование
+ country No string No Same as taxResidence Страна
+ address No string No - Адрес
- website No string No - Веб-сайт

2.25.1. Property chat > order > counterparty > name#
Type string
Required Yes

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

Restrictions
Max length 50

2.25.2. Property chat > order > counterparty > country#
Type string
Required Yes
Same definition as taxResidence

Description: Страна

2.25.3. Property chat > order > counterparty > address#
Type string
Required Yes

Description: Адрес

2.25.4. Property chat > order > counterparty > website#
Type string
Required No

Description: Веб-сайт

2.26. Property chat > order > payment#
Type object
Required Yes
Additional properties Any type allowed

Description: Информация о платеже

Property Pattern Type Deprecated Definition Title/Description
+ currencyCounterparty No string No Same as currency Валюта платежа по заявке
+ currencyCustomer No string No Same as currency Валюта расчетов агента с клиентом
- exchangeRate No number No - Курс
- exchangeRateNotValidAfter No string No - Курс не действителен после
+ amountCounterparty No number No - Сумма входящего платежа контрагенту от агента или исходящего платежа от контрагента агенту, в валюте контрагента
- amountCustomer No number No - Сумма исходящего платежа клиента в сторону агента или входящего платежа агента в сторону клиента, в валюте клиента
+ bank No object No In swift.schema.json Банк контрагента
- bankCustomer No object No In bank.schema.json Bank
+ accountNumber No string No - Номер счета
+ purpose No string No - Назначение платежа
- paymentTerm No number No - Срок исполнения Поручения (рабочих дней)

2.26.1. Property chat > order > payment > currencyCounterparty#
Type string
Required Yes
Same definition as currency

Description: Валюта платежа по заявке

2.26.2. Property chat > order > payment > currencyCustomer#
Type string
Required Yes
Same definition as currency

Description: Валюта расчетов агента с клиентом

2.26.3. Property chat > order > payment > exchangeRate#
Type number
Required No

Description: Курс

2.26.4. Property chat > order > payment > exchangeRateNotValidAfter#
Type string
Required No
Format date-time

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

2.26.5. Property chat > order > payment > amountCounterparty#
Type number
Required Yes

Description: Сумма входящего платежа контрагенту от агента или исходящего платежа от контрагента агенту, в валюте контрагента

Restrictions
Multiple of 0.01
Minimum > 0

2.26.6. Property chat > order > payment > amountCustomer#
Type number
Required No

Description: Сумма исходящего платежа клиента в сторону агента или входящего платежа агента в сторону клиента, в валюте клиента

Restrictions
Multiple of 0.01
Minimum > 0

2.26.7. Property chat > order > payment > bank#
Type object
Required Yes
Additional properties Any type allowed
Defined in swift.schema.json

Description: Банк контрагента

2.26.8. Property chat > order > payment > bankCustomer#

Title: Bank
Type object
Required No
Additional properties Any type allowed
Defined in bank.schema.json

Description: Банк клиента

Property Pattern Type Deprecated Definition Title/Description
- bic No string No - БИК
- swift No string No - SWIFT
+ name No string No - Наименование
- englishName No string No - Наименование на английском
- accountNumber No string No - Номер счета
2.26.8.1. Property chat > order > payment > bankCustomer > bic#
Type string
Required No

Description: БИК

Restrictions
Min length 9
Max length 9
Must match regular expression ^\d{9}$ Test
2.26.8.2. Property chat > order > payment > bankCustomer > swift#
Type string
Required No

Description: SWIFT

2.26.8.3. Property chat > order > payment > bankCustomer > name#
Type string
Required Yes

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

2.26.8.4. Property chat > order > payment > bankCustomer > englishName#
Type string
Required No

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

2.26.8.5. Property chat > order > payment > bankCustomer > accountNumber#
Type string
Required No

Description: Номер счета

Restrictions
Max length 50

2.26.9. Property chat > order > payment > accountNumber#
Type string
Required Yes

Description: Номер счета

Restrictions
Max length 50

2.26.10. Property chat > order > payment > purpose#
Type string
Required Yes

Description: Назначение платежа

Restrictions
Max length 115

2.26.11. Property chat > order > payment > paymentTerm#
Type number
Required No

Description: Срок исполнения Поручения (рабочих дней)

2.27. Property chat > order > additionalInfo#
Type object
Required No
Additional properties Any type allowed

Description: Дополнительная информация

Property Pattern Type Deprecated Definition Title/Description
+ productType No enum (of string) No - Тип продукции или услуги
- productTypeOther No string No - Значение для выбранного типа продукции 'Другое'
- tnvedCode No string No - Код ТН ВЭД
+ documentDate No string No - Дата контракта или инвойса
+ documentNum No string No - Номер контракта или инвойса
- invoiceDate No string No - Дата инвойса
- invoiceNum No string No - Номер инвойса
- specification No string No - Cпецификация

2.27.1. Property chat > order > additionalInfo > productType#
Type enum (of string)
Required Yes

Description: Тип продукции или услуги

Must be one of: * "GOODS" * "TOOLS" * "SPARE PARTS" * "EQUIPMENT" * "SERVICES" * "PRODUCTS" * "MATERIALS" * "DEVICES" * "ELECTRONIC" * "CHEMICALS"

2.27.2. Property chat > order > additionalInfo > productTypeOther#
Type string
Required No

Description: Значение для выбранного типа продукции 'Другое'

2.27.3. Property chat > order > additionalInfo > tnvedCode#
Type string
Required No

Description: Код ТН ВЭД

2.27.4. Property chat > order > additionalInfo > documentDate#
Type string
Required Yes
Format date

Description: Дата контракта или инвойса

2.27.5. Property chat > order > additionalInfo > documentNum#
Type string
Required Yes

Description: Номер контракта или инвойса

2.27.6. Property chat > order > additionalInfo > invoiceDate#
Type string
Required No
Format date

Description: Дата инвойса

2.27.7. Property chat > order > additionalInfo > invoiceNum#
Type string
Required No

Description: Номер инвойса

2.27.8. Property chat > order > additionalInfo > specification#
Type string
Required No

Description: Cпецификация

2.28. Property chat > order > isBelowCost#
Type boolean
Required No

Description: Агентское вознаграждение ниже себестоимости

2.29. Property chat > order > commission#
Type object
Required No
Additional properties Any type allowed

Description: Агентское вознаграждение

Property Pattern Type Deprecated Definition Title/Description
+ percent No number No - Процент агентского вознаграждения
- percentCost No number No - Себестоимость субагента, сохраняется при заниженном проценте агентского вознаграждения
- amountCommissionCounterpartyCurrency No number No - Сумма агентского вознаграждения в валюте контрагента
- amountCommissionCustomerCurrency No number No - Сумма агентского вознаграждения в валюте клиента
- amountOperatingCostCounterpartyCurrency No number No - Сумма операционных расходов в валюте контрагента
- amountOperatingCostCustomerCurrency No number No - Сумма операционных расходов в валюте клиента
+ amountTotalCounterpartyCurrency No number No - Общая сумма агентского вознаграждения в валюте платежа по заявке
+ amountTotalCustomerCurrency No number No - Общая сумма агентского вознаграждения в валюте расчетов агента с клиентом
- paymentMethod No enum (of string) No - Способ оплаты комиссии: PART_PAYMENT - в составе платежа, SEPARATE_PAYMENT - отдельно от платежа

2.29.1. Property chat > order > commission > percent#
Type number
Required Yes

Description: Процент агентского вознаграждения

2.29.2. Property chat > order > commission > percentCost#
Type number
Required No

Description: Себестоимость субагента, сохраняется при заниженном проценте агентского вознаграждения

2.29.3. Property chat > order > commission > amountCommissionCounterpartyCurrency#
Type number
Required No

Description: Сумма агентского вознаграждения в валюте контрагента

2.29.4. Property chat > order > commission > amountCommissionCustomerCurrency#
Type number
Required No

Description: Сумма агентского вознаграждения в валюте клиента

2.29.5. Property chat > order > commission > amountOperatingCostCounterpartyCurrency#
Type number
Required No

Description: Сумма операционных расходов в валюте контрагента

2.29.6. Property chat > order > commission > amountOperatingCostCustomerCurrency#
Type number
Required No

Description: Сумма операционных расходов в валюте клиента

2.29.7. Property chat > order > commission > amountTotalCounterpartyCurrency#
Type number
Required Yes

Description: Общая сумма агентского вознаграждения в валюте платежа по заявке

2.29.8. Property chat > order > commission > amountTotalCustomerCurrency#
Type number
Required Yes

Description: Общая сумма агентского вознаграждения в валюте расчетов агента с клиентом

2.29.9. Property chat > order > commission > paymentMethod#
Type enum (of string)
Required No

Description: Способ оплаты комиссии: PART_PAYMENT - в составе платежа, SEPARATE_PAYMENT - отдельно от платежа

Must be one of: * "PART_PAYMENT" * "SEPARATE_PAYMENT"

2.30. Property chat > order > paymentOrder#
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
paymentOrder items -

2.30.1. chat > order > paymentOrder > paymentOrder items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ number No string No - Номер платежного поручения
+ date No string No - Дата платежного поручения
+ amount No number No - Сумма
2.30.1.1. Property chat > order > paymentOrder > paymentOrder items > number#
Type string
Required Yes

Description: Номер платежного поручения

2.30.1.2. Property chat > order > paymentOrder > paymentOrder items > date#
Type string
Required Yes
Format date

Description: Дата платежного поручения

2.30.1.3. Property chat > order > paymentOrder > paymentOrder items > amount#
Type number
Required Yes

Description: Сумма

2.31. Property chat > order > specification#
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
specification items -

2.31.1. chat > order > specification > specification items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- name No string No - наименование
- quantity No number No - Количество
- price No number No - Цена за единицу
+ amount No number No - Сумма
- createdAt No string No - Дата и время добавления строки
2.31.1.1. The following properties are required#
  • number
  • date
2.31.1.2. Property chat > order > specification > specification items > name#
Type string
Required No

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

2.31.1.3. Property chat > order > specification > specification items > quantity#
Type number
Required No

Description: Количество

2.31.1.4. Property chat > order > specification > specification items > price#
Type number
Required No

Description: Цена за единицу

2.31.1.5. Property chat > order > specification > specification items > amount#
Type number
Required Yes

Description: Сумма

2.31.1.6. Property chat > order > specification > specification items > createdAt#
Type string
Required No
Format datetime

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

3. Property chat > messages#
Type array
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
message.schema.json 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

3.1. chat > messages > message.schema.json#
Type object
Required No
Additional properties Any type allowed
Defined in message.schema.json

Description: 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

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