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

Выплаты

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

Operations

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

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

Operations

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

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

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

Operations

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

Request

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

Security
clientID and clientSecret and requestSignature
Query
fromstring(date)

Start date for filtering

tostring(date)

End date for filtering

curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/documents/agreements?from=2019-08-24&to=2019-08-24' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/json
agreementsArray of objects(SignedAgreementInfo)
Response
application/json
{
  "agreements": [
    { … }
  ]
}

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

Request

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

Security
clientID and clientSecret and requestSignature
Query
fromstring(date)

Start date for filtering

tostring(date)

End date for filtering

performer_idstring
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/documents/acts?from=2019-08-24&to=2019-08-24&performer_id=string' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/json
actsArray of objects(SignedActInfo)
Response
application/json
{
  "acts": [
    { … }
  ]
}

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

Request

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

Security
clientID and clientSecret and requestSignature
Query
fromstring(date)

Start date for filtering

tostring(date)

End date for filtering

performer_idstring
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/documents/self-employed/receipts?from=2019-08-24&to=2019-08-24&performer_id=string' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/json
receiptsArray of objects(SelfEmployedReceiptInfo)
Response
application/json
{
  "receipts": [
    { … }
  ]
}

Скачать документ по идентификатору

Request

Скачать документ по идентификатору

Security
clientID and clientSecret and requestSignature
Path
document_typestringrequired
Enum"acts""agreements""receipts"
idstring(uuid)required
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/documents/{document_type}/{id}/file' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Document file

Bodyapplication/pdf
string(binary)
Response
No content