logo
API docs by Redocly

Finance 1C API (1.0)

Download OpenAPI specification:Download

Jump.Finance: support@jump.finance URL: https://jump.finance/kontakty

$ref: assets/general_description.md

Выплаты

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

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

One of
required
Номер телефона для СБП (object) or Карта банка (object) or Карта банка (PCI DSS) (object) (Платежный реквизит)

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

object or null

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

customer_payment_id
string <= 36 characters

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

contractor_id
required
integer

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

amount
required
number

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

agent_id
integer

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

branch_office_id
integer

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

bank_account_id
integer

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

service_name
string

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

payment_purpose
string

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

balance_id
integer or null

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

object or null

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

object or null

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

fix_commission
number or null

удержание фиксированное(не больше суммы выплаты)

percent_commission
number or null

удержание в процентах

Responses

Request samples

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

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
Array of strings
Items Enum: "abilities" "requisite" "creator" "agent" "branch_office" "history" "payload"
Example: include=requisite,creator

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате

  • abilities - возможность совершения действий над выплатой

  • requisite - реквизиты, по которым выплата была произведена

  • creator - создатель выплаты

  • agent - юрлицо, в рамках которого выплата осуществлена

  • branch_office - филиал, в рамках которого выплата создана

  • history - история действий по выплате

  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.

  • act - информация о связанном с выплатой акте (если есть)

  • nominal_info - информация, связанная с номинальным счетом

status
integer
Enum: 1 2 3 4 5 6 8

ИД статуса выплаты:

  • 1 - оплачен (без возможности дальнейших действий)
  • 2 - отклонён (без возможности дальнейших действий)
  • 3 - в обработке (ждём проведение через платежные системы)
  • 4 - ожидает подтверждения (требуется подтверждение выплаты в ЛК)
  • 5 - ошибка выплаты (с возможностью повторить действие, отменить выплату или зачислить средства на баланс исполнителя)
  • 6 - Удалён,
  • 8 - Ждет подписания акта,
ids
Array of integers
Example: ids=1,2,3

Массив ИД выплат

contractor_ids
Array of integers
Example: contractor_ids=1,2,3

Массив ИД исполнителей выплат

agent_ids
Array of integers
Example: agent_ids=1,2,3

Массив ИД юрлиц выплат

branch_office_ids
Array of integers
Example: branch_office_ids=1,2,3

Массив ИД филиалов выплат

has_acceptance_certificate
boolean
Example: has_acceptance_certificate=true

Есть ли привязанный ПСА к выплате

created_at_from
string <date>
Example: created_at_from=2024-03-13T15:32:01+03:00

Фильтр по дате создания, возвращаются только те, что позже или равны указанной

created_at_to
string <date>
Example: created_at_to=2024-03-13T15:32:01+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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
payment_id
required
integer

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
payment_id
required
integer

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

query Parameters
include
Array of strings
Items Enum: "abilities" "requisite" "creator" "agent" "branch_office" "history" "payload"
Example: include=requisite,creator

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате

  • abilities - возможность совершения действий над выплатой

  • requisite - реквизиты, по которым выплата была произведена

  • creator - создатель выплаты

  • agent - юрлицо, в рамках которого выплата осуществлена

  • branch_office - филиал, в рамках которого выплата создана

  • history - история действий по выплате

  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.

  • act - информация о связанном с выплатой акте (если есть)

  • nominal_info - информация, связанная с номинальным счетом

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
customer_payment_id
required
integer

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

query Parameters
include
Array of strings
Items Enum: "abilities" "requisite" "creator" "agent" "branch_office" "history" "payload"
Example: include=requisite,creator

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате

  • abilities - возможность совершения действий над выплатой

  • requisite - реквизиты, по которым выплата была произведена

  • creator - создатель выплаты

  • agent - юрлицо, в рамках которого выплата осуществлена

  • branch_office - филиал, в рамках которого выплата создана

  • history - история действий по выплате

  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.

  • act - информация о связанном с выплатой акте (если есть)

  • nominal_info - информация, связанная с номинальным счетом

