Создать черновик платежного реестра

POST

https://business.tbank.ru/openapi/api/v1/salary/payment-registry/create

Запрос является асинхронной операцией — его результат можно получить через метод Получить результат создания платежного реестра, передав в нем соответствующий correlationId.

В реестр можно добавить сотрудников, которые находятся в статусах ACTIVE и FIRED.

Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/manage — Добавление и получение информации о платежных реестрах компании с инн {inn} и кпп {kpp}.

Ограничение на использование метода — 1 запрос в секунду.

Авторизация

Security

Bearer API Token

Запрос

Request body schema application/json

Required

correlationId

String<uuid>

Идентификатор, связывающий запрос создания с запросом получения ответа.

companyAccountNumber

String

Номер счета компании, с которого будут списаны деньги для оплаты реестра (при наличии РКО в Т-Банке).
Если номер счета не передан, средства спишутся с основного счета компании.

loadDate

String

Дата отправки реестра

registryCreateType

String (EmployeeRegistryCreateTypeRequest)

Requirements: [IGNORE_ERRORS, FAIL_ERRORS]

Может принимать одно из двух значений:

IGNORE_ERRORS — реестр будет создан из всех корректных платежей, его идентификатор вернется в поле paymentRegistryId метода Получить результат создания черновика платежного реестра. Если корректных платежей нет, реестр не создастся.
FAIL_ERRORS — если есть ошибочные платежи, реестр не создастся. Значение по умолчанию — FAIL_ERRORS.

payments

Array of objects ()

Список платежей внутри реестра.

Required

number

Integer<int32>

Идентификатор платежа на стороне клиента.

Required

accountNumber

String

Номер счета сотрудника.

Required

paymentPurpose

String

Назначение платежа данному сотруднику в рамках зарплатного реестра.

Required

employeeInfo

Object

Данные сотрудника, находящегося в статусах ACTIVE или FIRED.

Required

firstName

String

Имя (кириллица).

Required

lastName

String

Фамилия (кириллица).

middleName

String

Отчество (кириллица).

employeeId

Integer<int32>

Идентификатор сотрудника. Возвращается для реестров в статусе DRAFT, ACCEPTED, PART_EXEC или EXECUTED.

Required

sum

Number

Сумма платежа.

periodStart

String<date>

Начало периода платежа.

periodEnd

String<date>

Окончание периода платежа.

revenueTypeCode

String

Requirements: [1, 2, 3, 4, 5]

Код вида дохода.

collectionAmount

Number

Удержанная сумма.

Ответ

200

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции