Платежное поручение со списком

Тип документа предназначен для перевода сумм списку сотрудников Компании-клиента. Выделяются следующие подтипы платежных поручений со списком:

1. Заработная плата
2. Обязательное социальное медицинское страхование
3. Пенсионное отчисление
4. Социальное отчисление

Получение допустимых значений для платежного поручения со списком. Подтип - Заработная плата (Payroll)

Не является обязательным к использованию. Предназначен для удобства использования API по созданию и редактированию документа.

endpoint	/api/payment/domestic-transfer/source-field
Параметры строки запроса / Query String Parameters	fieldList=ACCOUNTS%2CCOMPANY_PERSONS%2CCOUNTERPARTIES%2CKBE%2CLOCAL_BANKS%2CPAYMENT_DATES%2CKNP%2CPURPOSES%2CTEMPLATES%2CCONSTRAINTS%2CSUBSIDIARY_CUSTOMER%2CCUSTOMER%2CDOCUMENT_NUMBER
Параметры строки запроса / Query String Parameters	domesticTransferType=Payroll
Request method	GET
Response status	200

Примечание: разделитель для параметра fieldList – encoded - %2C; decoded – , (запятая).

Дополнительные заголовки / Additional headers

Content-Type	application/json

Ответ / Response object

!Важно: В таблице описания ответа в графе “Примечание” описано значение и приведен связанный атрибут отправляемого объекта при создании или редактировании документа. Описание структур объектов ответа приведено в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов

№	Поле	Тип данных	Примечание
1	ACCOUNTS	array of objects	Счета клиента национальной валюте (тенге). Соответствующий атрибут - account
2	COMPANY_PERSONS	array of arrays	Массив фиксированной длины = 2. Для первого элемента – список лиц с правом первой подписи. Соответствующий атрибут – director. Для первого элемента – список лиц с правом второй подписи. Соответствующий атрибут - accountant
3	CONSTRAINTS	object	Список параметров для валидации атрибутов отправляемого объекта при создании или редактирования документа
4	COUNTERPARTIES	array of objects	Список бенефициаров, которым ранее осуществлялись платежи
5	CUSTOMER	object	Данные Компании-клиента (customer)
6	DOCUMENT_NUMBER	string	Возможный следующий номер создаваемого документа
7	KBE	array of objects	КБЕ бенефициара. Соответствующий атрибут - benefResidencyCode
8	KNP	array of objects	КНП
9	LOCAL_BANKS	array of objects	Список банков РК
10	PURPOSES	array of strings	Список ранее используемых назначений платежа. Соответствующий атрибут – purpose
11	SUBSIDIARY_CUSTOMER	array of objects	Список дочерних организаций Компании-клиента
12	TEMPLATES	array of objects	Список шаблонов документа

Получение допустимых значений для платежного поручения со списком. Подтип - Обязательное социальное медицинское страхование (MedicalContribution)

Не является обязательным к использованию. Предназначен для удобства использования API по созданию и редактированию документа.

endpoint	/api/payment/domestic-transfer/source-field
Параметры строки запроса / Query String Parameters	fieldList=MEDICAL_INSURANCE_CATEGORIES%2CACCOUNTS%2CCOMPANY_PERSONS%2CPAYMENT_DATES%2CKNP%2CPURPOSES%2CTEMPLATES%2CCONSTRAINTS%2CSUBSIDIARY_CUSTOMER%2CCUSTOMER%2CDOCUMENT_NUMBER%2CMEDICAL_INSURANCE_COMPANY
Параметры строки запроса / Query String Parameters	domesticTransferType=MedicalContribution
Request method	GET
Response status	200

Примечание: разделитель для параметра fieldList – encoded - %2C; decoded – , (запятая).

Дополнительные заголовки / Additional headers

Content-Type	application/json

Ответ / Response object

!Важно: В таблице описания ответа в графе “Примечание” описано значение и приведен связанный атрибут отправляемого объекта при создании или редактировании документа. Описание структур объектов ответа приведено в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов допустимых значений далее в данном руководстве.

