Создание зарплатной ведомости

Обновлено 20 февраля 2025

POST

/v1/payrolls

Запрос для создания зарплатной ведомости для выплат в рамках зарплатного проекта. Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами зарплатной ведомости в теле запроса.

Для доступа к этому методу в параметре scope ссылки авторизации должно быть указано значение PAYROLL.

Если в запросе на создание платежного документа передать ЭП к документу (объект digestSignatures), то Банк сразу начнет его обработку. Если в запросе не передавать ЭП к документу, то документ будет создан в статусе черновик. Для начала его обработки Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Request {#request}

Header Parameters

Authorization
string
required
Access token организации-клиента, полученный через SSO
Example: f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

• application/json

Body

required

date

date

required

Дата составления документа

digestSignatures object[]
Электронные подписи по дайджесту документа
Array [
base64Encoded
string
required
Значение электронной подписи, закодированное в Base64
certificateUuid
uuid
required
Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
]
number

string

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

account

string

Возможные значения: Value must match regular expression ^[0-9]{20}$

Номер счета клиента

admissionValue

string

required

Возможные значения: Value must match regular expression ^[0-9]{2}$

Вид зачисления

amount objectrequired

Итоговая сумма зачисления

amount

number

required

Сумма

currencyCode

string

required

Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$

Цифровой код валюты

currencyName

string

required

Возможные значения: Value must match regular expression ^[A-Z]{3}$

Буквенный ISO-код валюты

authPersonName

string

Возможные значения: <= 60 characters

ФИО уполномоченного сотрудника организации клиента

authPersonTelfax

string

Возможные значения: <= 40 characters

Номер телефона, факса уполномоченного сотрудника организации клиента

bic

string

required

Возможные значения: Value must match regular expression ^[0-9]{9}$

БИК банка клиента

contractDate

date

required

Дата договора

contractNumber

string

required

Номер договора

employeeSalaries PayrollEmpSalary[]required
Possible values: >= 1
Сотрудники, которым зачисляют зарплату
Array [
account
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета сотрудника
amount objectrequired
Сумма начисления
amount
number
required
Сумма
currencyCode
string
required
Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$
Цифровой код валюты
currencyName
string
required
Возможные значения: Value must match regular expression ^[A-Z]{3}$
Буквенный ISO-код валюты
bic
string
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка сотрудника
firstName
string
required
Имя
lastName
string
required
Фамилия
middleName
string
Отчество
withheldAmount
number
Сумма удержанных средств по исполнительному документу
]
employeesNumber

int32

required

Количество сотрудников

externalId

uuid

required

Идентификатор документа, присвоенный сервисом (UUID)

incomeTypeCode

string

Возможные значения: Value must match regular expression ^([1-9]{1}|[1-9]{1}[0-9]{1})$

Код вида дохода получателей выплаты по 229-ФЗ

loanAmount object

Сумма и валюта

amount

number

required

Сумма

currencyCode

string

required

Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$

Цифровой код валюты

currencyName

string

required

Возможные значения: Value must match regular expression ^[A-Z]{3}$

Буквенный ISO-код валюты

loanDate

date

Дата кредитного договора

loanNumber

string

Возможные значения: <= 50 characters

Номер кредитного договора

month

string

required

Возможные значения: <= 50 characters

Месяц отчетного периода

orgName

string

required

Возможные значения: <= 160 characters

Наименование организации клиента

orgTaxNumber

string

required

Возможные значения: Value must match regular expression ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

ИНН организации клиента

payDocs PayrollPayDoc[]
Платежные документы перечисления зарплаты
Array [
amount objectrequired
Сумма и валюта
amount
number
required
Сумма
currencyCode
string
required
Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$
Цифровой код валюты
currencyName
string
required
Возможные значения: Value must match regular expression ^[A-Z]{3}$
Буквенный ISO-код валюты
docDate
date
required
Дата расчетного документа
number
string
required
Номер расчетного документа
payeeAccount
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета получателя
payeeBic
string
required
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка получателя
payerAccount
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета плательщика
payerBic
string
required
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка плательщика
purpose
string
required
Назначение платежного документа
]
year

string

required

Возможные значения: >= 4 characters и <= 4 characters

Год отчетного периода

Ответы

• 201
• 202
• 400
• 401
• 403
• 415
• 429
• 500
• 503

Создан

• application/json

• Схема
• Пример из схемы

Schema

bankComment

string

Банковский комментарий к статусу документа

bankStatus

string

Статус документа

date

date

required

Дата составления документа

digestSignatures object[]
Электронные подписи по дайджесту документа
Array [
base64Encoded
string
required
Значение электронной подписи, закодированное в Base64
certificateUuid
uuid
required
Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
]
number

string

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

account

string

Возможные значения: Value must match regular expression ^[0-9]{20}$

Номер счета клиента

admissionValue

string

required

Возможные значения: Value must match regular expression ^[0-9]{2}$

Вид зачисления

amount objectrequired

Итоговая сумма зачисления

amount

number

required

Сумма

currencyCode

string

required

Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$

Цифровой код валюты

currencyName

string

required

Возможные значения: Value must match regular expression ^[A-Z]{3}$

Буквенный ISO-код валюты

authPersonName

string

Возможные значения: <= 60 characters

ФИО уполномоченного сотрудника организации клиента

authPersonTelfax

string

Возможные значения: <= 40 characters

Номер телефона, факса уполномоченного сотрудника организации клиента

bic

string

required

Возможные значения: Value must match regular expression ^[0-9]{9}$

БИК банка клиента

commissionInfo object

Тарифы и коммисия зарплатной ведомости

actualRate

number

Возможные значения: >= 0.01

Фактическая тарифная ставка комиссии (%)

actualSum

number

Возможные значения: >= 0.01

Фактическая сумма комиссии

estimatedRate

number

Возможные значения: >= 0.01

Предварительная тарифная ставка комиссии (%)

estimatedSum

number

Возможные значения: >= 0.01

Предварительная сумма комиссии

invoiceDate

date

Дата выставления счета и направления детализации

contractDate

date

required

Дата договора

contractNumber

string

required

Номер договора

employeeSalaries PayrollEmpSalary[]required
Possible values: >= 1
Сотрудники, которым зачисляют зарплату
Array [
account
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета сотрудника
amount objectrequired
Сумма начисления
amount
number
required
Сумма
currencyCode
string
required
Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$
Цифровой код валюты
currencyName
string
required
Возможные значения: Value must match regular expression ^[A-Z]{3}$
Буквенный ISO-код валюты
bankMessage
string
Сообщение из банка по сотруднику
bic
string
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка сотрудника
firstName
string
required
Имя
lastName
string
required
Фамилия
middleName
string
Отчество
receiptResult
string
Результат регистрации самозанятого в ФНС
receiptStatus
string
Получен
result
string
Результат начисления
withheldAmount
number
Сумма удержанных средств по исполнительному документу
]
employeesNumber

int32

required

Количество сотрудников

externalId

uuid

required

Идентификатор документа, присвоенный сервисом (UUID)

incomeTypeCode

string

Возможные значения: Value must match regular expression ^([1-9]{1}|[1-9]{1}[0-9]{1})$

Код вида дохода получателей выплаты по 229-ФЗ

loanAmount object

Сумма и валюта

amount

number

required

Сумма

currencyCode

string

required

Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$

Цифровой код валюты

currencyName

string

required

Возможные значения: Value must match regular expression ^[A-Z]{3}$

Буквенный ISO-код валюты

loanDate

date

Дата кредитного договора

loanNumber

string

Возможные значения: <= 50 characters

Номер кредитного договора

month

string

required

Возможные значения: <= 50 characters

Месяц отчетного периода

orgName

string

required

Возможные значения: <= 160 characters

Наименование организации клиента

orgTaxNumber

string

required

Возможные значения: Value must match regular expression ^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$

ИНН организации клиента

payDocs PayrollPayDoc[]
Платежные документы перечисления зарплаты
Array [
amount objectrequired
Сумма и валюта
amount
number
required
Сумма
currencyCode
string
required
Возможные значения: Value must match regular expression ^[A-Z\d]\d{2}$
Цифровой код валюты
currencyName
string
required
Возможные значения: Value must match regular expression ^[A-Z]{3}$
Буквенный ISO-код валюты
docDate
date
required
Дата расчетного документа
number
string
required
Номер расчетного документа
payeeAccount
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета получателя
payeeBic
string
required
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка получателя
payerAccount
string
required
Возможные значения: Value must match regular expression ^[0-9]{20}$
Номер счета плательщика
payerBic
string
required
Возможные значения: Value must match regular expression ^[0-9]{9}$
БИК банка плательщика
purpose
string
required
Назначение платежного документа
]
year

string

required

Возможные значения: >= 4 characters и <= 4 characters

Год отчетного периода

{
  "bankComment": "string",
  "bankStatus": "string",
  "date": "2018-12-31",
  "digestSignatures": [
    {
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
    }
  ],
  "number": "1",
  "account": "40802810600000200000",
  "admissionValue": "01",
  "amount": {
    "amount": "1.01",
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "authPersonName": "Иванов Алексей Сергеевич",
  "authPersonTelfax": "8(495)1234567",
  "bic": "044525225",
  "commissionInfo": {
    "actualRate": "1.01",
    "actualSum": "1.01",
    "estimatedRate": "1.01",
    "estimatedSum": "1.01",
    "invoiceDate": "2018-12-31"
  },
  "contractDate": "2018-12-31",
  "contractNumber": "1",
  "employeeSalaries": [
    {
      "account": "40802810600000200000",
      "amount": {
        "amount": "1.01",
        "currencyCode": "840",
        "currencyName": "USD"
      },
      "bankMessage": "string",
      "bic": "044525225",
      "firstName": "Дмитрий",
      "lastName": "Петров",
      "middleName": "Сергеевич",
      "receiptResult": "https://lknpd.nalog.ru/api/v1/receipt/366522706980/2d7yuc/print",
      "receiptStatus": "string",
      "result": "string",
      "withheldAmount": "1.01"
    }
  ],
  "employeesNumber": "254",
  "externalId": "9b9f1b57-425e-4aff-9856-21fc4951f1e8",
  "incomeTypeCode": "1",
  "loanAmount": {
    "amount": "1.01",
    "currencyCode": "840",
    "currencyName": "USD"
  },
  "loanDate": "2018-12-31",
  "loanNumber": 1234567890,
  "month": "Январь",
  "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
}

Операция не завершена полностью

• application/json

• Схема
• Пример из схемы

Schema

referenceId

string

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
]

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string"
    }
  ]
}

Ошибка в запросе

• application/json

• Схема
• Пример из схемы

Schema

referenceId

string

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
]

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string"
    }
  ]
}

Не авторизован

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Запрещено

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact Serialization

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Превышен лимит запросов

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Сервис временно недоступен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Loading...

Loading...