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

Order#

Title: Order
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 - -
+ 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 Same as Subsidiary Subsidiary
- subsidiaryBankAccount No array of object No Same as bankAccounts Счет плательщика
- 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 - Товары, услуги

1. Property Order > contract > id#
Type string
Required Yes
Format uuid

2. Property Order > contract > number#
Type string
Required No

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

3. Property Order > contract > date#
Type string
Required No
Format date

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

4. Property Order > contract > type#
Type enum (of string)
Required Yes

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

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

5. Property Order > contract > direction#
Type enum (of string)
Required No

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

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

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

6. Property Order > 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 Предыдущий статус клиента
- email No string No In common/_common.schema.json#/email E-mail клиента
+ partner No string No - Партнер
- signingType No enum (of string) No - Способ подписания документов

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

6.1. Property Order > contract > customer > id#
Type string
Required Yes
Format uuid

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

6.2. Property Order > contract > customer > createdBy#
Type string
Required No

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

6.3. Property Order > contract > customer > type#
Type enum (of string)
Required Yes

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

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

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

6.4. Property Order > 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 Order > contract > customer > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

6.6. Property Order > 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 Order > contract > customer > partner#
Type string
Required Yes

Description: Партнер

6.8. Property Order > contract > customer > signingType#
Type enum (of string)
Required No

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

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

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

6.9. Property Order > contract > customer > canRequestSubsidiary#
Type boolean
Required No

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

6.10. Property Order > 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 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 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 Order > contract > agent > id#
Type string
Required No
Format uuid

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

7.2. Property Order > contract > agent > customer#
Type object
Required No
Additional properties Any type allowed

7.3. Property Order > contract > agent > fullName#
Type string
Required No

Description: Название

7.4. Property Order > contract > agent > fullNameEnglish#
Type string
Required No

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

7.5. Property Order > contract > agent > inn#
Type string
Required No

Description: ИНН

7.6. Property Order > 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 Order > contract > agent > ogrn#
Type string
Required No

Description: ОГРН

7.8. Property Order > contract > agent > bankAccount#
Type array of object
Required No
Same definition as bankAccounts

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

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

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

7.10. Property Order > contract > agent > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

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

7.11. Property 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

7.12. Property Order > contract > agent > representative#
Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

7.13. Property Order > contract > agent > stampPath#
Type string
Required No

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

7.14. Property Order > contract > agent > additionalProperties#
Type object
Required No
Additional properties Any type allowed

7.15. Property Order > contract > agent > required#
Type object
Required No
Additional properties Any type allowed

7.16. Property Order > contract > agent > status#
Type enum (of string)
Required Yes

Description: Статус

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

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

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

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

8.1. Property Order > contract > canceledBy > id#
Type string
Required Yes
Format uuid

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

8.2. Property Order > contract > canceledBy > type#
Type enum (of string)
Required Yes

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

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

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

8.3. Property Order > contract > canceledBy > customer#

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

Description: Клиент

8.4. Property 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 ФИО

8.4.1. Property Order > contract > canceledBy > employee > fio#
Type object
Required Yes
Additional properties Not allowed
Same definition as fio

Description: ФИО

8.5. Property Order > contract > canceledBy > agent#

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

Description: Agent

8.6. Property Order > contract > canceledBy > email#
Type string
Required Yes
Same definition as email

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

8.7. Property Order > contract > canceledBy > phone#
Type string
Required Yes

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

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

8.8. Property Order > contract > canceledBy > role#
Type enum (of string)
Required Yes

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

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

8.9. Property Order > contract > canceledBy > status#
Type enum (of string)
Required Yes
Same definition as status

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

8.10. Property Order > contract > canceledBy > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

8.11. Property Order > 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 Order > contract > canceledBy > passwordMistakeCounter#
Type number
Required No

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

9. Property Order > contract > notApprovalComment#
Type string
Required No

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

10. Property Order > contract > userEmployee#

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

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

11. Property Order > contract > userCustomer#

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

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

12. Property Order > contract > createdAt#
Type string
Required No
Format datetime

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

13. Property Order > contract > changedAt#
Type string
Required No
Format datetime

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