№	Поле	Тип данных	Примечание
1	ACCOUNTS	array of objects	Счета клиента национальной валюте (тенге). Соответствующий атрибут - account
2	COMPANY_PERSONS	array of arrays	Массив фиксированной длины = 2. Для первого элемента – список лиц с правом первой подписи. Соответствующий атрибут – director. Для первого элемента – список лиц с правом второй подписи. Соответствующий атрибут - accountant
3	CONSTRAINTS	object	Список параметров для валидации атрибутов отправляемого объекта при создании или редактирования документа
4	CUSTOMER	object	Данные Компании-клиента (customer)
5	DOCUMENT_NUMBER	string	Возможный следующий номер создаваемого документа
6	KNP	array of objects	КНП
7	MEDICAL_INSURANCE_CATEGORIES	array of objects	Категории медицинского страхования. Соответствующий атрибут –employeeTransferCategory = code
8	PURPOSES	array of strings	Список ранее используемых назначений платежа. Соответствующий атрибут – purpose
9	SUBSIDIARY_CUSTOMER	array of objects	Список дочерних организаций Компании-клиента
10	TEMPLATES	array of objects	Список шаблонов документа

Получение допустимых значений для платежного поручения со списком. Подтип - Социальное отчисление (SocialContribution)

Не является обязательным к использованию. Предназначен для удобства использования API по созданию и редактированию документа.

endpoint	/api/payment/domestic-transfer/source-field
Параметры строки запроса / Query String Parameters	fieldList=ACCOUNTS%2CCOMPANY_PERSONS%2CPAYMENT_DATES%2CKNP%2CPURPOSES%2CTEMPLATES%2CCONSTRAINTS%2CSOCIAL_TRANSFER_CATEGORIES%2CSUBSIDIARY_CUSTOMER%2CCUSTOMER%2CDOCUMENT_NUMBER%2CSOCIAL_COMPANY
Параметры строки запроса / Query String Parameters	domesticTransferType=SocialContribution
Request method	GET
Response status	200

Примечание: разделитель для параметра fieldList – encoded - %2C; decoded – , (запятая).

Дополнительные заголовки / Additional headers

Content-Type	application/json

Ответ / Response object

!Важно: В таблице описания ответа в графе “Примечание” описано значение и приведен связанный атрибут отправляемого объекта при создании или редактировании документа. Описание структур объектов ответа приведено в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов допустимых значений далее в данном руководстве.

№	Поле	Тип данных	Примечание
1	ACCOUNTS	array of objects	Счета клиента национальной валюте (тенге). Соответствующий атрибут - account
2	COMPANY_PERSONS	array of arrays	Массив фиксированной длины = 2. Для первого элемента – список лиц с правом первой подписи. Соответствующий атрибут – director. Для первого элемента – список лиц с правом второй подписи. Соответствующий атрибут - accountant
3	CONSTRAINTS	object	Список параметров для валидации атрибутов отправляемого объекта при создании или редактирования документа
4	CUSTOMER	object	Данные Компании-клиента (customer)
5	DOCUMENT_NUMBER	string	Возможный следующий номер создаваемого документа
6	KNP	array of objects	КНП
7	PURPOSES	array of strings	Список ранее используемых назначений платежа. Соответствующий атрибут – purpose
8	SOCIAL_TRANSFER_CATEGORIES	array of objects	Социальные категории. Соответствующий атрибут –employeeTransferCategory = code
9	SUBSIDIARY_CUSTOMER	array of objects	Список дочерних организаций Компании-клиента
10	TEMPLATES	array of objects	Список шаблонов документа

Получение допустимых значений для платежного поручения со списком. Подтип - Пенсионное отчисление (PensionContribution)

Не является обязательным к использованию. Предназначен для удобства использования API по созданию и редактированию документа.

endpoint	/api/payment/domestic-transfer/source-field
Параметры строки запроса / Query String Parameters	fieldList=ACCOUNTS%2CCOMPANY_PERSONS%2CPAYMENT_DATES%2CKNP%2CPURPOSES%2CEMPLOYEE_TRANSFER_CATEGORIES%2CTEMPLATES%2CCONSTRAINTS%2CSUBSIDIARY_CUSTOMER%2CCUSTOMER%2CDOCUMENT_NUMBER%2CPENSION_COMPANY
Параметры строки запроса / Query String Parameters	domesticTransferType=PensionContribution
Request method	GET
Response status	200

