Jump.Finance OpenApi (2.0)

Download OpenAPI specification:Download

Введение

Jump.Finance OpenApi — продукт, позволяющий вам организовать взаимодйствие с сервисом Jump.Finance из своей системы.

Возможности:

  • управление юрлицами для работы с исполнителями через разные юридические лица и банковские счета
  • управление исполнителями
  • создание выплат и получение информации по выплатам
  • получение информации по банковским счетам

Общая информация

Номер телефона всегда передается в формате '+70000000000'

В каждом запросе должны быть заголовки:

  • Accept: application/json
  • Content-Type: application/json

Авторизация

Для авторизации необходимо передать ключ клиента. Ключ можно передать двумя способами:

GET-параметр client_key

заголовок Client-Key

Правовые формы

Все исполнители имеют правовую форму legal_form_id.

Доступные значения:

  • 1 - физическое лицо

  • 2 - самозанятый

  • 3 - ип

Статусы выплат

Все выплаты имеют текущий статус status_id.

Доступные значения:

  • 1 - оплачен (без возможности дальнейших действий)

  • 2 - отклонён (без возможности дальнейших действий)

  • 3 - в обработке (ждём проведение через платежные системы)

  • 4 - ожидает подтверждения (требуется подтверждение выплаты в ЛК)

  • 5 - ошибка выплаты (с возможностью повторить действие, отменить выплату или зачислить средства на баланс исполнителя)

Ошибки

401 Unauthorized - ошибка авторизации

{
  "error": {
    "title": "Ошибка авторизации",
    "detail": "Требуется авторизация",
    "fields": null,
    "code": 401
  }
}

403 Forbidden - ошибка доступа

{
  "error": {
    "title": "Доступ ограничен",
    "detail": "This action is unauthorized.",
    "fields": null,
    "code": 403
  }
}

404 Not Found - ресурс не найден

{
  "error": {
    "title": "Ошибка",
    "detail": "Ресурс не найден",
    "fields": null,
    "code": 404
  }
}

422 Unprocessable Entity - ошибка валидации

{
  "error": {
    "title": "Ошибка",
    "detail": "The given data was invalid.",
    "fields": [
      {
        "field": "name",
        "messages": [
          "Поле Название обязательно для заполнения."
        ]
      },
      {
        "field": "inn",
        "messages": [
          "Поле ИНН обязательно для заполнения."
        ]
      }
    ],
    "code": 422
  }

}

500 Internal Server Error - неизвестная ошибка

{
  "error": {
    "title": "Ошибка",
    "detail": "Внутренняя ошибка сервера",
    "fields": null,
    "code": 500
  }
}

Банковские счета

Данные методы предназначены для получения банковских счетов компании.

Получить все банковские счета

Баланс банковских счетов обновляется в системе каждые 30 минут и при открытии страниц личного кабинета с отображением баланса, но не чаще одного раза в три минуты. Для принудительного обновления используйте метод "Запросить обновление балансов всех банковских счетов"

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
view
string

Передайте значение 'simple' для получения необходимой информации

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Получить информацию по банковскому счёту

Получение информации по определенному счёту

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
bank_account_id
required
string

Уникальный идентификатор счета

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Запросить обновление балансов всех банковских счетов

Запрашивает обновление балансов всех банковских счетов. Команду возможно запускать не чаще одного раза в три минуты.

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию по запросу обновления банковских счетов

Получение информации по запросу обновления банковских счетов

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
sync_balances_status_id
required
string

Идентификатор запроса на синхронизацию

Responses

Response samples

Content type
application/json
{ }

Внутренние балансы

Данные методы предназначены для получения внутренних балансов компании.

Получить все внутренние балансы компании

Возвращает все внутренние балансы компании

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Выплаты

Данные методы предназначены для создания выплат исполнителям.

Создать выплату с одновременным созданием получателя

Создать выплату с одновременным созданием получателя. Поля в запросе не должны содержать номер банковской карты, кроме поля account_number в requesite.

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
customer_payment_id
string <= 36 characters

Идентификатор выплаты в системе клиента. Идентификатор не должен содержать номер карты. Два платежа с одним и тем же идентификатором не могут быть созданы в системе. Идентификатор может содержать только латинские буквы, цифры, пробелы и символы -_.!:*()[]@$~`^,;=<>|{}‘.

phone
required
string

Номер телефона получателя

last_name
required
string

Фамилия получателя

first_name
required
string

Имя получателя

middle_name
string

Отчество получателя

required
СБП по номеру телефона (object) or Карта банка по номеру карты (object) (Requisites)

Значения реквизитов получателя

amount
required
number

Сумма выплаты

agent_id
integer

ИД юр.лица

ext_template
string

Имя внешнего шаблона

ext_contract_number
string

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

ext_contract_date
string <date-time>

Дата внешнего договора

ext_vin
string

VIN номер

bank_account_id
integer

Идентификатор счета, с которого будет произведена выплата. Если не передан - будет использован счет по умолчанию для данного типа реквизитов исполнителя

object or null

Данные для проверки в случае выплаты по СБП

branch_office_id
integer or null

Идентификатор филиала с которого была создана выплата

Responses

Request samples

Content type
application/json
{
  • "customer_payment_id": "string",
  • "phone": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "requisite": {
    },
  • "amount": 0,
  • "agent_id": 0,
  • "ext_template": "string",
  • "ext_contract_number": "string",
  • "ext_contract_date": "2019-08-24T14:15:22Z",
  • "ext_vin": "string",
  • "bank_account_id": 0,
  • "sbp_validation_data": {
    },
  • "branch_office_id": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Создать выплату

По умолчанию мы создаем выплату от юрлица, которому принадлежит исполнитель. Вы можете переопределить это поведение, явно передав идентификатор юрлица в параметре agent_id. Для компаний, поддерживающих работу с несколькими балансами исполнителей, если передан balance_id, то выплата будет создана на юрлицо переданного баланса, и переопредилить юрлицо у выплаты будет нельзя. Зачисление денежных средств осуществляется только на банковские карты, выпущенные в РФ. Если не передать ни requisite_id, ни requisite, то при создании выплаты будет использоваться реквизит исполнителя по умолчанию. Результат запроса на выплату можно получить, вызвав метод Получить информацию по выплате, передав в него соответствующий payment_id. Поля в запросе не должны содержать номер банковской карты, кроме поля account_number в requesite.

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает новую выплату

Карта банка по номеру телефона (object) or Карта банка по номеру карты (object)

Не указывается, если используется параметр requisite_id или требуется использовать реквизит по умолчанию

customer_payment_id
string <= 36 characters

Идентификатор выплаты в системе клиента. Идентификатор не должен содержать номер карты. Два платежа с одним и тем же идентификатором не могут быть созданы в системе. Идентификатор может содержать только латинские буквы, цифры, пробелы и символы -_.!:*()[]@$~`^,;=<>|{}‘.

contractor_id
required
integer

идентификатор исполнителя

amount
required
number

сумма выплаты

agent_id
integer

идентификатор юрлица

branch_office_id
integer

Идентификатор филиала

bank_account_id
integer

Идентификатор счета

service_name
string

наименование услуг (только для самозанятых исполнителей). Не должно содержать номер банковской карты.

payment_purpose
string

назначение платежа. Не должно содержать номер банковской карты.

balance_id
integer or null

идентификатор баланса

requisite_id
integer or null

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

object or null

Данные для проверки в СБП платеже

object or null

Данные для создания акта по выплате

object or null

Информация о покупателе (используется для формирования чеков самозанятых исполнителей)

Responses

Request samples

Content type
application/json
Example
{
  • "requisite": {
    },
  • "contractor_id": 123,
  • "amount": 100,
  • "agent_id": 61,
  • "service_name": "наименование услуг (только для самозанятых исполнителей). Не должно содержать номер банковской карты.",
  • "payment_purpose": "назначение платежа. Не должно содержать номер банковской карты.",
  • "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить все выплаты

Возвращает все выплаты

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator

  • abilities - возможность совершения действий над выплатой
  • requisite - реквизиты, по которым выплата была произведена
  • creator - создатель выплаты
  • agent - юрлицо, в рамках которого выплата осуществлена
  • history - история действий по выплате
  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.
  • act - информация о связанном с выплатой акте (если есть)
  • nominal_info - информация, связанная с номинальным счетом
  • comment - комментарий к выплате
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Повтор выплаты. Чтобы узнать, можно ли повторить

Повтор выплаты.

Чтобы узнать, можно ли повторить выплату, выполните запрос на получение выплаты/списка выплат с параметром ?include=abilities. За возможность повторения выплаты отвечает свойство abilities.can_repeat.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
payment_id
required
integer

Id выплаты для повтора

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию по выплате

Статус выплаты имеет смысл запрашивать с периодичностью не чаще одного раза в минуту до получения флага is_final.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
payment_id
required
integer

Id выплаты, по которой запрашивается информация

query Parameters
include
string
Example: include=act,branch_office

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator

  • abilities - возможность совершения действий над выплатой
  • requisite - реквизиты, по которым выплата была произведена
  • creator - создатель выплаты
  • agent - юрлицо, в рамках которого выплата осуществлена
  • history - история действий по выплате
  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.
  • act - информация о связанном с выплатой акте (если есть)
  • branch_office - информация с какого филиала была сделана выплата (если есть)
  • nominal_info - информация, связанная с номинальным счетом
  • bank_account - информация с какого счета была сделана выплата
  • comment - комментарий к выплате

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию по выплате по идентификатору в системе клиента

Статус выплаты имеет смысл запрашивать с периодичностью не чаще одного раза в минуту до получения флага is_final.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
customer_payment_id
required
integer

Идентификатор выплаты в системе клиента. Значение должно быть в URL-encoded формате, так как некоторые символы могут быть неправильно интерпретированы на принимающей стороне.

query Parameters
include
string
Example: include=act,branch_office

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator

  • abilities - возможность совершения действий над выплатой
  • requisite - реквизиты, по которым выплата была произведена
  • creator - создатель выплаты
  • agent - юрлицо, в рамках которого выплата осуществлена
  • history - история действий по выплате
  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.
  • act - информация о связанном с выплатой акте (если есть)
  • branch_office - информация с какого филиала была сделана выплата (если есть)
  • nominal_info - информация, связанная с номинальным счетом
  • bank_account - информация с какого счета была сделана выплата

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Словари

Возвращает список словарей

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{
  • "sbp_banks": {
    }
}

Группы

Данные методы предназначены для получения групп компании.

Получить все группы

У компании может быть только одна группа по умолчанию

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
view
string

Передайте значение 'simple' для получения необходимой информации

page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Интеграции

Данные методы предназначены для получения интеграций компании.

Получить все интеграции компании

Возвращает все интеграции компании

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Исполнители

Данные методы предназначены для получения и создания исполнителей. Исполнители выполняют работы и получают за это оплату.

Создать/изменить исполнителя

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

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает нового или обновляет существуещего исполнителя

phone
required
string

телефон в формате +79000000000

email
string or null

Адрес электронной почты

last_name
required
string

фамилия

middle_name
string

отчество

first_name
required
string

имя

legal_form_id
required
number

идентификатор правовой формы

agent_id
required
number

идентификатор юрлица

group_id
number

идентификатор группы

inn
string
company_agrees_pay_taxes
boolean

уплачивать ли налоги за самозанятого

Responses

Request samples

Content type
application/json
{
  • "phone": "+79031112233",
  • "last_name": "Константинопольский",
  • "first_name": "Константин",
  • "middle_name": "Константинович",
  • "legal_form_id": 2,
  • "inn": "1234567892",
  • "agent_id": 1,
  • "group_id": 1,
  • "company_agrees_pay_taxes": true
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить всех исполнителей

Список всех истоплнителей с пагинацией

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Получить карточку исполнителя

Возвращает карточку исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удалить исполнителя

Удаляет исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Обновление исполнителя

Обновление исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
phone
required
string

телефон в формате +79000000000

email
string or null

Адрес электронной почты

last_name
required
string

фамилия

middle_name
string

отчество

first_name
required
string

имя

legal_form_id
required
number

идентификатор правовой формы

agent_id
required
number

идентификатор юрлица

group_id
number

идентификатор группы

inn
string
company_agrees_pay_taxes
boolean

уплачивать ли налоги за самозанятого

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "first_name": "string",
  • "legal_form_id": 0,
  • "agent_id": 0,
  • "group_id": 0,
  • "inn": "string",
  • "company_agrees_pay_taxes": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "phone": "string",
  • "email": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "inn": "string",
  • "is_editable": true,
  • "updated_at": "string",
  • "created_at": "string",
  • "balance": {
    },
  • "agent": {
    },
  • "legal_form": {
    }
}

Создать реквизиты исполнителя

Создает реквизиты исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
string

Уникальный идентификатор исполнителя

Request Body schema: application/json
required

Создает реквизиты

One of
account_number
required
string

Номер карты

type_id
required
number
Value: 8

Тип реквизита

object (Данные карты)

Responses

Request samples

Content type
application/json
Example
{
  • "type_id": 8,
  • "account_number": "5469550053219652",
  • "card": {
    }
}

Response samples

Content type
application/json
{}

Получить реквизиты исполнителя

Возвращает реквизиты исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [],
  • "meta": {
    },
  • "links": {
    }
}

Получить балансы исполнителя

Возвращает балансы исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

query Parameters
include
string

Дополнительно к существующим полям можно запросить дополнительную информацию по балансу. Пример: include=agent

  • agent - юрлицо баланса
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Получить баланс исполнителя

Возвращает баланс исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

balance_id
required
integer <int64>

Уникальный идентификатор баланса

query Parameters
include
string

Дополнительно к существующим полям можно запросить дополнительную информацию по балансу. Пример: include=agent

  • agent - юрлицо баланса

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию о самозанятом

Не делает запрос в налоговую, возвращает текущее состояние самозанятого.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "": "string"
}

Проверить статус самозанятого

Отправляет запрос в налоговую для того чтобы проверить, подтвердил ли самозанятый необходимые разрешения. Возвращает ту же модель, что и метод GET /contractors/{contractor_id}/selfemployer/ После этого запроса можно запустить опрос метода GET по таймауту (например каждые 2 сек), до тех пор, пока в ответе sync.in_process === true Данный метод защищен от многократного запуска. Для одного исполнителя можно запрашивать метод POST не чаще чем один раз в 30 сек.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Принудительно идентифицировать исполнителя

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer

Идентификатор исполнителя

query Parameters
view
string
Enum: "simple" "passport"

Вариант представления возвращаемых данных

Request Body schema: application/json
required

Принудительно идентифицирует исполнителя

country
required
string

Код страны в формате ISO 3166-1 alpha-3 в нижнем регистре

is_verified
boolean

Является верифицированным

snils
string

СНИЛС

inn
string

ИНН

object

Паспортные данные

Responses

Request samples

