Получение детальной информации по документу

Метод 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

Пароль пользователя

{
  "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
    }
  ]
}

{
  "errorCode": 1,
  "message": "Access denied"
}

{
  "errorCode": 100,
  "message": "Internal server error"
}

Справочник параметра status

Статус

Описание

Черновик

На подписании

Подписан

Отклонен

Блокирован

Истек

Расторгнут

Ответ - успешное выполнение метода

Ключ

Описание

idSelfempDocument

Идентификатор в базе данных

name

Название документа

status

Статус документа

idIndividual

Идентификатор самозанятого

type

Тип документа

dateStart

Дата заключения

dateEnd

Дата окончания

costOfWork

Сумма

idAgreementTemplate

Номер договора

autoRenewal

Автопролонгация

documentLink

Ссылка на файл

ordinalDocumentLink

Ссылка на изначальный файл

documentHistory

История изменений документа

actionType

Тип изменения

date

Дата изменения

person

ФИО пользователя кабинета и самозанятого

phone

Контактный телефон самозанятого

daysRenewal

Количество дней пролонгации договора

Ответ - Системная ошибка

Ключ

Описание

errorCode

Код ошибки вернувшаяся с сервера

message

Сообщение сервера описывающая ошибку

PreviousРасторжение договора NextПолучение списка документов агента

Last updated 11 months ago

{ "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 } ] }