14. Property Order > contract > notValidAfter#
Type string
Required No
Format date

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

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

15.1. 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 - Платежные поручения

15.1.1. Property Order > contract > files > File > id#
Type string
Required No
Format uuid

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

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

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

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

Description: Название

15.1.2.3. Property 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"

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

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

15.1.3. Property 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"

15.1.4. Property Order > contract > files > File > name#
Type string
Required Yes

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

15.1.5. Property Order > contract > files > File > path#
Type string
Required Yes

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

15.1.6. Property Order > contract > files > File > context#
Type string
Required No

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

15.1.7. Property Order > contract > files > File > status#
Type enum (of string)
Required Yes

Description: Статус

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

15.1.8. Property Order > contract > files > File > document#

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

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

15.1.9. Property Order > contract > files > File > isGenerated#
Type boolean
Required Yes

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

15.1.10. Property 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 -
15.1.10.1. 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 ФИО подписавшего
15.1.10.1.1. Property Order > contract > files > File > signature > signature items > operationId#
Type string
Required No

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

15.1.10.1.2. Property 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"

15.1.10.1.3. Property Order > 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 Order > 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 Order > contract > files > File > signature > signature items > signedAt#
Type string
Required Yes
Format date-time

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

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

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

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

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

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

Description: ИНН

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

Description: КПП

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

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

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

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

16. Property 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"

17. Property Order > submittedAt#
Type string
Required No
Format datetime

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

18. Property Order > verifiedAt#
Type string
Required No
Format datetime

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

19. Property 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 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 - Статус договора

19.1. Property Order > contract > id#
Type string
Required Yes
Format uuid

19.2. Property Order > contract > number#
Type string
Required No

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

19.3. Property Order > contract > date#
Type string
Required No
Format date

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

19.4. Property Order > contract > type#
Type enum (of string)
Required Yes

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

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

19.5. Property Order > contract > direction#
Type enum (of string)
Required No

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

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

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

19.6. Property Order > 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 Предыдущий статус клиента
- email No string No In common/_common.schema.json#/email E-mail клиента
+ partner No string No - Партнер
- signingType No enum (of string) No - Способ подписания документов

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

19.6.1. Property Order > contract > customer > id#
Type string
Required Yes
Format uuid

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

19.6.2. Property Order > contract > customer > createdBy#
Type string
Required No

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

19.6.3. Property Order > contract > customer > type#
Type enum (of string)
Required Yes

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

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

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

19.6.4. Property Order > contract > customer > status#
Type enum (of string)
Required Yes
Defined in common/_common.schema.json#/status

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

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

19.6.5. Property Order > contract > customer > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

19.6.6. Property Order > 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

19.6.7. Property Order > contract > customer > partner#
Type string
Required Yes

Description: Партнер

19.6.8. Property Order > contract > customer > signingType#
Type enum (of string)
Required No

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

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

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

19.6.9. Property Order > contract > customer > canRequestSubsidiary#
Type boolean
Required No

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

19.6.10. Property Order > 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

