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

Обновлено 29 ноября 2024

/fintech/api/v1/salary-agreements

Запрос позволяет получить актуальную информацию по зарплатномым договорам компании. Информацию можно использовать при формировании зарплатной ведомости.

Отправьте GET-запрос с токеном доступа (access_token) пользователя в параметре Authorization заголовка.

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

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

Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v1/salary-agreements

Модель
Пример

Наименование	Тип	Формат	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.

GET /fintech/api/v1/salary-agreements HTTP/1.1
Authorization: Bearer 4d4b8484Dc385y41a91978180ed433ec9dfcka
Accept: */*

Responses

200 (OK)

Модель
Пример

Параметр	Тип	Обязательность	Описание
Inline Model [
SalaryAgreements	array[SalaryAgreements]	optional	Зарплатный договор
]
SalaryAgreements {
admissionValueTypes	array[SalaryAgreementAdmissionValueType]	optional	Виды зачислений,
branchBic	string	optional	БИК подразделения,
branchName	string	optional	Наименование подразделения,
cardTypes	array[SalaryAgreementCardType]	optional	Типы пластиковых карт,
commissionInfo	SalaryAgreementCommissionInfo	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	required	Тип зачисления = ['Other', 'Salary'] stringEnum:"Other", "Salary",
endAmount	number	required	Конечная сумма диапазона выплат,
fromAmount	number	required	Начальная сумма диапазона выплат,
tariffRate	number	required	Тарифная ставка (%)
}
SalaryAgreementPeriodInfo {
commissionAmount	number	required	Сумма начисленной комиссии за расчетный период,
endDate	string	required	Дата окончания расчетного периода,
payAmount	number	required	Сумма выплат за расчетный период,
startDate	string	required	Дата начала расчетного периода
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

[
   {
      "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"
   }
] 

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция `SALARY_AGREEMENT`. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}