Responses

Response samples

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

Словари

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

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{
  • "name": "sbp_banks",
  • "title": "Банки для системы быстрых платежей",
  • "options": [
    ]
}

Выплаты V2

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
include
Array of strings
Items Enum: "abilities" "requisite" "creator" "agent" "branch_office" "history" "payload" "act" "nominal_info" "bank_account" "approver" "files" "vehicle" "vehicle_pledges_report" "comment" "pledge_redemption"
Example: include=requisite,creator

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате

  • abilities - возможность совершения действий над выплатой

  • requisite - реквизиты, по которым выплата была произведена

  • creator - создатель выплаты

  • agent - юрлицо, в рамках которого выплата осуществлена

  • branch_office - филиал, в рамках которого выплата создана

  • history - история действий по выплате

  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.

  • act - информация о связанном с выплатой акте (если есть)

  • nominal_info - информация, связанная с номинальным счетом

  • bank_account

  • approver

  • files

  • vehicle

  • vehicle_pledges_report

  • comment

  • pledge_redemption

status_id
integer
Enum: 1 2 3 4 5 6 7 8

ИД статуса:

  • 1 - оплачен (без возможности дальнейших действий)
  • 2 - отклонён (без возможности дальнейших действий)
  • 3 - в обработке (ждём проведение через платежные системы)
  • 4 - ожидает оплаты
  • 5 - ошибка выплаты (с возможностью повторить действие, отменить выплату или зачислить средства на баланс исполнителя)
  • 6 - удалён,
  • 7 - ожидает подтверждения,
  • 8 - ждет подписания акта
ids
Array of integers
Example: ids=1,2,3

Массив ИД выплат

contractor_ids
Array of integers
Example: contractor_ids=1,2,3

Массив ИД исполнителей выплат

agent_ids
Array of integers
Example: agent_ids=1,2,3

Массив ИД юрлиц выплат

branch_office_ids
Array of integers
Example: branch_office_ids=1,2,3

Массив ИД филиалов выплат

has_acceptance_certificate
boolean
Example: has_acceptance_certificate=true

Есть ли привязанный ПСА к выплате

created_at_from
string <date>
Example: created_at_from=2024-03-13T15:32:01+03:00

Фильтр по дате создания, возвращаются только те, что позже или равны указанной

created_at_to
string <date>
Example: created_at_to=2024-03-13T15:32:01+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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
payment_id
required
integer

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

query Parameters
include
Array of strings
Items Enum: "abilities" "requisite" "creator" "agent" "branch_office" "history" "payload" "act" "nominal_info" "bank_account" "approver" "files" "vehicle" "vehicle_pledges_report" "comment" "pledge_redemption"
Example: include=requisite,creator

Дополнительно к существующим полям можно запросить дополнительную информацию по выплате

  • abilities - возможность совершения действий над выплатой

  • requisite - реквизиты, по которым выплата была произведена

  • creator - создатель выплаты

  • agent - юрлицо, в рамках которого выплата осуществлена

  • branch_office - филиал, в рамках которого выплата создана

  • history - история действий по выплате

  • payload - дополнительные клиентские данные о выплате, например данные, введенные на форме при создании: тип договора, его номер и т.д.

  • act - информация о связанном с выплатой акте (если есть)

  • nominal_info - информация, связанная с номинальным счетом

  • bank_account

  • approver

  • files

  • vehicle

  • vehicle_pledges_report

  • comment

  • pledge_redemption

Responses

Response samples

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

Филиалы

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

Создать филиал

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает новый филиал

name
required
string

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

agent_id
required
number

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

address
required
string

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

limit_monthly
required
number or null

Лимит на выплаты в месяц

limit_daily
required
number or null

Лимит на выплаты в день

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Филиал",
  • "agent_id": 45,
  • "address": "Московская 4, д. 3",
  • "limit_monthly": 250,
  • "limit_daily": 250
}

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
agent_id
number

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

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

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

customer_id
number

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

is_active
integer
Enum: 0 1

Только активные филиалы

include
string
Value: "limits"

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

  • limits - лимиты филиала
search
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

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

Responses

Response samples

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

Изменить филиал

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
branch_office_id
required
integer

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

Request Body schema: application/json
required

Изменяет филиал

name
required
string

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

agent_id
required
number

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

address
required
string

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

limit_monthly
required
number or null

Лимит на выплаты в месяц

limit_daily
required
number or null

Лимит на выплаты в день

is_active
required
number
Enum: 0 1

Флаг активности филиала

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Филиал",
  • "agent_id": 45,
  • "address": "Московская 4, д. 3",
  • "limit_monthly": 250,
  • "limit_daily": 250,
  • "is_active": 0
}

Response samples

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

Удалить филиал

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
branch_office_id
required
integer

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

Responses

Response samples

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

Получить доступные и активные филиалы и счета, доступные в этих филиалах

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

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

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

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

Responses

Response samples

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

Приемо-сдаточные акты

Данные методы предназначены для работы с приемо-сдаточными актами (ПСА).

Создание ПСА

Создание ПСА

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

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

branch_office_id
integer or null

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

bank_account_id
integer or null

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

number
required
string <= 100 characters

Номер ПСА

date
required
string <date>

Дата ПСА

contractor_id
required
integer

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

object or null
required
object
amount
required
number

Сумма ПСА

required
Array of objects (AcceptanceCertificateCreateCertificateItem) [ 1 .. 128 ] items

Список позиций ПСА

(Новый платежный реквизит (object or null)) or (Существующий платежный реквизит (object or null))

Платежный реквизит получателя

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "branch_office_id": 0,
  • "bank_account_id": 0,
  • "number": "string",
  • "date": "2023-01-01",
  • "contractor_id": 0,
  • "transport": {
    },
  • "scrap_metal_data": {
    },
  • "amount": 0.1,
  • "certificate_items": [
    ],
  • "contractor_requisite": {
    }
}

Response samples

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

Получение списка ПСА

Получение списка ПСА

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
order
string
Enum: "name" "created_at" "id"
Example: order=name

Сортировка

page
integer
Example: page=1

Номер страницы

per_page
integer
Example: per_page=10

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

contractor_ids
Array of integers
Example: contractor_ids=1,2,3

Массив ИД исполнителей

agent_ids
Array of integers
Example: agent_ids=1,2,3

Массив ИД юрлиц

branch_office_ids
Array of integers
Example: branch_office_ids=1,2,3

Массив ИД филиалов

ids
Array of integers
Example: ids=1,2,3

Массив ИД актов ПСА

created_at_from
string <date>
Example: created_at_from=2024-03-13T15:32:01+03:00

Фильтр по дате создания, возвращаются только те, что позже или равны указанной

created_at_to
string <date>
Example: created_at_to=2024-03-13T15:32:01+03:00

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

updated_at_from
string <date>
Example: updated_at_from=2024-03-13T15:32:01+03:00

Фильтр по дате создания, возвращаются только те, что позже или равны указанной

updated_at_to
string <date>
Example: updated_at_to=2024-03-13T15:32:01+03:00

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

Идентификатор ПСА

Responses

Response samples

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

Обновить данные ПСА

Обновить данные ПСА

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

Идентификатор ПСА

Request Body schema: application/json
required
required
Array of objects [ 1 .. 128 ] items

Список позиций ПСА

agent_id
required
integer

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

branch_office_id
integer or null

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

bank_account_id
integer or null

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

number
required
string <= 100 characters

Номер ПСА

date
required
string <date>

Дата ПСА

contractor_id
required
integer

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

object or null
required
object
amount
required
number

Сумма ПСА

(Новый платежный реквизит при изменении (object or null)) or (Существующий платежный реквизит (object or null))

Платежный реквизит получателя

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "branch_office_id": 0,
  • "bank_account_id": 0,
  • "number": "string",
  • "date": "2023-01-01",
  • "contractor_id": 0,
  • "transport": {
    },
  • "scrap_metal_data": {
    },
  • "amount": 0.1,
  • "certificate_items": [
    ],
  • "contractor_requisite": {
    }
}

