Введение
Docs for our awesome API
On this page
- Введение
Исполнители
On this page
- Исполнители
Задания
Этот способ подходит, когда необходимо подтверждение завершения работ перед выплатой. Вы создаёте задание, приглашаете исполнителя и только после выполнения работы происходит выплата. Задания можно создавать вручную (по одному) или загружать массово через Excel-реестр.
1. Одиночное задание
Для создания задания может понадобиться справочник с наименованиями и кодами услуг: GET /v1/common/services-groups
1.1 Создание задания
Метод: POST /api/v1/jobs Укажите заголовок, тип услуги, бюджет, описание, а также дату начала и окончания. В ответе система вернёт ID задания и его статус.
1.2 Приглашение исполнителя
Методы:
- По ИНН — POST /api/v1/jobs/{id}/invites/invite-by-inn
- По телефону — POST /api/v1/jobs/{id}/invites/invite-by-phone
Система пришлёт подтверждение, что приглашение отправлено, и статус приглашённого исполнителя.
2. Массовое создание заданий
Подходит, если вы оформляете сразу много заданий для разных исполнителей.
- Получите шаблон Excel-файла: GET /v1/job-registries/template
- Заполните файл, указав нужные данные: тип услуги, текст для чека, описание, сумму, ИНН исполнителя, теги и тд.
- Загрузите файл: POST /v1/job-registries
- Проверить статус загрузки можно через: GET /v1/job-registries/{id}
Если в загружаемом файле были ошибки:
- Скачайте файл с ошибками: GET /v1/job-registries/{id}/failed
- Исправьте сам файл реестра ошибок, удалите расшировки ошибок и загрузите повторно
3. Завершение заданий
Для завершения заданий вручную или массово используйте метод: POST /api/v1/jobs/mass-finish-execution
Вы можете указать, какие задания завершить, по ID или другим фильтрам. Система вернёт информацию о том, какие задания завершены.
4. Выплата и получение документов
После завершения задания система автоматически создаёт выплату и формирует чек. Если подключено подписание актов — акт будет сгенерирован и передан исполнителю на подписание.
Посмотреть статус выплат, акты и чеки можно через: GET /v1/job-registries/{id}/items
On this page
- Задания
Получение списка всех заданий.
On this page
- Получение списка всех заданий.
Создание задания.
On this page
- Создание задания.
Получение информации о задании по ID.
On this page
- Получение информации о задании по ID.
Отмена задания.
On this page
- Отмена задания.
Получение шаблона реестра заданий.
On this page
- Получение шаблона реестра заданий.
Загрузка реестра заданий.
On this page
- Загрузка реестра заданий.
Загрузка реестра заданий.
On this page
- Загрузка реестра заданий.
Загрузка реестра заданий.
On this page
- Загрузка реестра заданий.
Получение информации о реестре заданий.
On this page
- Получение информации о реестре заданий.
Получение элементов из реестра заданий.
On this page
- Получение элементов из реестра заданий.
Выгрузка файла с ошибочными записями реестра заданий.
On this page
- Выгрузка файла с ошибочными записями реестра заданий.
Массовое завершение заданий.
On this page
- Массовое завершение заданий.
Выплаты
On this page
- Выплаты
Баланс
On this page
- Баланс
Документы
On this page
- Документы