Skip to content

Документация Haskaplan API (1.0.0)

Хаскаплан помогает бизнесу автоматизировать массовые выплаты и документооборот с физлицами и самозанятыми, например, с клиентами или исполнителями.

Возможности OpenAPI Хаскаплан:

  • создание выплат и получение информации по выплатам бизнеса;
  • получение информации по банковским счетам;
  • получение информации об исполнителях;
  • получение информации о подписанных документах (договорах, актах, выбитых чеках);
  • управление группами исполнителей и комиссиями на вывод.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://open-api.haskaplan.ru/_mock/openapi/

https://client-api.dev.haskaplan.net/

Балансы и исполнители

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

Исполнители выполняют работы и получают за это вознаграждение. В Хаскаплан исполнители создаются автоматически при первом начислении средств.

Operations

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

Request

Балансы банковских счетов обновляются в системе при открытии страниц личного кабинета (не чаще одного раза в 3 минуты) и каждые 15 минут без захода в ЛК.

Security
clientID and clientSecret and requestSignature
curl -i -X GET \
  https://open-api.haskaplan.ru/_mock/openapi/v1/accounts/balances \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешный запрос

Bodyapplication/jsonArray [
account_idstringrequired
Example: "000000"
accountstringrequired
Example: "30232810277700700001"
balanceWithHoldsnumberrequired

Баланс счета за вычетом невыведенных исполнителями средств из приложения. Может быть отрицательным

Example: 20000
balancenumberrequired
Example: 30000
performers_balancesnumberrequired

Сумма всех остатков по балансам исполнителей в мобильном приложении Хаскаплан

Example: 10000
]
Response
application/json
[
  {
    "account_id": "000000",
    "account": "30232810277700700001",
    "balanceWithHolds": 20000,
    "balance": 30000,
    "performers_balances": 10000
  }
]

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

Request

Возвращает краткую информацию по всем исполнителям, включая их балансы в приложении Хаскаплан, статус регистрации в приложении и статус подписания договора

Security
clientID and clientSecret and requestSignature
curl -i -X GET \
  https://open-api.haskaplan.ru/_mock/openapi/v1/performers \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешный запрос

Bodyapplication/json
performersArray of objects(PerformerInfo)
Response
application/json
{
  "performers": [
    { … }
  ]
}

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

Request

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

Security
clientID and clientSecret and requestSignature
Path
performer_idstringrequired
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/performers/{performer_id}' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешный запрос

Bodyapplication/json
performerobject(PerformerInfo)
agreementobject
groupobject
paymentsArray of objects(PaymentInfo)
Response
application/json
{
  "performer": {
    "performer_id": "uuid",
    "phone": "+79012345678",
    "TIN": "123456789012",
    "agreement_type": "ФЛ",
    "balance": 1500,
    "is_logged_in": true,
    "is_signed": false
  },
  "agreement": {
    "id": "uuid",
    "number": "test",
    "date": "2025-10-10"
  },
  "group": {
    "id": "uuid",
    "name": "name",
    "fee_rate": 10.25,
    "min_fee": 10.25
  },
  "payments": [
    { … }
  ]
}

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

Request

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

Security
clientID and clientSecret and requestSignature
Bodyapplication/jsonrequired
performer_idstring
Example: "test"
curl -i -X POST \
  https://open-api.haskaplan.ru/_mock/openapi/v1/performers/self-employed/status \
  -H 'Content-Type: application/json' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE' \
  -d '{
    "performer_id": "test"
  }'

Responses

Успешный запрос

Bodyapplication/json
is_self_employedbooleanrequired
Example: true
checked_atstring(date-time)required
Example: "2025-10-10 00:00:00"
detailsobject
Response
application/json
{
  "is_self_employed": true,
  "checked_at": "2025-10-10 00:00:00",
  "details": {}
}

Выплаты

Методы предназначены для проведения платежей исполнителям — на баланс в приложении Хаскаплан или напрямую на карту или через СБП

Operations

Группы исполнителей

Группы определяют условия комиссии для исполнителей. У компании может быть только одна “группа по умолчанию” - в нее автоматически попадают все новые исполнители

Operations

Работа с документами

В Хаскаплан документы исполнителей создаются автоматически: договоры — перед получением первого начисления, акты и чеки — при выводе средств.

Все типы документов можно отфильтровать по дате от / до и исполнителю performer_id.

Operations