Response samples

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

Удалить ПСА

Удалить ПСА

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

Идентификатор ПСА

Responses

Response samples

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

Создание выплаты для ПСА

Для создания выплаты должен быть передан requisite_id или requisite.

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

Идентификатор ПСА

Request Body schema: application/json
required
One of
object or null

ФИО получателя для перевода через СБП, когда оплату получит 3-е лицо

required
Номер телефона для СБП (object) or Карта банка (object) or Карта банка (PCI DSS) (object) (Платежный реквизит)

Платежный реквизит

idempotency_key
string

Ключ идемпотентности (UUIDv4)

bank_account_id
integer or null

Идентификатор счёта, с которого будет произведена выплата.
Если не передан или null, то будет использован счёт, выбранный при создании / редактировании ПСА.
Если в ПСА отсутствует информация о выбранном счёте для оплаты, то будет использован счёт по умолчанию для данного типа реквизитов исполнителя.

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

Responses

Request samples

Content type
application/json
Example
{
  • "sbp_validation_data": {
    },
  • "requisite": {
    },
  • "idempotency_key": "string",
  • "bank_account_id": 0
}

Response samples

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

Скачивание файла приемо-сдаточного акта в формате docx

Скачивание файла приемо-сдаточного акта в формате docx

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

id приемо-сдаточного акта

Responses

Response samples

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

Скачивание файла приемо-сдаточного акта в формате pdf

Скачивание файла приемо-сдаточного акта в формате pdf

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
cert_id
required
integer

id приемо-сдаточного акта

Responses

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: multipart/form-data
passport_rus
string <binary>

Файл с изображением главной страницы паспорта РФ (png, jpg, jpeg).

passport_rus_registration
string <binary>

Файл с изображением страницы с регистрацией паспорта РФ (png, jpg, jpeg).

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
id
required
string <uuid>

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

Responses

Response samples

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

Номенклатуры

Номенклатуры

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

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

Создает новую номенклатуру

name
required
string

Название номенклатуры

required
object (NewNomenclatureType)

Тип номенклатуры

Responses

Request samples

Content type
application/json
{
  • "name": "Номенклатура № 1",
  • "type": {
    }
}

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
search
string

Поиск по названию номенклатуры

with_trashed
integer
Default: 0
Enum: 0 1

Включать удалённые номенклатуры

  • 0 - Не включать удалённые
  • 1 - Включать удалённые
include
Array of strings
Items Value: "category"

Дополнительная информация о номенклатуре (список через запятую)

  • category - категория номенклатуры
page
integer <int64> >= 1
Default: 1

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

per_page
integer <int64> [ 1 .. 200 ]
Default: 20

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

Responses

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
nomenclature_id
required
string <uuid>

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

query Parameters
with_trashed
integer
Default: 0
Enum: 0 1

Возвращать также удалённые, в противном случае удалённые номенклатуры не будут найдены

  • 0 - Не возвращать удалённые
  • 1 - Возвращать

Responses

Response samples

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

Изменить номенклатуры

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
nomenclature_id
required
string <uuid>

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

Request Body schema: application/json
required

Изменяет номенклатуру

name
required
string

Название номенклатуры

required
object (NomenclatureType)

Тип номенклатуры

Responses

Request samples

Content type
application/json
{
  • "name": "Номенклатура № 1",
  • "type": "Черный металл"
}

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
nomenclature_id
required
string <uuid>

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

Responses

Response samples

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

Проверка документов

Проверка документов

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
scenario
required
string
Value: "acceptance_certificate_create"

сценарий проверки

Request Body schema: application/json
One of
last_name
required
string
first_name
required
string
middle_name
string or null
phone_number
required
string
is_self_employed
required
boolean
birth_date
required
string
citizenship
required
string
Value: "RU"
inn
string or null
required
object

Responses

Request samples

