Получение списка документов агента
Метод API предоставляет доступ к списку всех документов агента.
Для вызова метода передать X-Login и X-Password в Headers запроса.
Сервер возвращает список документов в JSON формате.
Запрос
GET https://business.selfwork.ru/selfemployed/business/v1/documents/get-docs
Query Parameters
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| page | int32 | Нет | Номер страницы, отсчёт с 1. Действует только вместе с pageSize |
| pageSize | int32 | Нет | Размер страницы. Без него метод вернёт весь список одним ответом |
Headers
| Name | Type | Description |
|---|---|---|
| X-Login* | string | Логин пользователя |
| X-Password* | string | Пароль пользователя |
Пример
- cURL
curl -X GET "https://business.selfwork.ru/selfemployed/business/v1/documents/get-docs" \
-H "X-Login: your_login_here" \
-H "X-Password: your_password_here" \
-H "Content-Type: application/json"
Ответы
- 200: OK - Запрос выполнен успешно
- 401: Unauthorized - Не валидные авторизационные данные
- 500: Internal Server Error - Системная ошибка
[
{
"idSelfempDocument": 10,
"name": "abc",
"status": 3,
"idIndividual": 10,
"type": 0,
"dateStart": "2022-01-22 00:00:00+7",
"dateEnd": "2022-04-22 00:00:00+7",
"costOfWork": 100,
"idAgreementTemplate": 12,
"autoRenewal": false
}
]
{
"errorCode": 1,
"message": "Access denied"
}
{
"errorCode": 100,
"message": "Internal server error"
}
Справочник параметра status
| Статус | Описание |
|---|---|
| 0 | Черновик |
| 1 | На подписании |
| 2 | Подписан |
| 3 | Отклонен |
| 4 | Блокирован |
| 5 | Истек |
| 6 | Расторгнут |
| 7 | Подписан компанией |
| 8 | Подписан исполнителем |
Справочник параметра type
| Тип | Описание |
|---|---|
| 0 | Документ |
| 1 | Договор |
| 2 | Акт |
Описание полей ответа
Успешное выполнение метода
| Ключ | Описание |
|---|---|
| idSelfempDocument | Идентификатор документа в базе данных |
| name | Название документа |
| status | Статус документа |
| idIndividual | Идентификатор самозанятого |
| type | Тип документа |
| dateStart | Дата заключения |
| dateEnd | Дата окончания |
| costOfWork | Сумма |
| idAgreementTemplate | Номер договора |
| autoRenewal | Автопролонгация |
Системная ошибка
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, возвращенный сервером |
| message | Сообщение сервера, описывающее ошибку |