Примечание: разделитель для параметра fieldList – encoded - %2C; decoded – , (запятая).

Дополнительные заголовки / Additional headers

Content-Type	application/json

Ответ / Response object

!Важно: В таблице описания ответа в графе “Примечание” описано значение и приведен связанный атрибут отправляемого объекта при создании или редактировании документа. Описание структур объектов ответа приведено в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание объектов допустимых значений далее в данном руководстве.

№	Поле	Тип данных	Примечание
1	ACCOUNTS	array of objects	Счета клиента национальной валюте (тенге). Соответствующий атрибут - account
2	COMPANY_PERSONS	array of arrays	Массив фиксированной длины = 2. Для первого элемента – список лиц с правом первой подписи. Соответствующий атрибут – director. Для первого элемента – список лиц с правом второй подписи. Соответствующий атрибут - accountant
3	CONSTRAINTS	object	Список параметров для валидации атрибутов отправляемого объекта при создании или редактирования документа
4	CUSTOMER	object	Данные Компании-клиента (customer)
5	DOCUMENT_NUMBER	string	Возможный следующий номер создаваемого документа
6	EMPLOYEE_TRANSFER_CATEGORIES	array of objects	Категории пенсионных отчислений. Соответствующий атрибут –employeeTransferCategory = code
7	KNP	array of objects	КНП
8	PURPOSES	array of strings	Список ранее используемых назначений платежа. Соответствующий атрибут – purpose
9	SUBSIDIARY_CUSTOMER	array of objects	Список дочерних организаций Компании-клиента
10	TEMPLATES	array of objects	Список шаблонов документа

Создание платежного поручения со списком

endpoint	/api/payment/domestic-transfer/new
Request method	POST
Response status	200

Дополнительные заголовки / Additional headers

Content-Type	application/json

Тело запроса / Body

!ВАЖНО: в примечаниях постоянные значения в рамках текущего запроса выделяются цветом.

№	Поле	Тип данных	Является обязательным	Примечание
1	account	object	Да	AccountShortView – описание в таблице далее
2	amount	decimal	Да	Сумма перевода. Формат – "########.##"
3	valueDate	date	Да	Дата документа. Формат - "dd.MM.yyyy"
4	purpose	string	Да	Назначение
5	purposeCode	string	Да	Код КНП
6	purposeText	string	Да	Составное назначение платежа.  purpose + КНП
7	priority	boolean	Да	Срочный платеж (false)
8	number	string	Да	Номер платежного документа. Не более 9 знаков.
9	isTemplate	boolean	Да	false
10	director	object	Да	CustomerUserShortView – описание в таблице далее
11	accountant	object	Да	CustomerUserShortView – описание в таблице далее
12	benefName	string	Да	Наименование бенефициара
13	benefTaxCode	string	Да	БИН бенефициара
14	benefAccount	string	Да	Счет бенефициара
15	benefBankCode	string	Да	Код банка бенефициара
16	benefResidencyCode	string	Да	Код резидента бенефициара
17	domesticTransferType	string	Да	"PaymentOrder" – подтип документа
18	employees	array of objects	Да	Список сотрудников для Платежных поручений со списком. TransferEmployeeView – описание в таблице далее
19	isLoanPay	boolean	Да	За счет кредитных средств
20	isRaw	boolean	Да	Признак для черновика (false)
21	senderResidencyCountryCode	string	Да	Страна резидентства отправителя в двузначном варианте
22	actualSender	object	Нет	Фактический отправитель
23	vat	decimal		Сумма НДС. Формат – "########.##"
24	budgetCode	number
25	vinCode	long		null
26	isNotNeedUnc	boolean	Да	false
27	isNotLinkTerrorism	boolean	Да	true
28	isPermitGiveInformation	boolean	Да	false
29	isSubsidiaryOrganization	boolean	Да	false
30	numberOfAdministrativeAffairs	string		""
31	kvo	string	Да	Код валютной операции
32	customPaymentData	object
33	custTaxCode	string
34	benefResidencyCountryCode	string	Да	Страна резидентства получателя в двузначном варианте
35	actualBeneficiary	object	Нет	Фактический получатель
36	templateName	string		null

