Получение информации по зарплатным договорам
/v1/salary-agreements
Запрос для получения актуальной информации по зарплатным договорам компании.
Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка.
Для доступа к этому методу в параметре scope
ссылки авторизации пользователя должен быть указан сервис SALARY_AGREEMENT
.
Запрос
Header Parameters
Access token организации-клиента, полученный через SSO
Успешный код возврата
- application/json
- Схема
- Пример из схемы
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
]
]
admissionValueTypes
SalaryAgreementAdmissionValueType[]
Виды зачислений
Код зачисления
Наименование зачисления
Тип зачисления
БИК подразделения
Наименование подразделения
cardTypes
SalaryAgreementCardType[]
Типы пластиковых карт
Код бонусной программы
Код подвида вклада
Код вида вклада
Дата закрытия возможности выпуска карт
Код категории населения
Название категории населения
Код вида карты
Вид карты
commissionInfo
SalaryAgreementCommissionInfo
Тарифы и коммисия
Дата и время последнего обновления информации банком о неоплаченной комиссии
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Текущая ставка тарифа за реестровые зачисления (%)
diffTariffs
SalaryAgreementDiffTariff[]
Дифференцированные тарифы для зарплатных реестров
Возможные значения: [Other
, Salary
]
Тип зачисления
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Конечная сумма диапазона выплат
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Начальная сумма диапазона выплат
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Тарифная ставка (%)
Дата выставления счета и направления детализации
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Фиксированная ставка по прочим зачислениям (%)
periodInfo
SalaryAgreementPeriodInfo
Информация за расчетный период
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Сумма начисленной комиссии за расчетный период
Дата окончания расчетного периода
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Сумма выплат за расчетный период
Дата окончания расчетного периода
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Фиксированная ставка комиссии по зарплатным зачислениям (%)
Возможные значения: >= 0.01
, Value must match regular expression ^\d{0,14}(\.\d{0,2})?$
Общая сумма неоплаченной комиссии
Дата окончания действия договора
Номер договора
Дата начала действия договора
Признак резервирования
ИНН организации пользователя
Номер отделения сберегательного банка
placesOfService
SalaryAgreementPlaceOfService[]
Места обслуживания
Номер отделения сберегательного банка
Адрес подразделения
Код подразделения
Наименование подразделения
Номер территориального банка
Номер внутреннего структурного подразделения
Номер территориального банка
[
{
"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"
}
]
Ошибка в запросе или его жизненном цикле
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
Не авторизован
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Запрещено
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Не найдено
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Превышен лимит запросов
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Внутренняя ошибка сервера
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Сервис временно недоступен
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}