ym88659208ym87991671
Получение зарплатной ведомости | Документация для разработчиков

Получение зарплатной ведомости

Обновлено 18 марта 2025
GET
/v1/payrolls/{externalId}

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

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

Запрос

Path Parameters

    externalId
    string
    required

    Внешний UUID зарплатной ведомости

    Example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6

Header Parameters

    Authorization
    string
    required

    Access token организации-клиента, полученный через SSO

    Example: f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

Ответы

Успешный код возврата

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

    object

    required

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

    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

    object

    required

    Сумма начисления

    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

    object

    required

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

    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

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

Loading...
Loading...
Это полезный материал?
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей. Вы можете запретить сохранение cookie в настройках своего браузера.