Object: account (AccountShortView)

№	Поле	Тип данных	Является обязательным	Примечание
1	id	long	Да	Идентификатор в Системе
2	number	string	Да	Номер счета
3	cardNumber	string
4	currency	string		Валюта
5	currencyDigital	long
6	balance	decimal		Текущий баланс
7	plannedBalance	decimal
8	alias	string
9	externalCustomerId	string
10	type	string
11	accountType	string
12	expirationDate	datetime
13	status	object		CodeDto – описание в таблице в разделе ДЕНЕЖНЫЕ ОПЕРАЦИИ > Описание базового объекта (PaymentView)
14	gk

Object: director, account (CustomerUserShortView)

№	Поле	Тип данных	Является обязательным	Примечание
1	id	long	Да	Идентификатор в Системе
2	fullName	string	Да	ФИО
3	position	string		Должность
4	sign_level	string	Да	Уровень права подписи

Object: employees -> object (TransferEmployeeView)

№	Поле	Тип данных	Является обязательным	Примечание
1	firstName	string	Да	Имя
2	lastName	string	Да	Фамилия
3	amount	decimal	Да	Сумм к перечислению
4	middleName	string		Отчество
5	taxCode	string	Да	ИИН
6	account	string		Счет
7	birthDate	date	Да	Дата рождения. Формат - "dd.MM.yyyy"
8	residencyCountryCode	string	Да, если зарплатное отчисление, иначе нет	Страна резидентства сотрудника в двузначном варианте
9	id	long		Идентификатор в Системе
10	deleted	boolean
11	reason	string
12	period	date		В данном случае всегда - null. Месяц, за который производится отчисление. Формат - "MM.yyyy"
13	deductionType	string

Object: actualSender, actualBeneficiary (ActualSubject)

№	Поле	Тип данных	Является обязательным	Примечание
1	taxCode	string	Да	ИИН/БИН
2	name	string	Да	Наименование

Ответ / Response object

№	Поле	Тип данных	Примечание
1	value	long	Идентификатор созданного в Системе документа id

Пример запроса

curl --location 'https://api-test.business-t.berekebank.kz/api/payment/domestic-transfer/new' \ --header 'Authorization: ...' \ --data '{ "account": { "id": 00, "number": "KZ00000000000CH00000", "cardNumber": null, "currency": "CHF", "currencyDigital": null, "balance": 0, "plannedBalance": 0, "alias": "Текущий счет АО Test Test", "externalCustomerId": null, "type": null, "accountType": "Current", "expirationDate": null, "status": { "id": null, "code": "1", "label": "Открыт", "subCode": "1", "subLabel": "Открыт" }, "gk": 2203 }, "amount": "111111", "valueDate": "18.02.2025", "purpose": "Прочие безвозмездные переводы денег,в том числе:безвозвратная финансовая (материальная, спонсорская) помощь для прочих целей (кроме оплаты лечения и обучения)денежные переводы физических лиц (в том числе без открытия банковского счета) для дальнейшего использования денег бенефициаром для прочих целей (кроме оплаты лечения и обучения)возмещение ущерба, в том числе по решению судагранты (в том числе выигранные по тендеру)неустойка (штрафы, пени) за невыполнение обязательств по аккредитиву, договор", "purposeCode": "11", "purposeText": "Прочие безвозмездные переводы денег,в том числе:безвозвратная финансовая (материальная, спонсорская) помощь для прочих целей (кроме оплаты лечения и обучения)денежные переводы физических лиц (в том числе без открытия банковского счета) для дальнейшего использования денег бенефициаром для прочих целей (кроме оплаты лечения и обучения)возмещение ущерба, в том числе по решению судагранты (в том числе выигранные по тендеру)неустойка (штрафы, пени) за невыполнение обязательств по аккредитиву, договор", "priority": false, "number": "111", "isTemplate": false, "director": { "id": 111111, "fullName": "Test", "position": null, "sign_level": "A" }, "accountant": { "id": 111111, "fullName": "Test Test", "position": null, "sign_level": "A" }, "benefName": "Товарищество с ограниченной отвественностью О\"TEST\"", "benefTaxCode": "111111111111", "benefAccount": "KZ1111111111111111111", "benefBankCode": "KCJBKZKX", "benefResidencyCode": "17", "domesticTransferType": "Payroll", "employees": [ { "firstName": "TEST", "lastName": "TEST", "amount": "111111", "middleName": "TEST", "taxCode": "111111111111", "account": "KZ11111CP11111111111", "birthDate": "01.08.1997", "residencyCountryCode": "KZ" }, { "firstName": "Test", "lastName": "test", "amount": "222222", "middleName": "TEST", "taxCode": "111111311111", "account": "KZ1111CP11111111111", "birthDate": "01.01.1976", "residencyCountryCode": "KZ" } ], "isLoanPay": false, "isRaw": false, "senderResidencyCountryCode": "KZ", "actualSender": null }'

