Docs for our awesome API

Совершение выплат через реестр

Этот способ подходит, если вы заранее знаете, кому и сколько нужно выплатить — например, за уже выполненные задания. Все выплаты оформляются через специальный Excel-реестр.

Шаг 1. Скачайте шаблон для заполнения

Скачайте актуальный шаблон реестра, где вы будете указывать данные по выплатам.

• Метод: GET /api/v1/payroll-registries/template
• Чтобы правильно указать услугу, используйте:

1. Справочник: GET /v1/common/services-groups,
2. Или вторую вкладку в шаблоне реестра

Шаг 2. Заполните и загрузите реестр

Укажите в таблице ИНН исполнителя, сумму и текст для чека. После этого загрузите заполненный файл в систему:

• Метод: POST /api/v1/payroll-registries
• В ответ система сообщит, что реестр создан, укажет его ID.

Шаг 3. Выполните оплату

После загрузки нужно подтвердить оплату реестра вручную:

• Метод: POST /api/v1/payroll-registries/{registryId}/execute
• В ответ вы получите статус оплаты, ID реестра и итоговую сумму.

Шаг 4 (опционально). Получите чеки и акты

После успешной оплаты вы можете получить по каждой выплате:

• ссылку на чек,
• акты и другие документы, если они формируются.
• Метод: GET /v1/payroll-registries/{registryId}/items

Выплата без подтверждения (одиночная)

Если вы хотите оформить одну выплату быстро, без ручного подтверждения:

• Используйте метод: POST /api/v1/payroll-registries/direct
• Система сразу создаёт и оплачивает реестр.

Проверьте статус выплаты:

• Метод: GET /api/v1/payroll-registries/{id}/items
• Убедитесь, что статус выплаты — PAID (выплачено).

Если возникли ошибки при загрузке

Если в загруженном реестре были ошибки (например, неверный ИНН или пустое поле), вы можете скачать Excel-файл с их расшифровкой:

• Метод: GET /v1/payroll-registries/{id}/errors
• Файл содержит список ошибочных строк и пояснения, что именно нужно исправить.
• Изменения можно вносить прямо в реестре ошибок. Удалите комментарии системы. Этот файл можно использовать как реестр выплат.