Получение детальной информации по документу
Метод API возвращает подробную информацию по указанному идентификатору документа.
Для вызова метода передать X-Login и X-Password в Headers запроса, в Path указать Id документа, о котором нужно получить информацию.
Эндпоинт
GET https://business.selfwork.ru/selfemployed/business/v1/documents/document/{id}
Path Parameters
| Name | Type | Description | Обязательный |
|---|---|---|---|
| id | integer | Идентификатор документа | Да |
Headers
| Name | Type | Description | Обязательный |
|---|---|---|---|
| X-Login | string | Логин пользователя | Да |
| X-Password | string | Пароль пользователя | Да |
Пример
- cURL
curl -X GET "https://business.selfwork.ru/selfemployed/business/v1/documents/document/123" \
-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,
"documentLink": "string",
"ordinalDocumentLink": "string",
"documentHistory": [
{
"actionType": 0,
"date": "2022-12-08 12:03:40",
"person": "Иванов Иван Иванович",
"phone": "+79123456789",
"daysRenewal": 180
}
]
}
Справочник параметра status:
| Статус | Описание |
|---|---|
| 0 | Черновик |
| 1 | На подписании |
| 2 | Подписан |
| 3 | Отклонен |
| 4 | Блокирован |
| 5 | Истек |
| 6 | Расторгнут |
| 7 | Подписан компанией |
| 8 | Подписан исполнителем |
Справочник параметра type:
| Статус | Описание |
|---|---|
| 0 | Документ |
| 1 | Договор |
| 2 | Акт |
Описание полей ответа:
| Ключ | Описание |
|---|---|
| idSelfempDocument | Идентификатор в базе данных |
| name | Название документа |
| status | Статус документа |
| idIndividual | Идентификатор самозанятого |
| type | Тип документа |
| dateStart | Дата заключения |
| dateEnd | Дата окончания |
| costOfWork | Сумма |
| idAgreementTemplate | Номер договора |
| autoRenewal | Автопролонгация |
| documentLink | Ссылка на файл |
| ordinalDocumentLink | Ссылка на изначальный файл |
| documentHistory | История изменений документа |
Описание полей documentHistory:
| Ключ | Описание |
|---|---|
| actionType | Тип изменения |
| date | Дата изменения |
| person | ФИО пользователя кабинета и самозанятого |
| phone | Контактный телефон самозанятого |
| daysRenewal | Количество дней пролонгации договора |
{
"errorCode": 1,
"message": "Access denied"
}
{
"errorCode": 100,
"message": "Internal server error"
}
Описание полей ошибки:
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, возвращенный сервером |
| message | Сообщение сервера, описывающее ошибку |