Пример ответа

{ "lastName" : "Фамилию можно пропустить, создаем документ!", "value" : 11111111 }

Редактирование платежного поручения списком

Редактирование платежного поручения доступно только для документов с активным статусом Черновик (Raw) или Новый (Draft).

endpoint	/api/payment/domestic-transfer/{id}
Request method	POST
Response status	200

Примечание: id – идентификатор созданного в Системе документа.

Дополнительные заголовки / Additional headers

Content-Type	application/json

Тело запроса / Body

Смотреть Создание платежного поручения со списком > Тело запроса / Body

Ответ / Response object

№	Поле	Тип данных	Примечание
1	value	long	Идентификатор отредактированного в Системе документа id

Пример запроса

curl --location 'https://api-test.business-t.berekebank.kz/api/payment/domestic-transfer/1111111' \ --header 'Authorization: ...' \ --data '{ "account": { "id": 11, "number": "KZ11111111111CH1111", "cardNumber": "KZ11111111111CH11111", "currency": "CHF", "currencyDigital": null, "balance": 0, "plannedBalance": 0, "alias": "Текущий счет test ", "externalCustomerId": null, "type": null, "accountType": "Current", "expirationDate": null, "status": null, "gk": 1111 }, "amount": "111111", "valueDate": "18.02.2025", "purpose": "Размещение условных вкладов", "purposeCode": "319", "purposeText": "Размещение условных вкладов", "priority": false, "number": "674", "isTemplate": false, "templateName": null, "director": { "id": 495182, "fullName": "Test", "position": null, "sign_level": "B" }, "accountant": { "id": 11, "fullName": "Test", "position": null, "sign_level": "B" }, "info": null, "benefName": "Товарищество с ограниченной отвественностью О\"test\"", "benefTaxCode": "111111111111", "benefAccount": "KZ11111111111111111", "benefBankCode": "KCJBKZKX", "benefResidencyCode": "17", "domesticTransferType": "Payroll", "employees": [ { "id": 111111111111, "deleted": false, "firstName": "test", "lastName": "test", "middleName": "test", "amount": "222222", "amountOPVR": null, "account": "KZ11111CP11111111111", "taxCode": "111111111111", "birthDate": "01.01.1976", "reason": null, "period": null, "deductionType": null, "residencyCountryCode": "KZ" }, { "id": 111111111111, "deleted": false, "firstName": "test", "lastName": "test", "middleName": "test", "amount": "111111", "amountOPVR": null, "account": "KZ11111CP11111111111", "taxCode": "11111111111", "birthDate": "01.08.1997", "reason": null, "period": null, "deductionType": null, "residencyCountryCode": "KZ" } ], "isLoanPay": false, "isRaw": false, "isSubsidiaryOrganization": false, "subsidiaryOrganizationId": null, "senderResidencyCountryCode": "KZ", "actualSender": null }'

Пример ответа

{ "lastName" : "Фамилию можно пропустить, создаем документ!", "value" : 11111111 }