Зарплатная ведомость

URL для отправки запросов

Для обращения к ресурсу необходимо отправлять запрос на:

Получение информации по договору

Ресурс /v1/salary-agreements позволяет получить актуальную информацию по зарплатному договору, которую необходимо использовать при формировании зарплатной ведомости и электронного реестра на открытие счетов и выпуск карт.


Авторизация

Для получения информации необходимо отправить GET-запрос (/v1/salary-agreements), в котором в качестве входящего параметра необходимо передать авторизационный токен к данным (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SALARY_AGREEMENT.

В случае отсутствия в ответе блока полей commissionInfo необходимо повторить выполнение GET-запроса (/v1/salary-agreements) позднее или обратиться в Банк.


Модель запроса

Параметр заголовка Описание
Authorization String Access token собственной организации, полученный через SSO. Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Пример запроса
curl -X GET --header 'Accept: application/json' --header

'Authorization: Bearer 70f6c4dd-dd79-41ef-9a35-4b386802d601-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/salary-agreements'

Модель ответа

Параметр Тип данных Описание
Модель SalaryAgreements
admissionValueTypes (Array [SalaryAgreementAdmissionValueType] optional) Виды зачислений
branchBic (string, optional) БИК подразделения
branchName (string, optional) Наименование подразделения
cardTypes (Array [SalaryAgreementCardType], optional) Типы пластиковых карт
contractEndDate (string, optional) Дата окончания действия договора
contractNumber (string, optional) Номер договора
contractStartDate (string, optional) Дата начала действия договора
isReserve (boolean, optional) Признак резервирования
orgTaxNumber (string, optional) ИНН организации пользователя
osb (string, optional) Номер отделения сберегательного банка
placesOfService (Array [SalaryAgreementPlaceOfService], optional) Места обслуживания
tb (string, optional) Номер территориального банка
Модель SalaryAgreementAdmissionValueType
admissionCode (string, optional) Код зачисления
admissionName (string, optional) Наименование зачисления
admissionType (string, optional) Тип зачисления
SalaryAgreementCardType
bonusProgramCode (string, optional) Код бонусной программы
depositSubtypeCode (string, optional) Код подвида вклада
depositTypeCode (string, optional) Код вида вклада
endDate (string, optional) Дата закрытия возможности выпуска карт
peopleGroupCode (string, optional) Код категории населения
peopleGroupName (string, optional) Название категории населения
typeCode (string, optional) Код вида карты
typeName (string, optional) Вид карты
Модель SalaryAgreementCommissionInfo
actualDateTime (string, optional) Дата и время последнего обновления информации банком о неоплаченной комиссии
currentRate (number, optional) Текущая ставка тарифа за реестровые зачисления (%)
diffTariffs (Array [SalaryAgreementDiffTariff], optional) Дифференцированные тарифы для зарплатных реестров
invoiceDate (string, optional) Дата выставления счета и направления детализации
otherRate (number, optional) Фиксированная ставка по прочим зачислениям (%)
periodInfo (SalaryAgreementPeriodInfo, optional) Информация за расчетный период
salaryRate (number, optional) Фиксированная ставка комиссии по зарплатным зачислениям (%)
Модель SalaryAgreementPlaceOfService
osb (string, optional) Номер отделения сберегательного банка
placeAddress (string, optional) Адрес подразделения
placeCode (string, optional) Код подразделения
placeName (string, optional) Наименование подразделения
tb (string, optional) Номер территориального банка
vsp (string, optional) Номер внутреннего структурного подразделения
Модель SalaryAgreementDiffTariff
admissionTypeCode (string) Тип зачисления = ['Other', 'Salary']stringEnum:"Other", "Salary"
endAmount (number) Конечная сумма диапазона выплат
fromAmount (number) Начальная сумма диапазона выплат
tariffRate (number) Тарифная ставка (%)
Модель SalaryAgreementPeriodInfo
commissionAmount (number) Сумма начисленной комиссии за расчетный период
endDate (string) Дата окончания расчетного периода
payAmount (number) Сумма выплат за расчетный период
startDate (string) Дата начала расчетного периода
Пример ответа
[
   {
      "admissionValueTypes":[
         {
            "admissionCode":"01",
            "admissionName":"Заработная плата",
            "admissionType":"Зарплатный"
         }
      ],
      "branchBic":"044525225",
      "branchName":"ПАО СБЕРБАНК",
      "cardTypes":[
         {
            "bonusProgramCode":"11",
            "depositSubtypeCode":"11",
            "depositTypeCode":"11",
            "endDate":"2018-12-31",
            "peopleGroupCode":"111",
            "peopleGroupName":"Зарплатная",
            "typeCode":"11",
            "typeName":"Visa Classic"
         }
      ],
      "commissionInfo":{
         "actualDateTime":"2018-12-31T23:59:59",
         "currentRate":1.01,
         "diffTariffs":[
            {
               "admissionTypeCode":"Other",
               "endAmount":1.01,
               "fromAmount":1.01,
               "tariffRate":1.01
            }
         ],
         "invoiceDate":"2018-12-31",
         "otherRate":1.01,
         "periodInfo":{
            "commissionAmount":1.01,
            "endDate":"2018-12-31",
            "payAmount":1.01,
            "startDate":"2018-12-31"
         },
         "salaryRate":1.01,
         "totalDebitAmount":1.01
      },
      "contractEndDate":"2018-12-31",
      "contractNumber":"10000001",
      "contractStartDate":"2018-12-31",
      "isReserve":false,
      "orgTaxNumber":"7707083893",
      "osb":"1111",
      "placesOfService":[
         {
            "osb":"1111",
            "placeAddress":"г.Москва, Кутузовский проспект, 34",
            "placeCode":"1111111111",
            "placeName":"Доп офис 1111",
            "tb":"11",
            "vsp":"1111"
         }
      ],
      "tb":"11"
   }
]

Получение списка идентификаторов

Ресурс /v1/salary-agreement/transport-packages позволяет получить список идентификаторов транспортных пакетов, чтобы запрашивать входящие в его состав документы в рамках зарплатного проекта.

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней