Jump.Finance OpenApi — продукт, позволяющий вам организовать взаимодйствие с сервисом Jump.Finance из своей системы.
Возможности:
Номер телефона всегда передается в формате '+70000000000'
В каждом запросе должны быть заголовки:
Для авторизации необходимо передать ключ клиента. Ключ можно передать двумя способами:
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 минут и при открытии страниц личного кабинета с отображением баланса, но не чаще одного раза в три минуты. Для принудительного обновления используйте метод "Запросить обновление балансов всех банковских счетов"
view | string Передайте значение 'simple' для получения необходимой информации |
{- "items": [
- {
- "id": 1100,
- "name": "Т-Банк Jump.Finance",
- "balance": 245103.54,
- "synced_at": "2021-03-18T12:12:08+03:00"
}
]
}
Получение информации по определенному счёту
bank_account_id required | string Уникальный идентификатор счета |
{- "item": {
- "id": 1100,
- "name": "Т-Банк Jump.Finance",
- "balance": 245103.54,
- "synced_at": "2021-03-18T12:12:08+03:00"
}
}
Запрашивает обновление балансов всех банковских счетов. Команду возможно запускать не чаще одного раза в три минуты.
{- "item": {
- "item": {
- "id": 79433,
- "created_at": "2021-03-18T12:12:08+03:00"
}
}
}
Получение информации по запросу обновления банковских счетов
sync_balances_status_id required | string Идентификатор запроса на синхронизацию |
{ }
Возвращает все внутренние балансы компании
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "name": "Реферальные бонусы",
- "is_active": true
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Создать выплату с одновременным созданием получателя. Поля в запросе не должны содержать номер банковской карты, кроме поля account_number в requesite.
customer_payment_id | string <= 36 characters Идентификатор выплаты в системе клиента. Идентификатор не должен содержать номер карты. Два платежа с одним и тем же идентификатором не могут быть созданы в системе. Идентификатор может содержать только латинские буквы, цифры, пробелы и символы -_.!:*()[]@$~`^,;=<>|{}‘. |
phone required | string Номер телефона получателя |
last_name required | string Фамилия получателя |
first_name required | string Имя получателя |
middle_name | string Отчество получателя |
required | СБП по номеру телефона (object) or Карта банка по номеру карты (object) or Карта банка по uuid карты (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 Идентификатор филиала с которого была создана выплата |
{- "customer_payment_id": "string",
- "phone": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "requisite": {
- "type_id": 0,
- "account_number": "string",
- "sbp_bank_id": 0
}, - "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": {
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string"
}, - "branch_office_id": 0
}
{- "item": {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
}
По умолчанию мы создаем выплату от юрлица, которому принадлежит исполнитель. Вы можете переопределить это поведение, явно передав идентификатор юрлица в параметре agent_id. Для компаний, поддерживающих работу с несколькими балансами исполнителей, если передан balance_id, то выплата будет создана на юрлицо переданного баланса, и переопредилить юрлицо у выплаты будет нельзя. Зачисление денежных средств осуществляется только на банковские карты, выпущенные в РФ. Если не передать ни requisite_id, ни requisite, то при создании выплаты будет использоваться реквизит исполнителя по умолчанию. Результат запроса на выплату можно получить, вызвав метод Получить информацию по выплате, передав в него соответствующий payment_id. Поля в запросе не должны содержать номер банковской карты, кроме поля account_number в requesite.
Создает новую выплату
Карта банка по номеру телефона (object) or Карта банка по номеру карты (object) or Карта банка по номеру карты (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 Назначение платежа для банковской выписки. Не должно содержать номер банковской карты. Доступно для выплат по номеру карты 125 символов, по номеру телефона – 109 символов. |
balance_id | integer or null идентификатор баланса |
requisite_id | integer or null Идентификатор реквизита |
object or null Данные для проверки в СБП платеже | |
object or null Данные для создания акта по выплате | |
object or null Информация о покупателе (используется для формирования чеков самозанятых исполнителей) | |
fix_commission | number or null удержание фиксированное(не больше суммы выплаты) |
percent_commission | number or null удержание в процентах |
{- "requisite": {
- "type_id": 8,
- "account_number": "5469550053219652"
}, - "contractor_id": 123,
- "amount": 100,
- "agent_id": 61,
- "service_name": "наименование услуг для чека ФНС (только для самозанятых). Не должно содержать номер банковской карты. Доступно 150 символов.",
- "payment_purpose": "назначение платежа для банковской выписки. Не должно содержать номер банковской карты. Доступно для выплат по номеру карты 125 символов",
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad"
}
{- "item": {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
}
Возвращает все выплаты
include | string Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator
|
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 Количество элементов на странице |
{- "items": [
- {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Повтор выплаты.
Чтобы узнать, можно ли повторить выплату, выполните запрос на получение выплаты/списка выплат с параметром ?include=abilities. За возможность повторения выплаты отвечает свойство abilities.can_repeat.
payment_id required | integer Id выплаты для повтора |
{- "item": {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
}
Статус выплаты имеет смысл запрашивать с периодичностью не чаще одного раза в минуту до получения флага is_final.
payment_id required | integer Id выплаты, по которой запрашивается информация |
include | string Example: include=act,branch_office Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator
|
{- "item": {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
}
Статус выплаты имеет смысл запрашивать с периодичностью не чаще одного раза в минуту до получения флага is_final.
customer_payment_id required | integer Идентификатор выплаты в системе клиента. Значение должно быть в URL-encoded формате, так как некоторые символы могут быть неправильно интерпретированы на принимающей стороне. |
include | string Example: include=act,branch_office Дополнительно к существующим полям можно запросить дополнительную информацию по выплате. Поля передаются через запятую: include=requisite,creator
|
{- "item": {
- "id": 15731787,
- "amount": 101,
- "amount_paid": 74,
- "commission": 20,
- "commission_bank": 14.8,
- "tax_amount": 6,
- "is_final": false,
- "branch_office_id": 1,
- "receipt": {
- "can_cancel": true,
- "cancel_reason": null,
- "key": "2008kkz4ga",
- "status": "active",
- "operation_at": "2021-08-25T15:48:43+03:00",
- "links": {
- "fns_url": "https:\\lknpd.nalog.ru\u0007pi\u000b1\receipt/540450204860/201jgrucjf/print",
}
}, - "status": {
- "id": 3,
- "title": "в обработке",
- "theme": "warning"
}, - "error": null,
- "payment_purpose": null,
- "customer_payment_id": "9f0bb7b7-e5cd-4725-8080-4c230ec702ad",
- "contractor": {
- "id": 68,
- "phone": "+71231230000",
- "full_name": "Вера Илья Клавдия",
- "short_name": "Вера И.К."
}, - "requisite": {
- "id": 273243,
- "icon": {
- "overlay": true
}, - "title": "Карта",
- "description": "Mastercard · 8085"
}, - "creator": {
- "id": 496,
- "full_name": "Карат"
}, - "agent": {
- "id": 1,
- "full_name": "end-to-end deliver web-readiness"
}, - "history": [
- {
- "message": "Поставлен в очередь",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}, - {
- "message": "Создан. Карат (id:496)",
- "detail": null,
- "updated_at": "2021-03-18T12:12:08+03:00"
}
], - "act": {
- "id": 1,
- "status": {
- "id": "signed",
- "title": "Подписан"
}
}, - "nominal_info": {
- "is_holded": true
}, - "abilities": {
- "can_approve": true,
- "can_confirm": true,
- "can_repeat": true,
- "can_refund": true,
- "can_cancel": true,
- "can_add_files": true,
- "can_edit": true,
- "can_edit_requisite": true
}, - "created_at": "2021-03-18T12:12:08+03:00"
}
}
У компании может быть только одна группа по умолчанию
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "name": "По умолчанию",
- "is_default": true
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает все интеграции компании
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "name": "Внутреннее название интеграции",
- "aggregator": {
- "id": 6,
- "name": "Яндекс.Про"
}, - "agent": {
- "id": 1,
- "name": "Название юрлица"
}, - "default_group": {
- "id": 1,
- "name": "По умолчанию"
}, - "is_active": true,
- "is_login_success": true,
- "integration_start_date": "2019-06-11T13:30:02+03:00"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Данные методы предназначены для получения и создания исполнителей. Исполнители выполняют работы и получают за это оплату.
Исполнитель ищется по номеру телефона. Если исполнителя еще нет в системе, он будет создан. При наличии исполнителя, он будет обновлен. Номер телефона является уникальным в системе и однозначно идентифицирует каждого исполнителя.
Создает нового или обновляет существуещего исполнителя
phone required | string телефон в формате +79000000000 |
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 уплачивать ли налоги за самозанятого |
{- "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
}
{- "item": {
- "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": {
- "value": 0,
- "currency": {
- "code": "RUB",
- "symbol": "₽",
- "title": "Российский рубль",
- "unicode": "\\u20BD"
}
}, - "agent": {
- "id": 123,
- "name": "ООО Фаворит"
}, - "legal_form": {
- "id": 1,
- "title": "Физическое лицо",
- "is_self_employed": false
}
}
}
Список всех истоплнителей с пагинацией
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "phone": "+79031112233",
- "last_name": "Константинопольский",
- "first_name": "Константин",
- "middle_name": "Константинович",
- "legal_form_id": 1,
- "inn": "1234567892",
- "agent_id": 1,
- "balance": {
- "value": 120.34,
- "currency": {
- "code": "RUB",
- "symbol": "₽",
- "title": "Российский рубль",
- "unicode": "\\u20BD"
}
}, - "agent": {
- "id": 1,
- "name": "seamless grow ROI"
}, - "legal_form": {
- "id": 1,
- "title": "Физическое лицо",
- "is_self_employed": false
}, - "is_editable": true,
- "created_at": "2021-03-12T14:06:47+03:00",
- "updated_at": "2021-03-12T14:06:47+03:00"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает карточку исполнителя
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "item": {
- "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": {
- "value": 0,
- "currency": {
- "code": "RUB",
- "symbol": "₽",
- "title": "Российский рубль",
- "unicode": "\\u20BD"
}
}, - "agent": {
- "id": 123,
- "name": "ООО Фаворит"
}, - "legal_form": {
- "id": 1,
- "title": "Физическое лицо",
- "is_self_employed": false
}
}
}
Удаляет исполнителя
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Обновление исполнителя
phone required | string телефон в формате +79000000000 |
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 уплачивать ли налоги за самозанятого |
{- "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
}
{- "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": {
- "value": 0,
- "currency": {
- "code": "RUB",
- "symbol": "₽",
- "title": "Российский рубль",
- "unicode": "\\u20BD"
}
}, - "agent": {
- "id": 123,
- "name": "ООО Фаворит"
}, - "legal_form": {
- "id": 1,
- "title": "Физическое лицо",
- "is_self_employed": false
}
}
Создает реквизиты исполнителя
contractor_id required | string Уникальный идентификатор исполнителя |
Создает реквизиты
account_number required | string Номер карты |
type_id required | number Value: 8 Тип реквизита |
object (Данные карты) |
{- "type_id": 8,
- "account_number": "5469550053219652",
- "card": {
- "uuid": "01961059-100e-7ff6-9a51-13d3461d5bbf"
}
}
{- "item": {
- "id": 0,
- "display_name": "Visa",
- "description": "411111******1111",
- "type": {
- "id": 8,
- "slug": "bank_card",
- "title": "Карта банка по номеру карты"
}, - "icon": {
- "overlay": true
}, - "is_available": true,
- "is_default": true,
- "requisite": {
- "bank_name": null,
- "account_number": "411111******1111",
- "card": {
- "uuid": "0193d582-06fe-71e6-9262-7a8844c34f7a",
- "mask": "411111******1111"
}, - "payment_text": null,
- "bik": null,
- "sbp_bank_id": null,
- "inn": null,
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string"
}, - "created_at": "string"
}
}
Возвращает реквизиты исполнителя
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
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 Количество элементов на странице |
{- "items": [
- {
- "id": 0,
- "display_name": "Visa",
- "description": "411111******1111",
- "type": {
- "id": 8,
- "slug": "bank_card",
- "title": "Карта банка по номеру карты"
}, - "icon": {
- "overlay": true
}, - "is_available": true,
- "is_default": true,
- "requisite": {
- "bank_name": null,
- "account_number": "411111******1111",
- "card": {
- "uuid": "0193d582-06fe-71e6-9262-7a8844c34f7a",
- "mask": "411111******1111"
}, - "payment_text": null,
- "bik": null,
- "sbp_bank_id": null,
- "inn": null,
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string"
}, - "created_at": "string"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает балансы исполнителя
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
include | string Дополнительно к существующим полям можно запросить дополнительную информацию по балансу. Пример: include=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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "balance": 100,
- "frozen_balance": 0,
- "type": {
- "id": 6,
- "name": "Яндекс.Про"
}, - "integration": {
- "id": 1,
- "name": "Внутреннее название интеграции"
}, - "customer_balance": null,
- "agent": {
- "id": 1,
- "name": "Название юрлица"
}, - "created_at": "2019-06-11T13:30:02+03:00"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает баланс исполнителя
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
balance_id required | integer <int64> Уникальный идентификатор баланса |
include | string Дополнительно к существующим полям можно запросить дополнительную информацию по балансу. Пример: include=agent
|
{- "item": {
- "id": 1,
- "balance": 100,
- "frozen_balance": 0,
- "type": {
- "id": 6,
- "name": "Яндекс.Про"
}, - "integration": {
- "id": 1,
- "name": "Внутреннее название интеграции"
}, - "customer_balance": null,
- "agent": {
- "id": 1,
- "name": "Название юрлица"
}, - "created_at": "2019-06-11T13:30:02+03:00"
}
}
Не делает запрос в налоговую, возвращает текущее состояние самозанятого.
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "item": {
- "inn": "960215602664",
- "is_can_pay_taxes": false,
- "is_verified": true,
- "has_company_agrees_pay_taxes": true,
- "has_warning": true,
- "sync": {
- "in_process": false
}, - "messages": {
- "status": {
- "type": "error",
- "short_title": "Требуется разрешение",
- "detail": "Исполнитель должен подтвердить разрешение на уплату налогов в личном кабинете налогоплательщика или мобильном приложение «Мой налог» в разделе «Партнёры»."
}
}
}, - "": "string"
}
Отправляет запрос в налоговую для того чтобы проверить, подтвердил ли самозанятый необходимые разрешения. Возвращает ту же модель, что и метод GET /contractors/{contractor_id}/selfemployer/ После этого запроса можно запустить опрос метода GET по таймауту (например каждые 2 сек), до тех пор, пока в ответе sync.in_process === true Данный метод защищен от многократного запуска. Для одного исполнителя можно запрашивать метод POST не чаще чем один раз в 30 сек.
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "item": {
- "inn": "960215602664",
- "is_can_pay_taxes": false,
- "is_verified": true,
- "has_company_agrees_pay_taxes": true,
- "has_warning": true,
- "sync": {
- "in_process": false
}, - "messages": {
- "status": {
- "type": "error",
- "short_title": "Требуется разрешение",
- "detail": "Исполнитель должен подтвердить разрешение на уплату налогов в личном кабинете налогоплательщика или мобильном приложение «Мой налог» в разделе «Партнёры»."
}
}
}
}
contractor_id required | integer Идентификатор исполнителя |
view | string Enum: "simple" "passport" Вариант представления возвращаемых данных |
Принудительно идентифицирует исполнителя
country required | string Код страны в формате ISO 3166-1 alpha-3 в нижнем регистре |
is_verified | boolean Является верифицированным |
snils | string СНИЛС |
inn | string ИНН |
object Паспортные данные |
{- "country": "rus",
- "is_verified": true,
- "snils": 12345678901,
- "inn": 123456789012,
- "passport": {
- "first_name": "Иван",
- "last_name": "Иванов",
- "middle_name": "Иванович",
- "gender": "male",
- "number": "1234 123456",
- "department_name": "МВД по г. Москва",
- "department_code": 170001,
- "issued_at": "01.01.1990",
- "birthdate": "01.01.1990",
- "birthdate_place": "г. Москва",
- "address": {
- "full_address": "РОССИЯ, 140000, Московская обл, г Химки, ул Советская, д. 22, к. 2, кв. 30",
- "detailed": {
- "zip_code": 140000,
- "country": {
- "name": "РОССИЯ",
- "code": 643
}, - "area": {
- "name": "Московская",
- "type": "обл"
}, - "city": {
- "name": "Химки",
- "type": "г"
}, - "street": {
- "name": "Советская",
- "type": "ул"
}, - "house": {
- "number": 22,
- "type": "Дом"
}, - "buildings": [
- {
- "number": 2,
- "type": "Корпус"
}
], - "apartment": {
- "number": 30,
- "type": "Квартира"
}
}
}
}
}
{- "item": {
- "id": 1,
- "contractor_id": 1,
- "company_id": 1,
- "agent_id": 1,
- "status": "approved",
- "is_verified": true
}
}
Возвращает информацию о последнем одобренном запросе на идентификацию
contractor_id required | string Идентификатор исполнителя |
view | string Enum: "simple" "passport" Вариант представления возвращаемых данных |
{- "item": {
- "id": 1,
- "contractor_id": 1,
- "company_id": 1,
- "agent_id": 1,
- "status": "approved",
- "is_verified": true
}
}
Данные методы предназначены для создания связи между юрлицом и исполнителем. Сотрудничество исполнителя с юрлицом позволяет отправлять и подписывать документы с несколькими юрлицами, в которых исполнитель оказывает услугу. Если исполнитель работает через одно юрлицо, данные методы можно не использовать.
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "items": [
- {
- "id": 1,
- "agent": {
- "id": 1,
- "name": "string"
}, - "legal_form": {
- "id": 1,
- "name": "string"
}
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Создает новое сотдрудничество
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
Создает новое сотрудничество
agent_id required | integer идентификатор юрлица |
legal_form_id required | integer идентификатор правового статуса (1 - физическое лицо, 2 - самозанятый, 3 - индивидуальный предприниматель) |
{- "agent_id": 1,
- "legal_form_id": 1
}
{- "item": {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "legal_form": {
- "id": 0,
- "name": "string"
}
}
}
Возвращает сотрудничество
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
cooperation_id required | integer <int64> Уникальный идентификатор сотрудничества |
{- "item": {
- "id": 1,
- "agent": {
- "id": 1,
- "name": "string"
}, - "legal_form": {
- "id": 1,
- "name": "string"
}
}
}
Удаляет сотрудничество
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
cooperation_id required | integer <int64> Уникальный идентификатор сотрудничества |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Не делает запрос в налоговую, возвращает текущее состояние самозанятого.
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "item": {
- "inn": "960215602664",
- "is_can_pay_taxes": false,
- "is_verified": true,
- "has_company_agrees_pay_taxes": true,
- "has_warning": true,
- "sync": {
- "in_process": false
}, - "messages": {
- "status": {
- "type": "error",
- "short_title": "Требуется разрешение",
- "detail": "Исполнитель должен подтвердить разрешение на уплату налогов в личном кабинете налогоплательщика или мобильном приложение «Мой налог» в разделе «Партнёры»."
}
}
}, - "": "string"
}
Отправляет запрос в налоговую для того чтобы проверить, подтвердил ли самозанятый необходимые разрешения. Возвращает ту же модель, что и метод GET /contractors/{contractor_id}/selfemployer/ После этого запроса можно запустить опрос метода GET по таймауту (например каждые 2 сек), до тех пор, пока в ответе sync.in_process === true Данный метод защищен от многократного запуска. Для одного исполнителя можно запрашивать метод POST не чаще чем один раз в 30 сек.
contractor_id required | integer <int64> Уникальный идентификатор исполнителя |
{- "item": {
- "inn": "960215602664",
- "is_can_pay_taxes": false,
- "is_verified": true,
- "has_company_agrees_pay_taxes": true,
- "has_warning": true,
- "sync": {
- "in_process": false
}, - "messages": {
- "status": {
- "type": "error",
- "short_title": "Требуется разрешение",
- "detail": "Исполнитель должен подтвердить разрешение на уплату налогов в личном кабинете налогоплательщика или мобильном приложение «Мой налог» в разделе «Партнёры»."
}
}
}
}
Данные методы предназначены для получения и создания юрлиц. Как правило, при регистрации в сервисе, первое юрлицо создается автоматически. Если вы работаете через одно юрлицо, достаточно получить его ID и использовать для всех исполнителей.
Создание юрлица
Создает новое юрлицо
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 Отчество (используется для актов у ИП) |
{- "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": "Иванович"
}
{- "item": {
- "id": 123,
- "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": "Иванович",
- "updated_at": "2021-03-15T11:34:44+03:00"
}
}
Возвращает список всех юрлиц
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 Количество элементов на странице |
{- "items": [
- {
- "id": 123,
- "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": "Иванович",
- "updated_at": "2021-03-15T11:34:44+03:00"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает карточку юрлица
agent_id required | integer <int64> Уникальный идентификатор юрлица |
{- "item": {
- "id": 123,
- "name": "ООО Фаворит",
- "inn": "5406678646",
- "ogrn": "1115476092687",
- "address": "г Новосибирск, ул. Фрунзе, 8",
- "updated_at": "2021-03-15T11:34:44+03:00"
}
}
Обновляет информацию юрлица
agent_id required | integer Id юрлица |
Редактирует данные юрлица
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 Отчество (используется для актов у ИП) |
{- "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": "Иванович"
}
{- "item": {
- "id": 123,
- "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": "Иванович",
- "updated_at": "2021-03-15T11:34:44+03:00"
}
}
Обновляет информацию юрлица
agent_id required | integer Id юрлица |
Редактирует данные юрлица
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 Отчество (используется для актов у ИП) |
{- "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": "Иванович"
}
{- "item": {
- "id": 123,
- "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": "Иванович",
- "updated_at": "2021-03-15T11:34:44+03:00"
}
}
Получение списка филиалов
agent_id | integer <int64> Уникальный идентификатор Юр. лица |
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1234,
- "name": "Филиал 1",
- "address": "г. Москва, ул. Ленина, д. 1",
- "limit_monthly": 100000,
- "limit_daily": 10000,
- "is_active": true,
- "agent": {
- "id": 1234,
- "name": "ООО Карат Тест"
}
}
]
}
Редактирование филиала
Редактирует существующий филиал
agent_id | integer Идентификатор юридического лица |
name | string Название филиала |
address | string Адрес филиала |
limit_monthly | number Default: null Лимит на месяц по филиалу (null безлимит) |
limit_daily | number Default: null Лимит на день по филиалу (null безлимит) |
is_active | integer Флаг активности филиала (1 - активен, 0 - выключен) |
{- "agent_id": 0,
- "name": "string",
- "address": "string",
- "limit_monthly": null,
- "limit_daily": null,
- "is_active": 0
}
{- "item": {
- "id": 1234,
- "name": "Филиал 1",
- "address": "г. Москва, ул. Ленина, д. 1",
- "limit_monthly": 100000,
- "limit_daily": 10000,
- "is_active": true,
- "agent": {
- "id": 1234,
- "name": "ООО Карат Тест"
}
}
}
Возвращает список отделов юрлиц
name | string Фильтр по названию отдела |
with_trashed | boolean Включить в выборку удаленные записи |
only_trashed | boolean Делать выборку только из удаленных записей |
order | string Enum: "id" "-id" "parent_id" "-parent_id" Сортировка записей |
agent_id | integer Фильтр по юрлицу |
{- "items": [
- {
- "id": 0,
- "name": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "parent_id": 0,
- "is_root": true,
- "is_deleted": true
}
]
}
Создаёт отдел юрлица
name required | string Название отдела юрлица |
agent_id required | integer ИД юрлица |
parent_id | integer or null ИД родительского отдела юрлица |
{- "name": "string",
- "agent_id": 0,
- "parent_id": 0
}
{- "item": {
- "id": 0,
- "name": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "parent_id": 0,
- "is_root": true,
- "is_deleted": true
}
}
Возвращает отдел юрлица
department_id required | integer ИД отдела юрлица |
{- "item": {
- "id": 0,
- "name": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "parent_id": 0,
- "is_root": true,
- "is_deleted": true
}
}
Обновляет информацию отдела юрлица
department_id required | integer ИД отдела юрлица |
name required | string Название отдела юрлица |
parent_id required | integer or null ИД родительского отдела юрлица |
{- "name": "string",
- "parent_id": 0
}
{- "item": {
- "id": 0,
- "name": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "parent_id": 0,
- "is_root": true,
- "is_deleted": true
}
}
Удаляет отдел юрлица
department_id required | integer ИД отдела юрлица |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Возвращает список должностей
name | string Фильтр по названию должности |
with_trashed | boolean Включить в выборку удаленные записи |
only_trashed | boolean Делать выборку только из удаленных записей |
order | string Enum: "id" "-id" "name" "-name" Сортировка записей |
{- "items": [
- {
- "id": 0,
- "name": "string",
- "is_deleted": true
}
]
}
Создаёт должность
name required | string Название должности |
{- "name": "string"
}
{- "item": {
- "id": 0,
- "name": "string",
- "is_deleted": true
}
}
Обновляет информацию должности
position_id required | integer ИД должности |
name required | string Название должности |
{- "name": "string"
}
{- "item": {
- "id": 0,
- "name": "string",
- "is_deleted": true
}
}
Удаляет должность
position_id required | integer ИД должности |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Возвращает данные штатного сотрудника по номеру телефона
phone required | string Фильтр по номеру телефона исполнителя |
include | string Example: include=workplaces Дополнительные данные, которые необходимо получить вместе со штатным сотрудником |
{- "items": [
- {
- "id": 0,
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "avatar": {
- "normal": "string",
- "url": "string",
- "overlay": true
}, - "inn": "string",
- "group": {
- "id": 0,
- "name": "string"
}, - "is_employee": true,
- "legal_form": {
- "id": 0,
- "title": "string"
}, - "identification": {
- "value": true,
- "identified_at": "2019-08-24T14:15:22Z"
}, - "citizenship": {
- "value": "string",
- "title": "string"
}, - "workplaces": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
include | string Example: include=workplaces Дополнительные данные, которые необходимо получить вместе со штатным сотрудником |
Создает нового штатного сотрудника
inn | string or null |
phone required | string телефон в формате +79000000000 |
string or null Адрес электронной почты | |
last_name required | string фамилия |
first_name required | string имя |
middle_name | string or null отчество |
required | Array of objects (EmployeeWorkplaceStoreRequest) |
{- "inn": "string",
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "workplaces": [
- {
- "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"
}
]
}
{- "item": {
- "id": 0,
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "avatar": {
- "normal": "string",
- "url": "string",
- "overlay": true
}, - "inn": "string",
- "group": {
- "id": 0,
- "name": "string"
}, - "is_employee": true,
- "legal_form": {
- "id": 0,
- "title": "string"
}, - "identification": {
- "value": true,
- "identified_at": "2019-08-24T14:15:22Z"
}, - "citizenship": {
- "value": "string",
- "title": "string"
}, - "workplaces": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Список всех штатных сотрудников с пагинацией
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 Дополнительные данные, которые необходимо получить вместе со штатным сотрудником |
{- "items": [
- {
- "id": 0,
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "avatar": {
- "normal": "string",
- "url": "string",
- "overlay": true
}, - "inn": "string",
- "group": {
- "id": 0,
- "name": "string"
}, - "is_employee": true,
- "legal_form": {
- "id": 0,
- "title": "string"
}, - "identification": {
- "value": true,
- "identified_at": "2019-08-24T14:15:22Z"
}, - "citizenship": {
- "value": "string",
- "title": "string"
}, - "workplaces": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
include | string Example: include=workplaces Дополнительные данные, которые необходимо получить вместе со штатным сотрудником |
{- "item": {
- "id": 0,
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "avatar": {
- "normal": "string",
- "url": "string",
- "overlay": true
}, - "inn": "string",
- "group": {
- "id": 0,
- "name": "string"
}, - "is_employee": true,
- "legal_form": {
- "id": 0,
- "title": "string"
}, - "identification": {
- "value": true,
- "identified_at": "2019-08-24T14:15:22Z"
}, - "citizenship": {
- "value": "string",
- "title": "string"
}, - "workplaces": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
include | string Example: include=workplaces Дополнительные данные, которые необходимо получить вместе со штатным сотрудником |
Редактирует данные штатного сотрудника
phone required | string телефон в формате +79000000000 |
string or null Адрес электронной почты | |
last_name required | string фамилия |
first_name required | string имя |
middle_name | string or null отчество |
{- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string"
}
{- "item": {
- "id": 0,
- "phone": "string",
- "email": "string",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "avatar": {
- "normal": "string",
- "url": "string",
- "overlay": true
}, - "inn": "string",
- "group": {
- "id": 0,
- "name": "string"
}, - "is_employee": true,
- "legal_form": {
- "id": 0,
- "title": "string"
}, - "identification": {
- "value": true,
- "identified_at": "2019-08-24T14:15:22Z"
}, - "citizenship": {
- "value": "string",
- "title": "string"
}, - "workplaces": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
Редактирует данные штатного сотрудника
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 Ид производственного календаря |
{- "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"
}
{- "item": {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
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 Количество элементов на странице |
{- "item": {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
workplace_id required | integer <int64> Уникальный идентификатор места работы |
{- "items": [
- {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
workplace_id required | integer <int64> Уникальный идентификатор места работы |
{- "item": {
- "id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "can_sign_as_manager": true,
- "employment_date": "2019-08-24T14:15:22Z",
- "dismissal_date": "2019-08-24T14:15:22Z"
}
}
Метод получает на вход список мест работы сотрудника. Если в переданном списке есть новые места работы, о которых система еще не знает, - сотрудник устраивается на эти места работы. Если в системе есть места работы, которые не присутсвуют в переданном списке, - сотрудник уволняется с этих мест работы. Данные по оставшимся местам работы обновляются
employee_id required | integer <int64> Уникальный идентификатор штатного сотрудника |
agent_id | string Список ИД юр. лиц, в рамках которого должна произойти синхронизация мест работы штатных сотрудников. Если не передано, синхронизация проходит в рамках всех юр. лиц компании. |
required | Array of objects (EmployeeWorkplaceStoreRequest) |
{- "agent_id": "1,2,3",
- "workplaces": [
- {
- "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"
}
]
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Возвращает список типов документов
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" Сортировка записей |
{- "items": [
- {
- "id": 0,
- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false,
- "company_id": 0,
- "is_deleted": true
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Создаёт тип документа
name required | string Название типа документа |
document_series | string or null <= 15 characters Название серии документов этого типа. Используется при генерации номеров документов |
document_code required | string <= 10 characters Код документа этого типа |
is_cancellable | boolean Default: false Можно ли аннулировать документы этого типа |
{- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false
}
{- "item": {
- "id": 0,
- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false,
- "company_id": 0,
- "is_deleted": true
}
}
Возвращает тип документа
document_type_id required | integer ИД типа документа |
{- "item": {
- "id": 0,
- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false,
- "company_id": 0,
- "is_deleted": true
}
}
Обновляет информацию типа документа
document_type_id required | integer ИД типа документа |
name required | string Название типа документа |
document_series | string or null <= 15 characters Название серии документов этого типа. Используется при генерации номеров документов |
document_code required | string <= 10 characters Код документа этого типа |
is_cancellable | boolean Default: false Можно ли аннулировать документы этого типа |
{- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false
}
{- "item": {
- "id": 0,
- "name": "string",
- "document_series": "string",
- "document_code": "string",
- "is_cancellable": false,
- "company_id": 0,
- "is_deleted": true
}
}
Удаляет тип документа
document_type_id required | integer ИД типа документа |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Возвращает список документов
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) |
{- "items": [
- {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "manual_series": "string",
- "manual_number": "string",
- "series": "string",
- "number": 0,
- "date": "string",
- "hash": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "document_type": {
- "id": 0,
- "name": "string"
}, - "author": {
- "id": 0,
- "name": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "sign_order": {
- "value": "arbitrary",
- "name": "string"
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "manager_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "employee_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "signature_deadline": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Создаёт документ
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 |
{- "item": {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "manual_series": "string",
- "manual_number": "string",
- "series": "string",
- "number": 0,
- "date": "string",
- "hash": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "document_type": {
- "id": 0,
- "name": "string"
}, - "author": {
- "id": 0,
- "name": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "sign_order": {
- "value": "arbitrary",
- "name": "string"
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "manager_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "employee_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "signature_deadline": "2019-08-24T14:15:22Z"
}
}
Создаёт документ на основе шаблона
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) Этапы документа |
{- "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": [
- {
- "placeholder_code": "string",
- "value": "string"
}
], - "stages": [
- {
- "order": 0,
- "type": "approval",
- "approval_logic": "all",
- "approvers": [
- {
- "type": "contractor",
- "id": 0,
- "position_id": 0
}
]
}
]
}
{- "item": {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "manual_series": "string",
- "manual_number": "string",
- "series": "string",
- "number": 0,
- "date": "string",
- "hash": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "document_type": {
- "id": 0,
- "name": "string"
}, - "author": {
- "id": 0,
- "name": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "sign_order": {
- "value": "arbitrary",
- "name": "string"
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "manager_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "employee_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "signature_deadline": "2019-08-24T14:15:22Z"
}
}
Возвращает документ
document_id required | integer ИД документа |
{- "item": {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "manual_series": "string",
- "manual_number": "string",
- "series": "string",
- "number": 0,
- "date": "string",
- "hash": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "document_type": {
- "id": 0,
- "name": "string"
}, - "author": {
- "id": 0,
- "name": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "sign_order": {
- "value": "arbitrary",
- "name": "string"
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "manager_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "employee_signatures": [
- {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
], - "signature_deadline": "2019-08-24T14:15:22Z"
}
}
Возвращает оригинальный файл документа
document_id required | integer ИД документа |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Возвращает архив подписанного документа
document_id required | integer ИД документа |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Создает акт
Создает новый акт
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 Виды работ |
{- "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": [
- {
- "name": "Ремонт",
- "price": 100,
- "count": 5,
- "measure_id": 1
}, - {
- "name": "Перевозка стройматериалов",
- "price": 1000,
- "count": 4,
- "measure_id": 1
}
]
}
{- "item": {
- "id": 1,
- "name": "Акт выполненных работ",
- "number": 42,
- "status": "in_processing",
- "total_price": 420.28,
- "period_from": "2024-06-01",
- "period_to": "2024-06-01",
- "description": "Lorem ipsum",
- "abilities": {
- "can_sign": true,
- "can_delete": false
}, - "created_at": "2019-08-24T14:15:22Z"
}
}
Возвращает список актов
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 |
created_at_from | string Начало периода создания акта. Формат: YYYY-MM-DD |
created_at_to | string Конец периода создания акта. Формат: YYYY-MM-DD |
{- "items": [
- {
- "id": 1,
- "name": "Акт выполненных работ",
- "number": 42,
- "status": "in_processing",
- "total_price": 420.28,
- "period_from": "2024-06-01",
- "period_to": "2024-06-01",
- "description": "Lorem ipsum",
- "abilities": {
- "can_sign": true,
- "can_delete": false
}, - "created_at": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Возвращает акт
act_id required | integer ИД акта |
{- "item": {
- "id": 1,
- "name": "Акт выполненных работ",
- "number": 42,
- "status": "in_processing",
- "total_price": 420.28,
- "period_from": "2024-06-01",
- "period_to": "2024-06-01",
- "description": "Lorem ipsum",
- "abilities": {
- "can_sign": true,
- "can_delete": false
}, - "created_at": "2019-08-24T14:15:22Z"
}
}
Возвращает список шаблонов актов
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 Количество элементов на странице |
{- "items": [
- {
- "id": 1,
- "name": "Акт для курьеров",
- "agent": {
- "id": 1,
- "name": "ООО Какие люди"
}, - "sign_order": {
- "title": "Обе стороны",
- "value": "arbitrary"
}, - "manager_contractor": {
- "id": 1,
- "short_name": "Константинопольский К. К."
}
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": null,
- "prev_page_url": null
}
}
Передать результат подписи документа на клиенте при помощи КриптоПро
signature_id required | integer ИД подписи |
value required | string |
object |
{- "value": "string",
- "additional": {
- "certificate": {
- "id": "string",
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "issuer": {
- "name": "string"
}, - "owner": {
- "agent": "string",
- "inn": "059627371179,174582707778,730408357502",
- "name": "string",
- "position": "string"
}
}, - "file_for_sign": {
- "sha256": "string"
}, - "hash_file_signed": true
}
}
{- "item": {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
}
Отказаться от подписи документа
signature_id required | integer ИД подписи |
reject_reason required | string Причина отказа от подписания. |
{- "reject_reason": "Пример причины отказа от подписания."
}
{- "item": {
- "id": 0,
- "signed_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "full_name": "string",
- "short_name": "string",
- "phone": "string",
- "role": "employee",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "status": {
- "value": "pending",
- "name": "string"
}, - "provider": {
- "value": "simple",
- "name": "string"
}, - "reject_reason": "string",
- "rejected_at": "2019-08-24T14:15:22Z"
}
}
required | Array of objects |
{- "data": [
- {
- "agent_id": 0,
- "employee_id": 0,
- "remaining_vacation_days": 0.1
}
]
}
Метод позволяет передать график отпусков штатных сотрудников компании из внешней системы. Отсутствующие в сервисе отпуска будут добавлены, а присутствующие в сервисе, но отсутствующие в запросе – удалены из сервиса. Период синхронизации будет ограничен годом, указанным в запросе, поэтому следует присылать только отпуска за указанный год. В запросе нужно передавать не более 100 штатных сотрудников.
required | Array of objects |
year required | integer Год, в рамках которого производится синхронизация отпусков |
{- "items": [
- {
- "employee_id": 0,
- "workplaces": [
- {
- "agent_id": 0,
- "department_id": 0,
- "position_id": 0,
- "vacations": [
- {
- "vacation_kind_id": "string",
- "date_from": "2019-08-24",
- "date_to": "2019-08-24",
- "vacation_days": 0
}
]
}
]
}
], - "year": 2023
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
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> Максимальная дата начала отпуска |
{- "items": [
- {
- "id": "string",
- "company_id": 0,
- "employee_id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "vacation_kind": {
- "id": "string",
- "name": "string"
}, - "date_from": "2019-08-24",
- "date_to": "2019-08-24",
- "vacation_days": 0
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
vacation_id required | string |
include | string Example: include=agent,department,position,vacation_kind Вывод дополнительной информации |
{- "item": {
- "id": "string",
- "company_id": 0,
- "employee_id": 0,
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "vacation_kind": {
- "id": "string",
- "name": "string"
}, - "date_from": "2019-08-24",
- "date_to": "2019-08-24",
- "vacation_days": 0
}
}
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 Количество элементов на странице |
{- "items": [
- {
- "id": "string",
- "name": "string",
- "company_id": 0
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
name required | string Название вида отпуска |
{- "name": "string"
}
{- "item": {
- "id": "string",
- "name": "string",
- "company_id": 0
}
}
vacation_kind_id required | string ИД вида отпуска |
name | string Название вида отпуска |
{- "name": "string"
}
{- "item": {
- "id": "string",
- "name": "string",
- "company_id": 0
}
}
Удаляет вид отпуска
vacation_kind_id required | string ИД вида отпуска |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Создаёт нового кандидата
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 Вывод дополнительной информации |
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 |
required | Array of objects = 1 characters Список мест работы (максимум одно) |
creator_email | string <= 255 characters E-mail сотрудника создавшего кандидата (на него будут приходить уведомления) |
{- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "workplaces": [
- {
- "agent_id": 0,
- "department_id": 0,
- "position_id": 0,
- "employment_date": "2019-08-24T14:15:22Z"
}
], - "creator_email": "string"
}
{- "item": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "employee_id": 0,
- "status": {
- "value": "string",
- "title": "string"
}, - "company": {
- "id": 0
}, - "workplaces": [
- {
- "id": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "employment_date": "2019-08-24T14:15:22Z"
}
], - "checklist": {
- "initial_data_filled": true,
- "questionnaire_sent": true,
- "questionnaire_filled": true,
- "employed": true
}, - "questionnaire": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
}
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 Был ли трудоустроен сотрудник |
{- "items": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "employee_id": 0,
- "status": {
- "value": "string",
- "title": "string"
}, - "company": {
- "id": 0
}, - "workplaces": [
- {
- "id": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "employment_date": "2019-08-24T14:15:22Z"
}
], - "checklist": {
- "initial_data_filled": true,
- "questionnaire_sent": true,
- "questionnaire_filled": true,
- "employed": true
}, - "questionnaire": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Получает данные кандидата
candidate_id required | string ИД кандидата |
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 Вывод дополнительной информации |
{- "item": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "employee_id": 0,
- "status": {
- "value": "string",
- "title": "string"
}, - "company": {
- "id": 0
}, - "workplaces": [
- {
- "id": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "employment_date": "2019-08-24T14:15:22Z"
}
], - "checklist": {
- "initial_data_filled": true,
- "questionnaire_sent": true,
- "questionnaire_filled": true,
- "employed": true
}, - "questionnaire": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
}
Обновляет персональные данные кандидата
candidate_id required | string ИД кандидата |
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 Вывод дополнительной информации |
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 |
{- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string"
}
{- "item": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "employee_id": 0,
- "status": {
- "value": "string",
- "title": "string"
}, - "company": {
- "id": 0
}, - "workplaces": [
- {
- "id": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "employment_date": "2019-08-24T14:15:22Z"
}
], - "checklist": {
- "initial_data_filled": true,
- "questionnaire_sent": true,
- "questionnaire_filled": true,
- "employed": true
}, - "questionnaire": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
}
Завершает трудоустройство кандидата
candidate_id required | string ИД кандидата |
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 Вывод дополнительной информации |
{- "item": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "email": "string",
- "employee_id": 0,
- "status": {
- "value": "string",
- "title": "string"
}, - "company": {
- "id": 0
}, - "workplaces": [
- {
- "id": "string",
- "agent": {
- "id": 0,
- "name": "string"
}, - "department": {
- "id": 0,
- "name": "string"
}, - "position": {
- "id": 0,
- "name": "string"
}, - "employment_date": "2019-08-24T14:15:22Z"
}
], - "checklist": {
- "initial_data_filled": true,
- "questionnaire_sent": true,
- "questionnaire_filled": true,
- "employed": true
}, - "questionnaire": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
}
Возвращает список типов документов для анкеты кандидата
{- "items": [
- {
- "code": "string",
- "title": "string"
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Создаёт анкету для кандидата
include | string Example: include=company,candidate,status,personal_data_processing_consent,requested_documents,requested_personal_data,eqes_issue_consent,eqes_issue_application Вывод дополнительной информации |
candidate_id required | string ИД кандидата |
requested_document_codes required | Array of strings Выбранные коды типов документов |
{- "candidate_id": "string",
- "requested_document_codes": [
- "string"
]
}
{- "item": {
- "id": "string",
- "company": {
- "id": 0
}, - "candidate": {
- "id": "string"
}, - "status": {
- "value": "string",
- "title": "string"
}, - "personal_data_processing_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "requested_documents": [
- {
- "id": "string",
- "title": "string",
- "description": "string",
- "types": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_type_code": "string",
- "is_required": true,
- "skip_reasons": [
- {
- "title": "string",
- "code": "string"
}
], - "selected_skip_reason_code": "string",
- "requested_files": {
- "can_candidate_add_files": true,
- "files": [
- {
- "id": "string",
- "title": "string",
- "file_name": "string",
- "is_permanent": true,
- "is_uploaded": true
}
]
}
}
], - "requested_personal_data": [
- {
- "id": "string",
- "title": "string",
- "type": "string",
- "code": "string",
- "value": "string",
- "is_required": true
}
], - "eqes_issue_consent": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "eqes_issue_application": {
- "id": "string",
- "document_id": 0,
- "is_signed": true
}, - "checklist": {
- "created": true,
- "sent_to_candidate": true,
- "personal_data_processing_consent_signed": true,
- "eqes_issue_consent_signed": true,
- "requested_documents_collection_completed": true,
- "requested_personal_data_collection_completed": true,
- "eqes_issue_application_signed": true
}
}
}
Импортирует расчетный лист
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. |
Получить список шаблонов заявлений
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 Порядок сортировки |
{- "items": [
- {
- "id": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "name": "string",
- "description": "string",
- "enable_author_comment": true,
- "attachment_settings": {
- "attachments_enabled": true,
- "attachments_description": "string"
}, - "placeholders": [
- {
- "code": "string",
- "type": "input",
- "title": "string",
- "description": "string"
}
]
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Получить список заявлений
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 Порядок сортировки |
{- "items": [
- {
- "id": "string",
- "company": {
- "id": 0
}, - "agent": {
- "id": 0,
- "name": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "template": {
- "id": "string",
- "name": "string"
}, - "document": {
- "id": 0
}, - "name": "string",
- "rejector_comment": "string",
- "author": {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "author_comment": "string",
- "status": {
- "title": "string",
- "value": "string"
}, - "created_at": "string",
- "substitutions": [
- {
- "placeholder_code": "string",
- "type": "input",
- "title": "string",
- "description": "string",
- "value": "string",
- "detail_value": {
- "date": "2019-08-24T14:15:22Z"
}
}
], - "approval_stages": [
- {
- "order": 0,
- "status": {
- "title": "string",
- "value": "pending"
}, - "approvals": [
- {
- "id": "string",
- "status": {
- "title": "string",
- "value": "pending"
}, - "approver": {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "phone": "string",
- "position": {
- "id": 0,
- "name": "string"
}
}, - "approver_comment": "string"
}
]
}
], - "attachment_settings": {
- "attachments_enabled": true,
- "attachments_description": "string"
}, - "attachments": [
- {
- "id": "string",
- "name": "string"
}
]
}
], - "meta": {
- "total": 1,
- "from": 1,
- "to": 1,
- "per_page": 20,
- "current_page": 1,
- "last_page": 1
}
}
Создает запрос на выпуск УНЭП штатным сотрудникам, подпадающим под выборку фильтра. Если поле ИД сотрудников в фильтре отсутствует, будет считаться, что в выборку должны попасть все штатные сотрудники компании. УНЭП будут выпущены только тем сотрудникам, которые еще не имеют УНЭП и данных по которым достаточно для выпуска.
identification_type required | string Enum: "personal" "epgu" Способ идентификации сотрудниками, для которых нужно выпустить УНЭП |
object |
{- "identification_type": "personal",
- "filter": {
- "employee_id": [
- 0
]
}
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
name required | string <= 255 characters Название производственного календаря |
code required | string <= 255 characters Код производственного календаря |
{- "name": "string",
- "code": "string"
}
{- "item": {
- "id": "string",
- "name": "string",
- "code": "string"
}
}
name required | string <= 255 characters Название производственного календаря |
code required | string <= 255 characters Код производственного календаря |
{- "name": "string",
- "code": "string"
}
{- "item": {
- "id": "string",
- "name": "string",
- "code": "string"
}
}
Можно передать до 500 дат в одном запросе.
required | Array of objects <= 500 items |
{- "dates": [
- {
- "date": "2024-01-17",
- "kind": "day_off"
}
]
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
passport_rus | string <binary> Файл с изображением главной страницы паспорта РФ (png, jpg, jpeg). |
passport_rus_registration | string <binary> Файл с изображением страницы с регистрацией паспорта РФ (png, jpg, jpeg). |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Получение статуса и результата распознавания документа
id required | string <uuid> Идентификатор запроса |
{- "item": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": {
- "state": "completed",
- "title": "Обработка завершена",
- "theme": "success",
- "description": "string"
}, - "files": [
- {
- "type": "passport_rus",
- "status": {
- "state": "completed",
- "title": "Обработка завершена",
- "theme": "success",
- "description": ""
}, - "result": {
- "first_name": "Имя",
- "middle_name": "Отчество",
- "second_name": "Фамилия",
- "gender": "МУЖ.",
- "birth_date": "2023-11-07",
- "serial": "1234",
- "number": "123456",
- "date": "1993-04-28",
- "division": "020-001",
- "issued_by": "Кем выдан паспорт",
- "birthplace": "Место рождения",
- "confidences": {
- "first_name": 0.829,
- "second_name": 0.992,
- "middle_name": 0.992,
- "gender": 0.999,
- "birth_date": 0.969,
- "serial": 0.993,
- "number": 0.996,
- "date": 0.923,
- "division": 0.994,
- "issued_by": 0.511,
- "birthplace": 0.984
}
}
}, - {
- "type": "passport_rus_registration",
- "status": {
- "state": "completed",
- "title": "Обработка завершена",
- "theme": "success",
- "description": ""
}, - "result": {
- "registration_address": "РЕСП. КАРЕЛИЯ, Р-Н СЕГЕЖСКИЙ, ГОР. СЕГЕЖА, УЛ. МАЯКОВСКОГО, д. 12",
- "registration_date": "2013-07-09",
- "confidences": {
- "registration_address": 0.829,
- "registration_date": 0.992
}
}
}
]
}
}
Создание запроса на проверку паспортных данных
scenario required | string Value: "acceptance_certificate_create" сценарий проверки |
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 |
{- "last_name": "Иванов",
- "first_name": "Ивано",
- "middle_name": "Иванович",
- "phone_number": "+79990000000",
- "is_self_employed": false,
- "birth_date": "2000-01-01",
- "citizenship": "RU",
- "inn": "000000000000",
- "passport": {
- "type": "passport_rf",
- "registration_address": "г. Москва, Ленинский проспект, д. 1",
- "serial": "1234",
- "number": "123456",
- "issue_date": "2000-01-01",
- "division": "000-000",
- "issued_by": "Отделом внутренних дел"
}
}
{- "item": {
- "id": "6219b041-1dac-4e18-b136-66c000dc0055",
- "status": {
- "state": "processing",
- "theme": "info",
- "description": "Запрос на проверку обрабатывается"
}
}
}
Получение результата запроса на проверку паспортных данных
requestId | string <uuid> Example: 6219b041-1dac-4e18-b136-66c000dc0055 Идентификатор запроса |
{- "item": {
- "id": "6219b041-1dac-4e18-b136-66c000dc0055",
- "status": {
- "state": "processing",
- "theme": "info",
- "description": "Запрос на проверку обрабатывается"
}
}
}
Создание отчета на проверку физлица
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 Вывод дополнительной информации об отчете о излице. |
required | object (v1.CounterpartPersonalData) Персональные данные контрагента для генерации отчета о физлице. |
{- "counterpart_personal_data": {
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "passport": {
- "series_and_number": "string",
- "date_of_birth": "2019-08-24"
}, - "inn": "string"
}
}
{- "item": {
- "id": "string",
- "suggested_readiness_at": "2019-08-24",
- "readiness_progress": 0,
- "partitions": [
- {
- "type": "bankruptcy",
- "name": "string",
- "has_issues": true,
- "data": {
- "is_bankrupt": true
}
}
]
}
}
Получение отчета на проверку физлица по ID
id required | string <uuid> Идентификатор отчета на проверку физлица |
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 Вывод дополнительной информации об отчете о излице. |
{- "item": {
- "id": "string",
- "suggested_readiness_at": "2019-08-24",
- "readiness_progress": 0,
- "partitions": [
- {
- "type": "bankruptcy",
- "name": "string",
- "has_issues": true,
- "data": {
- "is_bankrupt": true
}
}
]
}
}
Данные методы предназначены для работы с очтетами по транспортным средствам (ТС).
Создание отчета на проверку ТС
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 Вывод дополнительной информации в отчете о транспортном средстве |
vin required | string <= 100 characters VIN транспортного средства |
{- "vin": "string"
}
{- "item": {
- "id": "string",
- "suggested_partial_readiness_at": "2019-08-24",
- "is_partially_ready": true,
- "readiness_progress": 0,
- "partitions": [
- {
- "type": "vehicle_passport",
- "name": "string",
- "suggested_readiness_at": "2019-08-24",
- "is_ready": true,
- "has_issues": true,
- "data": {
- "category_type": "string",
- "year_of_manufacture": 0,
- "weight": {
- "value": 0,
- "units": {
- "title": "string",
- "value": "kg"
}
}, - "vehicle_body_type": "string",
- "steering_position": {
- "title": "string",
- "value": "left"
}, - "engine_number": "string",
- "engine_model": "string",
- "engine_volume": {
- "value": 0,
- "units": {
- "title": "string",
- "value": "cm3"
}
}, - "engine_power_kw": 0,
- "engine_power_hp": 0,
- "engine_fuel_type": {
- "title": "string",
- "value": "petrol"
}, - "color": "string",
- "vehicle_body_number": "string",
- "pts_series_and_number": "string",
- "sts_series_and_number": "string"
}
}
], - "url": "string",
- "created_at": "2019-08-24"
}
}
Получение отчета на проверку ТС по ID
id required | string <uuid> Идентификатор отчета на проверку ТС |
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 Вывод дополнительной информации в отчете о транспортном средстве |
{- "item": {
- "id": "string",
- "suggested_partial_readiness_at": "2019-08-24",
- "is_partially_ready": true,
- "readiness_progress": 0,
- "partitions": [
- {
- "type": "vehicle_passport",
- "name": "string",
- "suggested_readiness_at": "2019-08-24",
- "is_ready": true,
- "has_issues": true,
- "data": {
- "category_type": "string",
- "year_of_manufacture": 0,
- "weight": {
- "value": 0,
- "units": {
- "title": "string",
- "value": "kg"
}
}, - "vehicle_body_type": "string",
- "steering_position": {
- "title": "string",
- "value": "left"
}, - "engine_number": "string",
- "engine_model": "string",
- "engine_volume": {
- "value": 0,
- "units": {
- "title": "string",
- "value": "cm3"
}
}, - "engine_power_kw": 0,
- "engine_power_hp": 0,
- "engine_fuel_type": {
- "title": "string",
- "value": "petrol"
}, - "color": "string",
- "vehicle_body_number": "string",
- "pts_series_and_number": "string",
- "sts_series_and_number": "string"
}
}
], - "url": "string",
- "created_at": "2019-08-24"
}
}