/fintech/api/v1/payrolls
Запрос позволяет создать зарплатную ведомость для осуществления выплаты в рамках зарплатного проекта. Отправьте POST-запрос /fintech/api/v1/payrolls
с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами зарплатной ведомости в теле запроса.
В параметре scope ссылки авторизации пользователя должен быть указан сервис PAYROLL
для получения доступа к этому ресурсу.
Если в запросе на создание платежного документа передать ЭП к документу (объект digestSignatures), то Банк сразу начнет его обработку.
Если в запросе не передавать ЭП к документу, то документ будет создан в статусе черновик. Для начала его обработки Банком потребуется зайти в интерфейс СберБизнес и подписать его.
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443
- Промышленный контур
https://fintech.sberbank.ru:9443
Request
- Модель
- Пример
Наименование | Тип | Формат | Regexp | Обязательность | Описание |
---|---|---|---|---|---|
HEADER | |||||
Authorization | string | string | ^[a-zA-Z0-9]38$ | required | Access token пользователя, полученный через SSO. |
Accept | string | string | ^(application/json|application/jose) | optional | Указывает на формат данных, который вы готовы принять от Банка. Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose. |
BODY | |||||
Payroll { | |||||
account | string | string | ^[0-9]20$ | required/optional | Номер счета для выплаты денежных средств в рамках зарплатной ведомости. - Если выплата осуществляется по договору с резервированием (атрибут isReserve имеет значение true в запросе /fintech/api/v1/salary-agreements ), то это поле обязательно необходимо заполнить.- Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements ) и со счета в СберБанке, то это поле обязательно необходимо заполнить.- Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements ) и со счета в другом банке, то заполнять это поле не требуется. Потребуется заполнить массив объектов payDocs. |
admissionValue | string | string | ^[0-9]2$ | required | Вид зачисления. Указывается один вид зачисления на всю зарплатную вед омость. Если, к примеру, требуется осуществить выплату заработной платы для сотрудников компании и выплату в пользу самозанятых, вам потребуется создать 2 разных платежных документа. Доступный перечень видов зачисления по вашему договору содержится в ответе запроса /fintech/api/v1/salary-agreements в атрибуте admissionCode, |
amount | AmountCurrency | object | required | Итоговая сумма зачисления, | |
authPersonName | string | string | ^[a-zA-Z0-9. _ -]60$ | optional | ФИО уполномоченного сотрудника организации пользователя, |
authPersonTelfax | string | string | ^[a-zA-Z0-9. _ -]40$ | optional | Номер телефона, факса уполномоченного сотрудника организации пользователя, |
bic | string | string | ^[0-9]9$ | required | БИК банка пользователя, |
contractDate | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | required | Дата договора. Необходимо использовать значение атрибута contractStartDate, полученное из запроса /fintech/api/v1/salary-agreements , |
contractNumber | string | string | ^[a-zA-Z0-9. _ -]255$ | required | Номер договора. Необходимо использовать значение атрибута contractNumber, полученное из запроса /fintech/api/v1/salary-agreements , |
date | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | required | Дата составления документа, |
digestSignatures | array[Signature] | array | optional | Электронные подписи по дайджесту документа. - Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. - Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес. О подписании дайджеста платежного документа подробно рассказали в соответствующем разделе документации. | |
employeeSalaries | array[PayrollEmpSalary] | array | optional | Данные сотрудников для зачисления выплаты | |
employeesNumber | integer | integer | ^[0-9]$ | required | Количество сотрудников, |
externalId | string | UUID | ^[0-9a-f]8-[0-9a-f]4-[0-9a-f]4-[0-9a-f]4-[0-9a-f]12$ | required | Идентификатор документа, который вы присваиваете самостоятельно, |
incomeTypeCode | string | string | ^(1|2|3|4|5)$ | optional | Код вида дохода получателей выплаты по 229-ФЗ. Коды: 1 - Заработная плата и иные доходы, в отношении которых ст. 99 229-ФЗ установлены ограничения размеров удержания. 2 - Периодические доходы, на которые в соответствии с ч. 1 ст. 101 229-ФЗ не может быть обращено взыскание, за исключением доходов, указанных в ч. 2 ст. 101 229-ФЗ. 3 - Периодические доходы, к которым согласно ч. 2 ст. 101 229-ФЗ ограничения по взысканию не применяются. 4 - Единовременный доход, на который в соответствии с ч. 1 ст. 101 229-ФЗ не может быть обращено взыскание, за исключением доходов, указанных в ч. 2 ст. 101 229-ФЗ. 5 - Единовременный доход, к которому согласно ч. 2 ст. 101 229-ФЗ ограничения по взысканию не применяются. null - Код дохода указывать не нужно, если денежные средства не относятся к доходам с установленными ограничениями согласно ст. 99 и запретом согласно ст. 101 229-ФЗ, |
loanAmount | AmountCurrency | object | optional | Сумма оплаты за счет кредитных средств. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanDate и loanNumber, | |
loanDate | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | optional | Дата кредитного договора. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanAmount и loanNumber, |
loanNumber | string | string | ^[a-zA-Z0-9. _ -]50$ | optional | Номер кредитного договора. При заполнении данного атрибута обязательно требуется заполнить атрибуты loanDate и loanAmount, |
month | string | string | ^[0-9]2$ | required | Месяц отчетного периода, |
number | string | string | ^[a-zA-Z0-9. _ -]50$ | optional | Номер документа, |
orgName | string | string | ^[a-zA-Z0-9. _ -]160$ | required | Наименование организации пользователя, |
orgTaxNumber | string | string | ^([0-9]10|[0-9]12)$ | required | ИНН организации пользователя |
payDocs | array[PayrollPayDoc] | array | required/optional | Данные платежных поручений по вашим счетам из других банков. - Если выплата осуществляется по договору с резервированием (атрибут isReserve имеет значение true в запросе /fintech/api/v1/salary-agreements ), то заполнять объект не требуется.- Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements ) и со счета в СберБанке, то заполнять объект не требуется.- Если выплата осуществляется по договору без резервирования (атрибут isReserve имеет значение false в запросе /fintech/api/v1/salary-agreements ) и со счета в другом банке, то объект обязательно необходимо заполнить, | |
year | string | YYYY | ^[0-9]4$ | required | Год отчетного периода |
} | |||||
AmountCurrency { | |||||
amount | number | number | ^[0-9]16\.[0-9]2$ | required | Сумма, |
currencyCode | string | ОКВ | ^[0-9]3$ | required | Цифровой код валюты, |
currencyName | string | ISO 4217 | ^[A-Z]3$ | required | Буквенный ISO-код валюты |
} | |||||
Signature { | |||||
base64Encoded | string | base64 | ^[a-zA-Z0-9]+$ | required | Значение электронной подписи (ЭП), закодированное в Base64. |
certificateuuid | string | UUID | ^[0-9a-f]8-[0-9a-f]4-[0-9a-f]4-[0-9a-f]4-[0-9a-f]12$ | required | Уникальный идентификатор сертификата ключа проверки электронной подписи |
} | |||||
PayrollEmpSalary { | |||||
account | string | string | ^[0-9]20$ | required | Номер счета сотрудника, |
amount | AmountCurrency | object | required | Сумма начисления, | |
bic | string | string | ^[0-9]9$ | optional | БИК банка сотрудника. Заполняется в случае, если счет сотрудника открыт не в СберБанке, |
firstName | string | string | ^[a-zA-Zа-яА-ЯеЁ]1024$ | required | Имя |
withheldAmount | number | number | ^[0-9]16\.[0-9]2$ | optional | Сумма удержанных средств по исполнительному документу, |
lastName | string | string | ^[a-zA-Zа-яА-ЯеЁ]1024$ | required | Фамилия, |
middleName | string | string | ^[a-zA-Zа-яА-ЯеЁ]1024$ | optional | Отчество, |
} | |||||
PayrollPayDoc { | |||||
amount | AmountCurrency | object | required | Сумма начисления. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, | |
docDate | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | required | Дата расчетного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выпл аты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
number | string | string | ^[0-9]6$ | required | Номер расчетного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
payeeAccount | string | string | ^[0-9]20$ | required | Номер счета получателя. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
payeeBic | string | string | ^[0-9]9$ | required | БИК банка получателя. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
payerAccount | string | string | ^[0-9]20$ | required | Номер счета плательщика. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода дене жных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
payerBic | string | string | ^[0-9]9$ | required | БИК банка плательщика. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке, |
purpose | string | string | ^[a-zA-Z0-9. _ -]212$ | required | Назначение платежного документа. Данные должны быть взяты из платежного поручения. Это платежное поручение для перевода денежных средств для выплаты по зарплатной ведомости со счета в другом банке на счет в Сбербанке |
} |
POST /fintech/api/v1/payrolls HTTP/1.1
Accept: application/json
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678
{
"account": "40802810600000200000",
"admissionValue": "01",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "8(495)1234567",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateuuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeSalaries": [
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"bic": "044525225",
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"withheldAmount": 1.01
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "1",
"loanAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"loanDate": "2018-12-31",
"loanNumber": "1234567890",
"month": "Январь",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893",
"payDocs": [
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
],
"year": "2019"
}