19.7. Property 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 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`: заблокированный агент

19.7.1. Property Order > contract > agent > id#
Type string
Required No
Format uuid

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

19.7.2. Property Order > contract > agent > customer#
Type object
Required No
Additional properties Any type allowed

19.7.3. Property Order > contract > agent > fullName#
Type string
Required No

Description: Название

19.7.4. Property Order > contract > agent > fullNameEnglish#
Type string
Required No

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

19.7.5. Property Order > contract > agent > inn#
Type string
Required No

Description: ИНН

19.7.6. Property Order > contract > agent > kpp#
Type string
Required No

Description: КПП

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

19.7.7. Property Order > contract > agent > ogrn#
Type string
Required No

Description: ОГРН

19.7.8. Property Order > contract > agent > bankAccount#
Type array of object
Required No
Same definition as bankAccounts

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

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

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

19.7.10. Property Order > contract > agent > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

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

19.7.11. Property 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

19.7.12. Property Order > contract > agent > representative#
Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

19.7.13. Property Order > contract > agent > stampPath#
Type string
Required No

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

19.7.14. Property Order > contract > agent > additionalProperties#
Type object
Required No
Additional properties Any type allowed

19.7.15. Property Order > contract > agent > required#
Type object
Required No
Additional properties Any type allowed

19.7.16. Property Order > contract > agent > status#
Type enum (of string)
Required Yes

Description: Статус

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

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

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

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

19.8.1. Property Order > contract > canceledBy > id#
Type string
Required Yes
Format uuid

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

19.8.2. Property Order > contract > canceledBy > type#
Type enum (of string)
Required Yes

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

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

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

19.8.3. Property Order > contract > canceledBy > customer#

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

Description: Клиент

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

Description: ФИО

19.8.5. Property Order > contract > canceledBy > agent#

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

Description: Agent

19.8.6. Property Order > contract > canceledBy > email#
Type string
Required Yes
Same definition as email

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

19.8.7. Property Order > contract > canceledBy > phone#
Type string
Required Yes

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

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

19.8.8. Property Order > contract > canceledBy > role#
Type enum (of string)
Required Yes

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

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

19.8.9. Property Order > contract > canceledBy > status#
Type enum (of string)
Required Yes
Same definition as status

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

19.8.10. Property Order > contract > canceledBy > statusPrevious#
Type enum (of string)
Required No
Same definition as status

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

19.8.11. Property Order > contract > canceledBy > statusReason#
Type enum (of string)
Required No

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

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

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

19.8.12. Property Order > contract > canceledBy > passwordMistakeCounter#
Type number
Required No

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

19.9. Property Order > contract > notApprovalComment#
Type string
Required No

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

19.10. Property Order > contract > userEmployee#

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

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

19.11. Property Order > contract > userCustomer#

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

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

19.12. Property Order > contract > createdAt#
Type string
Required No
Format datetime

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

19.13. Property Order > contract > changedAt#
Type string
Required No
Format datetime

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

19.14. Property Order > contract > notValidAfter#
Type string
Required No
Format date

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

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

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

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

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

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

19.15.1.2.2. Property Order > contract > files > File > template > name#
Type string
Required Yes
Format uuid

Description: Название

19.15.1.2.3. Property 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"

19.15.1.2.4. Property Order > contract > files > File > template > path#
Type string
Required Yes

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

19.15.1.3. Property 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"

19.15.1.4. Property Order > contract > files > File > name#
Type string
Required Yes

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

19.15.1.5. Property Order > contract > files > File > path#
Type string
Required Yes

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

19.15.1.6. Property Order > contract > files > File > context#
Type string
Required No

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

19.15.1.7. Property Order > contract > files > File > status#
Type enum (of string)
Required Yes

Description: Статус

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

19.15.1.8. Property Order > contract > files > File > document#

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

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

19.15.1.9. Property Order > contract > files > File > isGenerated#
Type boolean
Required Yes

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

19.15.1.10. Property 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 -
19.15.1.10.1. 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 ФИО подписавшего
19.15.1.10.1.1. Property Order > contract > files > File > signature > signature items > operationId#
Type string
Required No

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

19.15.1.10.1.2. Property 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"

19.15.1.10.1.3. Property Order > contract > files > File > signature > signature items > user#

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

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

19.15.1.10.1.4. Property Order > contract > files > File > signature > signature items > userRole#
Type enum (of string)
Required Yes

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

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

19.15.1.10.1.5. Property Order > contract > files > File > signature > signature items > signedAt#
Type string
Required Yes
Format date-time

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

19.15.1.10.1.6. Property Order > contract > files > File > signature > signature items > smsCode#
Type string
Required No

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

19.15.1.10.1.7. Property Order > contract > files > File > signature > signature items > phone#
Type string
Required No

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

19.15.1.10.1.8. Property Order > contract > files > File > signature > signature items > inn#
Type string
Required No

Description: ИНН

19.15.1.10.1.9. Property Order > contract > files > File > signature > signature items > kpp#
Type string
Required No

Description: КПП

19.15.1.10.1.10. Property Order > contract > files > File > signature > signature items > name#
Type string
Required No

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

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

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

19.16. Property Order > contract > form#
Type enum (of string)
Required No

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

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

19.17. Property 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"

20. Property Order > reportDate#
Type string
Required No
Format date

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

21. Property 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 - Связанные плательщики и получатели

21.1. Property Order > subagent > id#
Type string
Required No
Format UUID

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

21.2. Property Order > subagent > fullNameEnglish#
Type string
Required No

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

21.3. Property Order > subagent > status#
Type enum (of string)
Required Yes

Description: Статус

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

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

21.4. Property 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 -

21.4.1. Order > subagent > agents > agents items#
Type object
Required No
Additional properties Any type allowed

21.5. Property 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 -

21.5.1. 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 - Сумма лимита
21.5.1.1. Property 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
21.5.1.2. Property Order > subagent > limits > limits items > amount#
Type number
Required No

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

Restrictions
Multiple of 0.01
Minimum ≥ 0

21.6. Property 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 -

21.6.1. 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 - Размер себестоимости, указывается в %
21.6.1.1. Property Order > subagent > costs > costs items > currency#
Type string
Required No
Same definition as currency

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

21.6.1.2. Property Order > subagent > costs > costs items > minAmount#
Type number
Required No

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

Restrictions
Multiple of 0.01
Minimum ≥ 0
21.6.1.3. Property Order > subagent > costs > costs items > maxAmount#
Type number
Required No

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

Restrictions
Multiple of 0.01
Minimum ≥ 0
21.6.1.4. Property Order > subagent > costs > costs items > percent#
Type number
Required No

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

Restrictions
Multiple of 0.0001

21.7. Property 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 -

21.7.1. Order > subagent > subsidiaries > subsidiaries items#
Type object
Required No
Additional properties Any type allowed

22. Property Order > subsidiary#

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

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

23. Property Order > subsidiaryBankAccount#
Type array of object
Required No
Same definition as bankAccounts

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

24. Property 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 SWIFT
- bankCountry No string No Same as taxResidence Страна банка плательщика
- comment No string No - Комментарий

24.1. Property Order > preferredSubsidiary > isSpecified#
Type boolean
Required No

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

24.2. Property Order > preferredSubsidiary > country#
Type string
Required No
Same definition as taxResidence

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

24.3. Property Order > preferredSubsidiary > bank#

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

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

Property Pattern Type Deprecated Definition Title/Description
+ swift No string No - SWIFT
+ name No string No - Наименование
+ address No string No - Адрес
+ country No string No - Страна

24.3.1. Property Order > preferredSubsidiary > bank > swift#
Type string
Required Yes

Description: SWIFT

24.3.2. Property Order > preferredSubsidiary > bank > name#
Type string
Required Yes

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

24.3.3. Property Order > preferredSubsidiary > bank > address#
Type string
Required Yes

Description: Адрес

24.3.4. Property Order > preferredSubsidiary > bank > country#
Type string
Required Yes

Description: Страна

Restrictions
Max length 50

24.4. Property Order > preferredSubsidiary > bankCountry#
Type string
Required No
Same definition as taxResidence

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

24.5. Property Order > preferredSubsidiary > comment#
Type string
Required No

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

25. Property 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 - Веб-сайт

25.1. Property Order > counterparty > name#
Type string
Required Yes

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

Restrictions
Max length 50

25.2. Property Order > counterparty > country#
Type string
Required Yes
Same definition as taxResidence

Description: Страна

25.3. Property Order > counterparty > address#
Type string
Required Yes

Description: Адрес

25.4. Property Order > counterparty > website#
Type string
Required No

Description: Веб-сайт

26. Property 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 Same as bank SWIFT
- bankCustomer No object No In bank.schema.json Bank
+ accountNumber No string No - Номер счета
+ purpose No string No - Назначение платежа
- paymentTerm No number No - Срок исполнения Поручения (рабочих дней)

26.1. Property Order > payment > currencyCounterparty#
Type string
Required Yes
Same definition as currency

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

26.2. Property Order > payment > currencyCustomer#
Type string
Required Yes
Same definition as currency

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

26.3. Property Order > payment > exchangeRate#
Type number
Required No

Description: Курс

26.4. Property Order > payment > exchangeRateNotValidAfter#
Type string
Required No
Format date-time

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

26.5. Property Order > payment > amountCounterparty#
Type number
Required Yes

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

Restrictions
Multiple of 0.01
Minimum > 0

26.6. Property Order > payment > amountCustomer#
Type number
Required No

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

Restrictions
Multiple of 0.01
Minimum > 0

26.7. Property Order > payment > bank#

Title: SWIFT
Type object
Required Yes
Additional properties Any type allowed
Same definition as bank

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

26.8. Property 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 - Номер счета

26.8.1. Property Order > payment > bankCustomer > bic#
Type string
Required No

Description: БИК

Restrictions
Min length 9
Max length 9
Must match regular expression ^\d{9}$ Test

26.8.2. Property Order > payment > bankCustomer > swift#
Type string
Required No

Description: SWIFT

26.8.3. Property Order > payment > bankCustomer > name#
Type string
Required Yes

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

26.8.4. Property Order > payment > bankCustomer > englishName#
Type string
Required No

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

26.8.5. Property Order > payment > bankCustomer > accountNumber#
Type string
Required No

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

Restrictions
Max length 50

26.9. Property Order > payment > accountNumber#
Type string
Required Yes

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

Restrictions
Max length 50

26.10. Property Order > payment > purpose#
Type string
Required Yes

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

Restrictions
Max length 115

26.11. Property Order > payment > paymentTerm#
Type number
Required No

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

27. Property 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пецификация

27.1. Property 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"

27.2. Property Order > additionalInfo > productTypeOther#
Type string
Required No

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

27.3. Property Order > additionalInfo > tnvedCode#
Type string
Required No

Description: Код ТН ВЭД

27.4. Property Order > additionalInfo > documentDate#
Type string
Required Yes
Format date

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

27.5. Property Order > additionalInfo > documentNum#
Type string
Required Yes

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

27.6. Property Order > additionalInfo > invoiceDate#
Type string
Required No
Format date

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

27.7. Property Order > additionalInfo > invoiceNum#
Type string
Required No

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

27.8. Property Order > additionalInfo > specification#
Type string
Required No

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

28. Property Order > isBelowCost#
Type boolean
Required No

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

29. Property 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 - отдельно от платежа

29.1. Property Order > commission > percent#
Type number
Required Yes

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

29.2. Property Order > commission > percentCost#
Type number
Required No

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

29.3. Property Order > commission > amountCommissionCounterpartyCurrency#
Type number
Required No

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

29.4. Property Order > commission > amountCommissionCustomerCurrency#
Type number
Required No

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

29.5. Property Order > commission > amountOperatingCostCounterpartyCurrency#
Type number
Required No

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

29.6. Property Order > commission > amountOperatingCostCustomerCurrency#
Type number
Required No

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

29.7. Property Order > commission > amountTotalCounterpartyCurrency#
Type number
Required Yes

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

29.8. Property Order > commission > amountTotalCustomerCurrency#
Type number
Required Yes

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

29.9. Property Order > commission > paymentMethod#
Type enum (of string)
Required No

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

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

30. Property 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 -

30.1. 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 - Сумма

30.1.1. Property Order > paymentOrder > paymentOrder items > number#
Type string
Required Yes

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

30.1.2. Property Order > paymentOrder > paymentOrder items > date#
Type string
Required Yes
Format date

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

30.1.3. Property Order > paymentOrder > paymentOrder items > amount#
Type number
Required Yes

Description: Сумма

31. Property 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 -

31.1. 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 - Дата и время добавления строки

31.1.1. The following properties are required#

  • number
  • date

31.1.2. Property Order > specification > specification items > name#
Type string
Required No

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

31.1.3. Property Order > specification > specification items > quantity#
Type number
Required No

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

31.1.4. Property Order > specification > specification items > price#
Type number
Required No

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

31.1.5. Property Order > specification > specification items > amount#
Type number
Required Yes

Description: Сумма

31.1.6. Property Order > specification > specification items > createdAt#
Type string
Required No
Format datetime

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

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