Content type
application/json
{
  • "last_name": "Иванов",
  • "first_name": "Ивано",
  • "middle_name": "Иванович",
  • "phone_number": "+79990000000",
  • "is_self_employed": false,
  • "birth_date": "2000-01-01",
  • "citizenship": "RU",
  • "inn": "000000000000",
  • "passport": {
    }
}

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
requestId
string <uuid>
Example: 6219b041-1dac-4e18-b136-66c000dc0055

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

Responses

Response samples

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

Расширение 1С

Расширение 1С

Версии расширений 1С

Позволяет получить историю версий расширений 1С

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Настройки

Настройки личного кабинета

Настройки личного кабинета

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

Authorizations:
ApiKeyHeaderApiKeyQuery

Responses

Response samples

Content type
application/json
{}

Исполнители

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
Request Body schema: application/json
required

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

phone
required
string

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

email
string or null

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

last_name
required
string

фамилия

middle_name
string

отчество

first_name
required
string

имя

legal_form_id
required
number

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

agent_id
required
number

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

group_id
number

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

inn
string
company_agrees_pay_taxes
boolean

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

null or Паспорт РФ (object) or Паспорт иностранного гражданина (object)

Responses

Request samples

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

Response samples

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

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

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

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

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

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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

Изменить исполнителя

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Request Body schema: application/json
required

Обновляет существующего исполнителя

phone
required
string

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

email
string or null

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

last_name
required
string

фамилия

middle_name
string

отчество

first_name
required
string

имя

legal_form_id
required
number

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

agent_id
required
number

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

group_id
number

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

inn
string
company_agrees_pay_taxes
boolean

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

null or Паспорт РФ (object) or Паспорт иностранного гражданина (object)

Responses

Request samples

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

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

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

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

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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

query Parameters
include
string

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

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

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

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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

balance_id
required
integer <int64>

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

query Parameters
include
string

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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer

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

query Parameters
view
string (IdentificationRequest)
Enum: "simple" "passport"

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

Request Body schema: application/json
required

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

country
required
string

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

is_verified
boolean

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

snils
string

СНИЛС

inn
string

ИНН

object

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

Responses

Request samples

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

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
string

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

query Parameters
view
string (IdentificationRequest)
Enum: "simple" "passport"

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

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

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

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

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Request Body schema: application/json
required

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

agent_id
required
integer

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

legal_form_id
required
integer

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

is_agree_pay_taxes
boolean
Default: false

Уплачивать ли налоги за получателя. Обязательный параметр только в случае, если legal_form_id = 2.

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "legal_form_id": 0,
  • "is_agree_pay_taxes": false
}

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

cooperation_id
required
integer <int64>

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

cooperation_id
required
integer <int64>

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

Responses

Response samples

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

Обновляет сотрудничество

Обновление сотрудничества

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

cooperation_id
required
integer <int64>

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

Request Body schema: application/json
required

Обновляет существующего исполнителя

agent_id
required
integer

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

legal_form_id
required
integer

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

is_agree_pay_taxes
boolean
Default: false

Уплачивать ли налоги за получателя. Обязательный параметр только в случае, если legal_form_id = 2.

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "legal_form_id": 0,
  • "is_agree_pay_taxes": false
}

Response samples

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

Самозанятые

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
path Parameters
contractor_id
required
integer <int64>

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

Responses

Response samples

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

Выплаты по номинальному счету

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
date_from
string <date>
Example: date_from=2024-03-13T15:32:01+03:00

Фильтр по дате оплаты, возвращаются только те, что позже или равны указанной

date_to
string <date>
Example: date_to=2024-03-13T15:32:01+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

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

Responses

Response samples

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

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

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

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

Authorizations:
ApiKeyHeaderApiKeyQuery
query Parameters
date_from
string <date>
Example: date_from=2024-03-13T15:32:01+03:00

Фильтр по дате поступления, возвращаются только те, что позже или равны указанной

date_to
string <date>
Example: date_to=2024-03-13T15:32:01+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

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

Responses

Response samples

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