Content type
application/json
{
  • "country": "rus",
  • "is_verified": true,
  • "snils": 12345678901,
  • "inn": 123456789012,
  • "passport": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию о последнем одобренном запросе на идентификацию

Возвращает информацию о последнем одобренном запросе на идентификацию

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
string

Идентификатор исполнителя

query Parameters
view
string
Enum: "simple" "passport"

Вариант представления возвращаемых данных

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить информацию о всех сотрудничествах

Данные методы предназначены для создания связи между юрлицом и исполнителем. Сотрудничество исполнителя с юрлицом позволяет отправлять и подписывать документы с несколькими юрлицами, в которых исполнитель оказывает услугу. Если исполнитель работает через одно юрлицо, данные методы можно не использовать.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Создать сотдрудничество

Создает новое сотдрудничество

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Request Body schema: application/json
required

Создает новое сотрудничество

agent_id
required
integer

идентификатор юрлица

legal_form_id
required
integer

идентификатор правового статуса (1 - физическое лицо, 2 - самозанятый, 3 - индивидуальный предприниматель)

Responses

Request samples

Content type
application/json
{
  • "agent_id": 1,
  • "legal_form_id": 1
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить сотрудничество

Возвращает сотрудничество

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

cooperation_id
required
integer <int64>

Уникальный идентификатор сотрудничества

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удалить сотрудничество

Удаляет сотрудничество

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

cooperation_id
required
integer <int64>

Уникальный идентификатор сотрудничества

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Получить статус самозанятого

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
inn
required
integer <int64>

ИНН

query Parameters
date
string <date>

Дата проверки

Responses

Response samples

Content type
application/json
{
  • "is_self_employed": true
}

Самозанятые

Данные методы предназначены для получения информации о самозанятых исполнителях.

Получить информацию о самозанятом

Не делает запрос в налоговую, возвращает текущее состояние самозанятого.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "": "string"
}

Проверить статус самозанятого

Отправляет запрос в налоговую для того чтобы проверить, подтвердил ли самозанятый необходимые разрешения. Возвращает ту же модель, что и метод GET /contractors/{contractor_id}/selfemployer/ После этого запроса можно запустить опрос метода GET по таймауту (например каждые 2 сек), до тех пор, пока в ответе sync.in_process === true Данный метод защищен от многократного запуска. Для одного исполнителя можно запрашивать метод POST не чаще чем один раз в 30 сек.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

Уникальный идентификатор исполнителя

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить статус самозанятого

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
inn
required
integer <int64>

ИНН

query Parameters
date
string <date>

Дата проверки

Responses

Response samples

Content type
application/json
{
  • "is_self_employed": true
}

Словари

Список словарей

Словари

Возвращает список словарей

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{
  • "sbp_banks": {
    }
}

Юрлица

Данные методы предназначены для получения и создания юрлиц. Как правило, при регистрации в сервисе, первое юрлицо создается автоматически. Если вы работаете через одно юрлицо, достаточно получить его ID и использовать для всех исполнителей.

Создание юрлица

Создание юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает новое юрлицо

name
required
string

Название юрлица

inn
required
string

ИНН юрлица

ogrn
required
string

ОГРН юрлица

address
required
string

Адрес юрлица (используется для документов)

city
string

Город юрлица (используется для актов)

ogrn_date
string

Дата получения ОГРН (используется для актов)

management_name
string

ФИО руководителя (используется для актов у юр. лиц)

management_post
string

Должность руководителя (используется для актов у юр. лиц)

individual_entrepreneur_surname
string

Фамилия (используется для актов у ИП)

individual_entrepreneur_name
string

Имя (используется для актов у ИП)

individual_entrepreneur_patronymic
string

Отчество (используется для актов у ИП)

Responses

Request samples

Content type
application/json
{
  • "name": "ООО Фаворит",
  • "inn": "5406678646",
  • "ogrn": "1115476092687",
  • "address": "г Новосибирск, ул. Фрунзе, 8",
  • "city": "Новосибирск",
  • "kpp": "1231231231",
  • "ogrn_date": "2022-09-12",
  • "management_name": "Директор",
  • "management_post": "Иванов Иван Иванович",
  • "individual_entrepreneur_surname": "Иванов",
  • "individual_entrepreneur_name": "Иван",
  • "individual_entrepreneur_patronymic": "Иванович"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить все юрлица

Возвращает список всех юрлиц

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Получить карточку юрлица

Возвращает карточку юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
agent_id
required
integer <int64>

Уникальный идентификатор юрлица

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование юрлица

Обновляет информацию юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
agent_id
required
integer

Id юрлица

Request Body schema: application/json
required

Редактирует данные юрлица

name
required
string

Название юрлица

inn
required
string

ИНН юрлица

ogrn
required
string

ОГРН юрлица

address
required
string

Адрес юрлица (используется для документов)

city
string

Город юрлица (используется для актов)

ogrn_date
string

Дата получения ОГРН (используется для актов)

management_name
string

ФИО руководителя (используется для актов у юр. лиц)

management_post
string

Должность руководителя (используется для актов у юр. лиц)

individual_entrepreneur_surname
string

Фамилия (используется для актов у ИП)

individual_entrepreneur_name
string

Имя (используется для актов у ИП)

individual_entrepreneur_patronymic
string

Отчество (используется для актов у ИП)

Responses

Request samples

Content type
application/json
{
  • "name": "ООО Фаворит",
  • "inn": "5406678646",
  • "ogrn": "1115476092687",
  • "address": "г Новосибирск, ул. Фрунзе, 8",
  • "city": "Новосибирск",
  • "kpp": "1231231231",
  • "ogrn_date": "2022-09-12",
  • "management_name": "Директор",
  • "management_post": "Иванов Иван Иванович",
  • "individual_entrepreneur_surname": "Иванов",
  • "individual_entrepreneur_name": "Иван",
  • "individual_entrepreneur_patronymic": "Иванович"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование отдельных атрибутов юрлица

Обновляет информацию юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
agent_id
required
integer

Id юрлица

Request Body schema: application/json
required

Редактирует данные юрлица

name
string

Название юрлица

inn
string

ИНН юрлица

ogrn
string

ОГРН юрлица

address
string

Адрес юрлица (используется для документов)

city
string

Город юрлица (используется для актов)

ogrn_date
string

Дата получения ОГРН (используется для актов)

management_name
string

ФИО руководителя (используется для актов у юр. лиц)

management_post
string

Должность руководителя (используется для актов у юр. лиц)

individual_entrepreneur_surname
string

Фамилия (используется для актов у ИП)

individual_entrepreneur_name
string

Имя (используется для актов у ИП)

individual_entrepreneur_patronymic
string

Отчество (используется для актов у ИП)

Responses

Request samples

Content type
application/json
{
  • "name": "ООО Фаворит",
  • "inn": "5406678646",
  • "ogrn": "1115476092687",
  • "address": "г Новосибирск, ул. Фрунзе, 8",
  • "city": "Новосибирск",
  • "kpp": "1231231231",
  • "ogrn_date": "2022-09-12",
  • "management_name": "Директор",
  • "management_post": "Иванов Иван Иванович",
  • "individual_entrepreneur_surname": "Иванов",
  • "individual_entrepreneur_name": "Иван",
  • "individual_entrepreneur_patronymic": "Иванович"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление юрлица

Удаляет юрлицо

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
agent_id
required
integer

Id юрлица

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Филиалы

Данные методы работают для получения и манипулирования филиалами

Получение списка филиалов

Получение списка филиалов

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
agent_id
integer <int64>

Уникальный идентификатор Юр. лица

query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Редактирование филиала

Редактирование филиала

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Редактирует существующий филиал

agent_id
integer

Идентификатор юридического лица

name
string

Название филиала

address
string

Адрес филиала

limit_monthly
number
Default: null

Лимит на месяц по филиалу (null безлимит)

limit_daily
number
Default: null

Лимит на день по филиалу (null безлимит)

is_active
integer

Флаг активности филиала (1 - активен, 0 - выключен)

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "name": "string",
  • "address": "string",
  • "limit_monthly": null,
  • "limit_daily": null,
  • "is_active": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отделы юрлиц

Данные методы предназначены для получения и создания отделов юрлиц.

Получить все отделы юрлиц

Возвращает список отделов юрлиц

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
name
string

Фильтр по названию отдела

with_trashed
boolean

Включить в выборку удаленные записи

only_trashed
boolean

Делать выборку только из удаленных записей

order
string
Enum: "id" "-id" "parent_id" "-parent_id"

Сортировка записей

agent_id
integer

Фильтр по юрлицу

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Создать отдел юрлица

Создаёт отдел юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
name
required
string

Название отдела юрлица

agent_id
required
integer

ИД юрлица

parent_id
integer or null

ИД родительского отдела юрлица

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "agent_id": 0,
  • "parent_id": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить отдел юрлица

Возвращает отдел юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
department_id
required
integer

ИД отдела юрлица

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование отдела юрлица

Обновляет информацию отдела юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
department_id
required
integer

ИД отдела юрлица

Request Body schema: application/json
name
required
string

Название отдела юрлица

parent_id
required
integer or null

ИД родительского отдела юрлица

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление отдела юрлица

Удаляет отдел юрлица

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
department_id
required
integer

ИД отдела юрлица

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Должности

Данные методы предназначены для получения и создания должностей.

Получить все должности

Возвращает список должностей

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
name
string

Фильтр по названию должности

with_trashed
boolean

Включить в выборку удаленные записи

only_trashed
boolean

Делать выборку только из удаленных записей

order
string
Enum: "id" "-id" "name" "-name"

Сортировка записей

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Создать должность

Создаёт должность

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
name
required
string

Название должности

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить должность

Возвращает должность

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
position_id
required
integer

ИД должности

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование должности

Обновляет информацию должности

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
position_id
required
integer

ИД должности

Request Body schema: application/json
name
required
string

Название должности

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление должности

Удаляет должность

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
position_id
required
integer

ИД должности

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Штатные сотрудники

Данные методы предназначены для управления штатными сотрудниками.

Найти штатного сотрудника по номеру телефона

Возвращает данные штатного сотрудника по номеру телефона

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
phone
required
string

Фильтр по номеру телефона исполнителя

include
string
Example: include=workplaces

Дополнительные данные, которые необходимо получить вместе со штатным сотрудником

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Создать нового штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=workplaces

Дополнительные данные, которые необходимо получить вместе со штатным сотрудником

Request Body schema: application/json
required

Создает нового штатного сотрудника

inn
string or null
phone
required
string

телефон в формате +79000000000

email
string or null

Адрес электронной почты

last_name
required
string

фамилия

first_name
required
string

имя

middle_name
string or null

отчество

required
Array of objects (EmployeeWorkplaceStoreRequest)

Responses

Request samples

Content type
application/json
{
  • "inn": "string",
  • "phone": "string",
  • "email": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "workplaces": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить всех штатных сотрудников

Список всех штатных сотрудников с пагинацией

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

search
string
Example: search=Василий

Поисковый запрос

agent_id
string
Example: agent_id=61,51,88

Фильтр по юр.лицам в которые устроен сотрудник

department_id
string
Example: department_id=61,51,88

Фильтр по отделам в которые устроен сотрудник

position_id
string
Example: position_id=61,51,88

Фильтр по должностям занимаемым сотрудником

signature_state
string
Example: signature_state=not_released,released,release_failed

Фильтр по статусу УНЭП

include
string
Example: include=workplaces

Дополнительные данные, которые необходимо получить вместе со штатным сотрудником

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Получить штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

query Parameters
include
string
Example: include=workplaces

Дополнительные данные, которые необходимо получить вместе со штатным сотрудником

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

query Parameters
include
string
Example: include=workplaces

Дополнительные данные, которые необходимо получить вместе со штатным сотрудником

Request Body schema: application/json
required

Редактирует данные штатного сотрудника

phone
required
string

телефон в формате +79000000000

email
string or null

Адрес электронной почты

last_name
required
string

фамилия

first_name
required
string

имя

middle_name
string or null

отчество

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "middle_name": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Устроить штатного сотрудника на место работы

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

Request Body schema: application/json
required

Редактирует данные штатного сотрудника

agent_id
required
integer

Уникальный идентификатор юр. лица

department_id
required
integer

Уникальный идентификатор отдела

position_id
required
integer

Уникальный идентификатор должности

can_sign_as_manager
boolean

Может ли подписывать документы от лица компании

employment_date
string <date-time>

Дата устройства в ISO

production_calendar_id
string

Ид производственного календаря

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "department_id": 0,
  • "position_id": 0,
  • "can_sign_as_manager": true,
  • "employment_date": "2019-08-24T14:15:22Z",
  • "production_calendar_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить места работы штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить место работы штатного сотрудника

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

workplace_id
required
integer <int64>

Уникальный идентификатор места работы

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Уволить с места работы

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

workplace_id
required
integer <int64>

Уникальный идентификатор места работы

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Синхронизировать места работы штатного сотрудника

Метод получает на вход список мест работы сотрудника. Если в переданном списке есть новые места работы, о которых система еще не знает, - сотрудник устраивается на эти места работы. Если в системе есть места работы, которые не присутсвуют в переданном списке, - сотрудник уволняется с этих мест работы. Данные по оставшимся местам работы обновляются

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
employee_id
required
integer <int64>

Уникальный идентификатор штатного сотрудника

Request Body schema: application/json
required
agent_id
string

Список ИД юр. лиц, в рамках которого должна произойти синхронизация мест работы штатных сотрудников. Если не передано, синхронизация проходит в рамках всех юр. лиц компании.

required
Array of objects (EmployeeWorkplaceStoreRequest)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "1,2,3",
  • "workplaces": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Типы документов

Данные методы предназначены для получения и создания типов документов.

Получить все типы документов

Возвращает список типов документов

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

name
string

Фильтр по названию типа документа

with_trashed
boolean

Включить в выборку удаленные записи

only_trashed
boolean

Делать выборку только из удаленных записей

order
string
Enum: "id" "-id" "name" "-name"

Сортировка записей

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Создать тип документа

Создаёт тип документа

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
name
required
string

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

document_series
string or null <= 15 characters

Название серии документов этого типа. Используется при генерации номеров документов

document_code
required
string <= 10 characters

Код документа этого типа

is_cancellable
boolean
Default: false

Можно ли аннулировать документы этого типа

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "document_series": "string",
  • "document_code": "string",
  • "is_cancellable": false
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить тип документа

Возвращает тип документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_type_id
required
integer

ИД типа документа

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Редактирование типа документа

Обновляет информацию типа документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_type_id
required
integer

ИД типа документа

Request Body schema: application/json
name
required
string

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

document_series
string or null <= 15 characters

Название серии документов этого типа. Используется при генерации номеров документов

document_code
required
string <= 10 characters

Код документа этого типа

is_cancellable
boolean
Default: false

Можно ли аннулировать документы этого типа

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "document_series": "string",
  • "document_code": "string",
  • "is_cancellable": false
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление типа документа

Удаляет тип документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_type_id
required
integer

ИД типа документа

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Документы

Данные методы предназначены для получения и создания документов.

Получить все документы

Возвращает список документов

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
user_id
integer

Документы, в которых указанный пользователь является одним из подписантов

employee_id
integer

Документы, в которых указанный пользователь является одним из подписантов со стороны сотрудников

manager_id
integer

Документы, в которых указанный пользователь является одним из подписантов со стороны руководителей

is_signed_by_manager
boolean

Документы, подписанные всеми руководителями

is_signed_by_employee
boolean

Документы, подписанные всеми сотрудниками

is_signed
boolean

Документы, подписанные всеми подписантами

page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

order
string
Enum: "id" "-id"

Сортировка записей

agent_id
integer

Документы, указанного юр. лица

created_date_from
string <date>

Документы, созданные после указанной даты (формат Y-m-d)

created_date_to
string <date>

Документы, созданные до указанной даты (формат Y-m-d)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Создать документ

Создаёт документ

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: multipart/form-data
external_id
string <= 64 characters

Внешний идентификатор (произвольная форма, уникальный)

agent_id
required
integer

ИД юрлица

document_type_id
required
integer

ИД типа документа

sign_order
required
string (DocumentSignOrderEnum)
Enum: "arbitrary" "manager_first" "employee_first" "manager_only" "employee_only"

Порядок подписания документа

name
required
string <= 512 characters

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

manual_series
string <= 255 characters

Серия документа

manual_number
string <= 255 characters

Номер документа

date
string or null <= 50 characters

Дата в документе (произвольный формат)

Array of objects

Список подписей руководителей

Array of objects

Список подписей сотрудников

author_id
integer or null

ИД автора (пользователя) документа

author_position_id
integer or null

ИД должности автора (пользователя) документа

signature_deadline
string or null <date>

Дедлайн подписания документа

convert_to_pdf_a
boolean

Будет ли система конвертировать загружаемый документв в PDF/A-1a

file
required
string <binary|base64>

Файл документа. Принимаемые форматы: doc,docx,pdf,xls,xlsx. Максимальный размер 10МБ.

file_name
string

Имя файла. Передается, когда в поле file передано значение в base64

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Создать документ из шаблона

Создаёт документ на основе шаблона

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
agent_id
required
integer

ИД юр.лица

template_id
required
integer

ИД шаблона документа

name
required
string <= 512 characters

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

code
string <= 10 characters

Код документа

document_type_id
required
integer

ИД типа документа

manual_series
string <= 255 characters

Серия документа

manual_number
string <= 255 characters

Номер документа

date
string or null <= 50 characters

Дата в документе в произвольной форме

author_id
required
integer

ИД создателя документа

author_position_id
integer or null

ИД должности автора документа

signature_deadline
string or null <date>

Дедлайн подписания документа

Array of objects (DocumentSubstitution)

Список полей, заполненных пользователем с формы подачи заявления

required
Array of DocumentApprovalStageForCreate (object) or DocumentSigningStageForCreate (object)

Этапы документа

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "template_id": 0,
  • "name": "string",
  • "code": "string",
  • "document_type_id": 0,
  • "manual_series": "string",
  • "manual_number": "string",
  • "date": "string",
  • "author_id": 0,
  • "author_position_id": 0,
  • "signature_deadline": "2019-08-24",
  • "substitutions": [
    ],
  • "stages": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить документ

Возвращает документ

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_id
required
integer

ИД документа

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удаление документа

Удаляет документ

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_id
required
integer

ИД документа

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Скачать оригинальный файл документа

Возвращает оригинальный файл документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_id
required
integer

ИД документа

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Скачать архив подписанного документа

Возвращает архив подписанного документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
document_id
required
integer

ИД документа

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Акты

Данные методы предназначены для получения и создания актов.

Создать акт

Создает акт

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает новый акт

name
required
string

Название акта

agent_id
required
integer

ИД юр.лица

contractor_id
required
integer

ИД исполнителя, который будет указан в акте

document_number
required
string

Номер документа

document_date
required
string

Дата создания документа

period_from
required
string

Дата начала выполнения работ

period_to
required
string

Дата окончания выполнения работ

description
string

Описание акта

total_price
number

Итоговая сумма за услуги в акте. Если не заполнено, считается по видам работ

template_id
integer or null

Идентификатор шаблона акта

required
Array of objects

Виды работ

Responses

Request samples

Content type
application/json
{
  • "name": "Акт №123",
  • "agent_id": 100,
  • "contractor_id": 200,
  • "document_number": 42,
  • "document_date": "2025-02-01",
  • "period_from": "2025-01-01",
  • "period_to": "2025-02-01",
  • "job_types": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить список актов

Возвращает список актов

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

status
string

Статус акта

employee_contractor_id
integer

ИД исполнителя

period_from
string

Начало периода услуг в акте. Формат: YYYY-MM-DD

period_to
string

Конец периода услуг в акте. Формат: YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Получить акт

Возвращает акт

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
act_id
required
integer

ИД акта

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удалить акт

Удаляет акт

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
act_id
required
integer

ИД акта

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Скачать акт

Скачивает файл акта

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
act_id
required
integer

ИД акта

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Получить список шаблонов актов

Возвращает список шаблонов актов

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    },
  • "links": {
    }
}

Подписи документов

Данные методы предназначены для подписи документов.

Передать результат подписи документа на клиенте при помощи КриптоПро

Передать результат подписи документа на клиенте при помощи КриптоПро

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
signature_id
required
integer

ИД подписи

Request Body schema: application/json
value
required
string
object

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "additional": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отказаться от подписи документа

Отказаться от подписи документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
signature_id
required
integer

ИД подписи

Request Body schema: application/json
reject_reason
required
string

Причина отказа от подписания.

Responses

Request samples

Content type
application/json
{
  • "reject_reason": "Пример причины отказа от подписания."
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отпуска

Данные методы предназначены для получения и создания отпусков штатных сотрудников.

Импорт кол-ва оставшихся дней отпуска у указанных сотрудников в указанных юр. лицах

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Синхронизировать отпуска штатных сотрудников компании

Метод позволяет передать график отпусков штатных сотрудников компании из внешней системы. Отсутствующие в сервисе отпуска будут добавлены, а присутствующие в сервисе, но отсутствующие в запросе – удалены из сервиса. Период синхронизации будет ограничен годом, указанным в запросе, поэтому следует присылать только отпуска за указанный год. В запросе нужно передавать не более 100 штатных сотрудников.

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
Array of objects
year
required
integer

Год, в рамках которого производится синхронизация отпусков

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "year": 2023
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Получить список отпусков

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

include
string
Example: include=agent,department,position,vacation_kind

Вывод дополнительной информации

order
string
Enum: "date_from" "-date_from" "created_at" "-created_at"

Порядок сортировки

employee_id
string
Example: employee_id=1,2,5

ИД штатных сотрудников, отпусками которых нужно ограничить выборку, указанные через запятую

agent_id
string
Example: agent_id=1,2,3

ИД юр.лиц, отпусками которых нужно ограничить выборку, указанные через запятую

department_id
string
Example: department_id=1,2,3

ИД отделов, отпусками которых нужно ограничить выборку, указанные через запятую

position_id
string
Example: position_id=1,2,3

ИД должностей, отпусками которых нужно ограничить выборку, указанные через запятую

vacation_kind_id
string
Example: vacation_kind_id=1,2,3

ИД типов отпусков, отпусками которых нужно ограничить выборку, указанные через запятую

is_mapped_out
boolean
Example: is_mapped_out=1

Ограничить выборку только намеченными отпусками

is_scheduled
boolean
Example: is_scheduled=1

Ограничить выборку только запланированными отпусками

is_confirmed
boolean
Example: is_confirmed=1

Ограничить выборку только подтвержденными отпусками

date_from
string <date>

Дата начала периода, за который запрашиваются отпуска

date_to
string <date>

Дата окончания периода, за который запрашиваются отпуска

date_from_min
string <date>

Минимальная дата начала отпуска

date_from_max
string <date>

Максимальная дата начала отпуска

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Получить данные отпуска

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
vacation_id
required
string
query Parameters
include
string
Example: include=agent,department,position,vacation_kind

Вывод дополнительной информации

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Виды отпусков

Данные методы предназначены для получения и манипулирования видами отпусков.

Получить список видов отпусков

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Добавить вид отпуска

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
name
required
string

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

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить вид отпуска

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
vacation_kind_id
required
string

ИД вида отпуска

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отредактировать вид отпуска

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
vacation_kind_id
required
string

ИД вида отпуска

Request Body schema: application/json
name
string

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

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Удалить вид отпуска

Удаляет вид отпуска

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
vacation_kind_id
required
string

ИД вида отпуска

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Кандидаты

Данные методы предназначены для получения и манипулирования кандидатами.

Создать кандидата

Создаёт нового кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=company,workplaces,status,checklist,agents,departments,positions,questionnaire,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

Request Body schema: application/json
first_name
required
string <= 200 characters

Имя

last_name
required
string <= 200 characters

Фамилия

middle_name
string <= 200 characters

Отчество

phone
required
string

Номер телефона

email
required
string <= 200 characters

E-mail

required
Array of objects = 1 characters

Список мест работы (максимум одно)

creator_email
string <= 255 characters

E-mail сотрудника создавшего кандидата (на него будут приходить уведомления)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "phone": "string",
  • "email": "string",
  • "workplaces": [
    ],
  • "creator_email": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получить список кандидатов

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
page
integer <int64> >= 1
Default: 1

Текущая страница

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

include
string
Example: include=company,workplaces,status,checklist,agents,departments,positions,questionnaire,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

agent_id
string
Example: agent_id=1,2,5

ИД юридических лиц, указанные через запятую

department_id
string
Example: department_id=1,2,5

ИД отделов, указанные через запятую

position_id
string
Example: position_id=1,2,5

ИД должностей, указанные через запятую

employee_id
string
Example: employee_id=1,2,5

ИД штатных сотрудников, указанные через запятую

employed
boolean
Example: employed=1

Был ли трудоустроен сотрудник

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Получить данные кандидата

Получает данные кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
candidate_id
required
string

ИД кандидата

query Parameters
include
string
Example: include=company,workplaces,status,checklist,agents,departments,positions,questionnaire,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Обновить персональные данные кандидата

Обновляет персональные данные кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
candidate_id
required
string

ИД кандидата

query Parameters
include
string
Example: include=company,workplaces,status,checklist,agents,departments,positions,questionnaire,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

Request Body schema: application/json
first_name
required
string <= 200 characters

Имя

last_name
required
string <= 200 characters

Фамилия

middle_name
required
string or null <= 200 characters

Отчество

phone
required
string

Номер телефона

email
required
string <= 200 characters

E-mail

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "phone": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Завершить трудоустройство кандидата

Завершает трудоустройство кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
candidate_id
required
string

ИД кандидата

query Parameters
include
string
Example: include=company,workplaces,status,checklist,agents,departments,positions,questionnaire,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Анкеты кандидатов

Данные методы предназначены для получения и манипулирования анкетами кандидатов.

Получить список типов документов для анкеты кандидата

Возвращает список типов документов для анкеты кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Создать анкету кандидата

Создаёт анкету для кандидата

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=company,candidate,status,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application

Вывод дополнительной информации

Request Body schema: application/json
candidate_id
required
string

ИД кандидата

requested_document_codes
required
Array of strings

Выбранные коды типов документов

Responses

Request samples

Content type
application/json
{
  • "candidate_id": "string",
  • "requested_document_codes": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Расчетные листы

Импортировать расчетный лист

Импортирует расчетный лист

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: multipart/form-data
contractor_id
required
integer
agent_id
required
integer
period_year
required
integer

Передавать в формате "%Y", например, 2022.

period_month
required
integer

Передавать в формате "%n" (без нуля слева), например, 9 или 12.

file
required
string <binary|base64>

Файл расчетного листа. Принимаемый формат: pdf.

file_name
string

Поле обязательно для заполнения, если файл передается в формате base64.

Responses

Шаблоны заявлений

Данные методы предназначены для работы с шаблонами заявлений.

Получить все шаблоны заявлений

Получить список шаблонов заявлений

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=placeholders,agent,group

Получение дополнительных данных

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

page
integer <int64> >= 1
Default: 1

Текущая страница

agent_id
string

ИД юр.лица к которому относится шаблон заявления

group_id
string

ИД раздела к которому относится шаблон заявления

order
string
Example: order=-index,-id

Порядок сортировки

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Заявления

Данные методы предназначены для работы с заявлениями.

Получить все заявления

Получить список заявлений

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=substitutions,approval_stages,agent,group,template

Получение дополнительных данных

per_page
integer <int64> [ 1 .. 200 ]
Default: 20
Enum: 1 2 3 4 5 10 15 20 25 30 50 100 150 200

Количество элементов на странице

page
integer <int64> >= 1
Default: 1

Текущая страница

agent_id
string

Заявления, принадлежащие к указанному юр. лицу

group_id
integer

Заявления, принадлежащие к указанной группе заявлений

template_id
integer

Заявления, сформированные по указанному шаблону заявления

author_id
integer

Заявления, сформированные указанным сотрудником

author_position_id
integer

Заявления, сформированные сотрудником в указанной должности

approver_id
integer

Заявления, у которых указанный сотрудник является согласующим

need_approving_by_approver_id
integer

Заявления, у которых указанный сотрудник является согласующим и которые еще не согласованы этим сотрудником

approving_completed_by_approver_id
integer

Заявления, у которых указанный сотрудник является согласующим и по которым завершено согласование этим сотрудником

user_id
integer

Заявления, в которых указанный сотрудник является либо автором либо согласующим

created_at_more_than
string <datetime>

Заявления, у которых дата создания больше чем

created_at_less_than
string <datetime>

Заявления, у которых дата создания меньше чем

sent_to_processing_at_more_than
string <date>

Заявления, у которых дата взятия в работу больше чем

sent_to_processing_at_less_than
string <date>

Заявления, у которых дата взятия в работу меньше чем

search
string

Поисковый запрос

is_signed
boolean

Заявления, которые подписаны

is_approved
boolean

Заявления, которые полностью согласованы всем согласующими

is_revoked
boolean

Заявления, которые отклонены

order
string
Example: order=id, -created_at

Порядок сортировки

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Провайдеры подписей

Данные методы предназначены для работы с провайдерами подписей.

Создать запрос на выпуск УНЭП

Создает запрос на выпуск УНЭП штатным сотрудникам, подпадающим под выборку фильтра. Если поле ИД сотрудников в фильтре отсутствует, будет считаться, что в выборку должны попасть все штатные сотрудники компании. УНЭП будут выпущены только тем сотрудникам, которые еще не имеют УНЭП и данных по которым достаточно для выпуска.

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
identification_type
required
string
Enum: "personal" "epgu"

Способ идентификации сотрудниками, для которых нужно выпустить УНЭП

object

Responses

Request samples

Content type
application/json
{
  • "identification_type": "personal",
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Производственные календари

Данные методы предназначены для работы с производственными календарями.

Создать производственный календарь

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
name
required
string <= 255 characters

Название производственного календаря

code
required
string <= 255 characters

Код производственного календаря

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Обновить значения свойств производственного календаря

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
name
required
string <= 255 characters

Название производственного календаря

code
required
string <= 255 characters

Код производственного календаря

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Синхронизировать календарные дни производственного календаря

Можно передать до 500 дат в одном запросе.

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required
required
Array of objects <= 500 items

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Приемо-сдаточные акты

Данные методы предназначены для работы с приемо-сдаточными актами (ПСА).

Отправка документа на распознавание

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: multipart/form-data
passport_rus
string <binary>

Файл с изображением главной страницы паспорта РФ (png, jpg, jpeg).

passport_rus_registration
string <binary>

Файл с изображением страницы с регистрацией паспорта РФ (png, jpg, jpeg).

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Получение статуса и результата распознавания документа

Получение статуса и результата распознавания документа

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
id
required
string <uuid>

Идентификатор запроса

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Проверка документов

Данные методы предназначены для проверки паспортов.

Создание запроса на проверку паспортных данных

Создание запроса на проверку паспортных данных

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
scenario
required
string
Value: "acceptance_certificate_create"

сценарий проверки

Request Body schema: application/json
One of
last_name
required
string
first_name
required
string
middle_name
string or null
phone_number
required
string
is_self_employed
required
boolean
birth_date
required
string
citizenship
required
string
Value: "RU"
inn
string or null
required
object

Responses

Request samples

Content type
application/json
{
  • "last_name": "Иванов",
  • "first_name": "Ивано",
  • "middle_name": "Иванович",
  • "phone_number": "+79990000000",
  • "is_self_employed": false,
  • "birth_date": "2000-01-01",
  • "citizenship": "RU",
  • "inn": "000000000000",
  • "passport": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получение результата запроса на проверку паспортных данных

Получение результата запроса на проверку паспортных данных

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
requestId
string <uuid>
Example: 6219b041-1dac-4e18-b136-66c000dc0055

Идентификатор запроса

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отчеты по физлицам (ФЛ)

Данные методы предназначены для работы с отчетами по физическим лицам (ФЛ).

Создание отчета на проверку физлица

Создание отчета на проверку физлица

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=suggested_readiness_at,readiness_progress,bankruptcy_partition,passport_partition,wanted_by_police_partition,wanted_by_penitentiary_partition,taxes_partition,terrorists_and_extremists_registry_partition,pledges_partition

Вывод дополнительной информации об отчете о излице.

Request Body schema: application/json
One of
required
object (v1.CounterpartPersonalData)

Персональные данные контрагента для генерации отчета о физлице.

Responses

Request samples

Content type
application/json
{
  • "counterpart_personal_data": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получение отчета на проверку физлица по ID

Получение отчета на проверку физлица по ID

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
id
required
string <uuid>

Идентификатор отчета на проверку физлица

query Parameters
include
string
Example: include=suggested_readiness_at,readiness_progress,bankruptcy_partition,passport_partition,wanted_by_police_partition,wanted_by_penitentiary_partition,taxes_partition,terrorists_and_extremists_registry_partition,pledges_partition

Вывод дополнительной информации об отчете о излице.

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Отчеты по транспортным средствам (ТС)

Данные методы предназначены для работы с очтетами по транспортным средствам (ТС).

Создание отчета на проверку ТС

Создание отчета на проверку ТС

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
string
Example: include=is_partially_ready,readiness_progress,suggested_partial_readiness_at,created_at,vehicle_passport_partition,market_price_partition,vehicle_owners_partition,road_traffic_accidents_partition,commercial_using_partition,mileage_history_partition,traffic_police_restrictions_partition,wanted_partition,leasing_partition,ads_partition,arbitration_cases_partition,enforcement_proceedings_partition,pledges_partition,osago_partition,recall_campaigns_partition,fines_partition,url

Вывод дополнительной информации в отчете о транспортном средстве

Request Body schema: application/json
One of
vin
required
string <= 100 characters

VIN транспортного средства

Responses

Request samples

Content type
application/json
{
  • "vin": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Получение отчета на проверку ТС по ID

Получение отчета на проверку ТС по ID

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
id
required
string <uuid>

Идентификатор отчета на проверку ТС

query Parameters
include
string
Example: include=is_partially_ready,readiness_progress,suggested_partial_readiness_at,created_at,vehicle_passport_partition,market_price_partition,vehicle_owners_partition,road_traffic_accidents_partition,commercial_using_partition,mileage_history_partition,traffic_police_restrictions_partition,wanted_partition,leasing_partition,ads_partition,arbitration_cases_partition,enforcement_proceedings_partition,pledges_partition,osago_partition,recall_campaigns_partition,fines_partition,url

Вывод дополнительной информации в отчете о транспортном средстве

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}