Описание объектов допустимых значений
Ниже приведены описания объектов допустимых значений для использования при создании (редактировании) документов денежных операций.
ACCOUNTS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | accountType | string | |
| 2 | alias | string | |
| 3 | balance | decimal | Текущий баланс |
| 4 | cardNumber | string | |
| 5 | currency | string | Валюта |
| 6 | currencyDigital | long | |
| 7 | expirationDate | datetime | |
| 8 | externalCustomerId | string | |
| 9 | id | long | Идентификатор в Системе |
| 10 | number | string | Номер счета |
| 11 | plannedBalance | decimal | |
| 12 | type | string | |
| 13 | status | object | |
Object: account -> status
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | |
| 2 | code | string | |
| 3 | label | string | Локализованное наименование состояния |
| 4 | subCode | string | |
| 5 | subLabel | string | |
COMPANY_PERSONS -> [] -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | fullName | string | ФИО |
| 2 | id | long | Идентификатор в Системе |
| 3 | position | string | Должность |
| 4 | sign_level | string | Уровень права подписи |
CONSTRAINTS
Данный объект описывает ограничения валидации, накладываемые на отдельные атрибуты создаваемого/редактируемого документа или объект целиком.
| № | Поле | Тип данных | Примечание |
|---|
| 1 | constraints | object | Все атрибуты представлены объектами и имеют концептуально общую структуру. Каждый объект формируется динамически в зависимости от типа, создаваемого/редактируемого документа. |
| 2 | employeeConstraints | object | Все атрибуты представлены объектами и имеют концептуально общую структуру. Каждый объект формируется динамически в зависимости от типа, создаваемого/редактируемого документа. |
| 3 | globalConstraints | object | Все атрибуты представлены объектами и имеют концептуально общую структуру. Каждый объект формируется динамически в зависимости от типа, создаваемого/редактируемого документа. |
Object: общая структура
| № | Поле | Тип данных | Примечание |
|---|
| 1 | {attr} | array of objects | Содержит массив объектов с ограничениями для определенного атрибута или параметра. |
Object: определение ограничения
| № | Поле | Тип данных | Примечание |
|---|
| 1 | error | string | Локализованное сообщение об ошибке |
| 2 | isRequired | string | Уровень критичности |
| 3 | type | string | Тип ограничения для валидации |
| 4 | value | string | Критерий |
COUNTERPARTIES
| № | Поле | Тип данных | Примечание |
|---|
| 1 | accounts | array of object | Счета бенефициара |
| 2 | counterparty | object | Краткая информация по бенефициару |
Object: accounts -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | bankCode | string | Унифицированный код банка на территории РК. Пример: "BRKEKZKA" |
| 2 | bankId | long | Идентификатор банка в Системе |
| 3 | bankName | string | Наименование банка в Системе |
| 4 | counterpartyId | long | |
| 5 | iban | string | Счет бенефициара в банке |
| 6 | id | long | |
| 7 | iso | string | |
Object: counterparty
| № | Поле | Тип данных | Примечание |
|---|
| 1 | beneficiaryCode | string | КБЕ бенефициара |
| 2 | bin | string | БИН |
| 3 | customerId | long | |
| 4 | id | long | |
| 5 | internationalName | string | |
| 6 | isNational | boolean | |
| 7 | name | string | Наименование бенефициара |
CUSTOMER
| № | Поле | Тип данных | Примечание |
|---|
| 1 | fino | boolean | |
| 2 | id | long | Идентификатор в системе |
| 3 | intName | string | |
| 4 | intlAddress | string | |
| 5 | name | string | Наименование |
| 6 | residencyCode | string | |
| 7 | taxCode | string | |
KBE -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | category | string | Категория |
| 2 | code | string | Код |
| 3 | deleted | boolean | |
| 4 | externalId | string | |
| 5 | id | long | Идентификатор в системе |
| 6 | label | string | Локализованное наименование |
| 7 | nameKey | string | Ключ локализации |
| 8 | nameMap | string | |
KBK -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | category | string | Категория |
| 2 | code | string | Код |
| 3 | deleted | boolean | |
| 4 | externalId | string | |
| 5 | id | long | Идентификатор в системе |
| 6 | label | string | Локализованное наименование |
| 7 | nameKey | string | Ключ локализации |
| 8 | nameMap | string | |
KNP -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | category | string | Категория |
| 2 | code | string | Код |
| 3 | deleted | boolean | |
| 4 | externalId | string | |
| 5 | id | long | Идентификатор в системе |
| 6 | label | string | Локализованное наименование |
| 7 | nameKey | string | Ключ локализации |
| 8 | nameMap | string | |
KVO -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | code | string | Код |
| 2 | deleted | boolean | |
| 3 | id | long | Идентификатор в системе |
| 4 | knpExclude | string | |
| 5 | knpMatch | string | Ключ локализации |
| 6 | name | string | Локализованное наименование |
LOCAL_BANKS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | address | string | |
| 2 | bankCode | string | |
| 3 | bankName | string | Наименование |
| 4 | city | string | |
| 5 | corrBankAccount | string | |
| 6 | country | string | |
| 7 | countryId | long | |
| 8 | externalId | string | |
| 9 | id | long | Идентификатор в системе |
| 10 | internationalBankBik | string | |
| 11 | internationalBankName | string | |
| 12 | nationalBankBik | string | Унифицированный код банка на территории РК. Пример: "BRKEKZKA" |
| 13 | threeLetterCode | string | Трехзначный буквенный код |
| 14 | twoLetterCode | string | Двузначный буквенный код |
SUBSIDIARY_CUSTOMER -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | beneficiaryCode | string | КБЕ дочерней организации |
| 2 | customer | object | Головная компания |
| 3 | id | long | Идентификатор в Системе |
| 4 | name | string | Наименование дочерней организации |
| 5 | ownershipType | string | |
| 6 | taxCode | string | |
Object: customer
| № | Поле | Тип данных | Примечание |
|---|
| 1 | deleted | boolean | |
| 2 | externalId | string | |
| 3 | id | long | Идентификатор в Системе |
| 4 | organization | object | |
| 5 | personType | string | |
Object: organization
| № | Поле | Тип данных | Примечание |
|---|
| 1 | address | string | |
| 2 | bankBranch | object | |
| 3 | blocked | boolean | |
| 4 | city | string | |
| 5 | country | object | |
| 6 | created | date | |
| 7 | district | string | |
| 8 | docRegPlace | string | |
| 9 | fullName | string | |
| 10 | intlAddress | string | |
| 11 | intlCity | string | |
| 12 | intlDistrict | string | |
| 13 | intlName | string | |
| 14 | intlZip | string | |
| 15 | name | string | |
| 16 | ownership | string | |
| 17 | personAffiliated | string | |
| 18 | personDocumentNumber | string | |
| 19 | personDocumentType | string | |
| 20 | personReRegistrationDate | date | |
| 21 | personRegistrationCertificate | string | |
| 22 | region | string | |
| 23 | registered | date | |
| 24 | residencyAndEconomicCode | string | |
| 25 | taxCode | string | |
| 26 | zip | string | |
Object: country
| № | Поле | Тип данных | Примечание |
|---|
| 1 | countryCode | string | |
| 2 | countryName | string | |
| 3 | deleted | boolean | |
| 4 | externalId | string | |
| 5 | fullCountryName | string | |
| 6 | id | long | Идентификатор в Системе |
| 7 | threeLetterCode | string | |
| 8 | twoLetterCode | string | |
TEMPLATES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | templateName | string | Наименование шаблона |
MEDICAL_INSURANCE_CATEGORIES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | code | string | Код |
| 3 | category | string | |
| 4 | label | string | Расшифровка кода |
| 5 | deleted | boolean | |
SOCIAL_TRANSFER_CATEGORIES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | code | string | Код |
| 3 | category | string | |
| 4 | label | string | Расшифровка кода |
| 5 | deleted | boolean | |
EMPLOYEE_TRANSFER_CATEGORIES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | code | string | Код |
| 3 | category | string | |
| 4 | label | string | Расшифровка кода |
| 5 | deleted | boolean | |
BASIS_TAX_PAYMENTS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | category | string | |
| 3 | code | string | Код |
| 4 | externalId | string | |
| 5 | label | string | Расшифровка кода |
| 6 | nameKey | string | |
| 7 | nameMap | string | |
| 8 | deleted | boolean | |
COUNTRIES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | countryCode | string | Код |
| 3 | countryName | string | Название |
| 4 | fullCountryName | string | Полное локализованное название |
| 5 | threeLetterCode | string | |
| 6 | twoLetterCode | string | |
CURRENCY_OPERATION_TYPES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | category | string | |
| 3 | code | string | Код |
| 4 | externalId | string | |
| 5 | label | string | Расшифровка кода |
| 6 | nameKey | string | |
| 7 | nameMap | string | |
| 8 | deleted | boolean | |
FEE_ACCOUNTS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | accountType | string | |
| 2 | alias | string | |
| 3 | balance | decimal | Текущий баланс |
| 4 | cardNumber | string | |
| 5 | currency | string | Валюта |
| 6 | currencyDigital | long | |
| 7 | expirationDate | datetime | |
| 8 | externalCustomerId | string | |
| 9 | id | long | Идентификатор в Системе |
| 10 | number | string | Номер счета |
| 11 | plannedBalance | decimal | |
| 12 | type | string | |
| 13 | status | object | |
Object: account -> status
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | |
| 2 | code | string | |
| 3 | label | string | Локализованное наименование состояния |
| 4 | subCode | string | |
| 5 | subLabel | string | |
FEE_TYPES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | category | string | |
| 3 | code | string | Код |
| 4 | externalId | string | |
| 5 | label | string | Расшифровка кода |
| 6 | nameKey | string | |
| 7 | nameMap | string | |
| 8 | deleted | boolean | |
TAX_DOCUMENT_TYPES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | category | string | |
| 3 | code | string | Код |
| 4 | externalId | string | |
| 5 | label | string | Расшифровка кода |
| 6 | nameKey | string | |
| 7 | nameMap | string | |
| 8 | deleted | boolean | |
TRANSFER_RUB_CODE_OPERATIONS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | category | string | |
| 3 | code | string | Код |
| 4 | externalId | string | |
| 5 | label | string | Расшифровка кода |
| 6 | nameKey | string | |
| 7 | nameMap | string | |
| 8 | deleted | boolean | |
UPLOAD_CONSTRAINTS -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | fileTypes | array of strings | MIME |
| 2 | maxFilesSize | int | Максимальное количество |
COUNTRIES -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | id | long | Идентификатор в Системе |
| 2 | contractType | string | |
| 3 | code | string | Код |
| 4 | name | string | |
| 5 | operationType | string | |
| 6 | deleted | boolean | |
ActualSubject -> object
| № | Поле | Тип данных | Примечание |
|---|
| 1 | taxCode | string | ИИН/БИН |
| 2 | name | string | Наименование |