# Документация Haskaplan API

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

Возможности OpenAPI Хаскаплан: 
* создание выплат и получение информации по выплатам бизнеса;
* получение информации по банковским счетам;
* получение информации об исполнителях;
* получение информации о подписанных документах (договорах, актах, выбитых чеках);
* управление группами исполнителей и комиссиями на вывод.


Version: 1.0.0

## Servers

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

## Security

### clientID

Type: apiKey
In: header
Name: client-id

### clientSecret

Type: apiKey
In: header
Name: client-secret

### requestSignature

Type: apiKey
In: header
Name: request-signature

## Download OpenAPI description

[Документация Haskaplan API](https://open-api.haskaplan.ru/_bundle/openapi.yaml)

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

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

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


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

 - [GET /v1/accounts/balances](https://open-api.haskaplan.ru/openapi/balansy-i-ispolniteli/getallaccountbalances.md): Балансы банковских счетов обновляются в системе при открытии страниц личного кабинета (не чаще одного раза в 3 минуты) и каждые 15 минут без захода в ЛК.

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

 - [GET /v1/performers](https://open-api.haskaplan.ru/openapi/balansy-i-ispolniteli/getallperformers.md): Возвращает краткую информацию по всем исполнителям, включая их балансы в приложении Хаскаплан, статус регистрации в приложении и статус подписания договора

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

 - [GET /v1/performers/{performer_id}](https://open-api.haskaplan.ru/openapi/balansy-i-ispolniteli/getperformerdetails.md): Возвращает детальную информацию по исполнителю, включая данные по договору, группе, а также платежи с актами

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

 - [POST /v1/performers/self-employed/status](https://open-api.haskaplan.ru/openapi/balansy-i-ispolniteli/checkselfemployedstatuspost.md): Отправляет запрос в налоговую для проверки актуальности статуса самозанятого, а также чтобы убедиться, что он подтвердил необходимые разрешения

## Выплаты

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

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

 - [GET /v1/payments](https://open-api.haskaplan.ru/openapi/vyplaty/getallpayments.md): Возвращает все выплаты, совершенные от лица компании. Можно отфильтровать по дате от / до, исполнителю performer_id, а также типу платежа

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

 - [POST /v1/payments/registry](https://open-api.haskaplan.ru/openapi/vyplaty/createpaymentregistry.md): Исполнителю автоматически отправится приглашение на номер телефона для подписания договора. Далее исполнитель сможет зайти в мобильное приложение Хаскаплан, пройти верификацию, подписать договор и вывести средства себе на карту или по СБП. 

После создания реестра выплат необходимо проверить статус начислений методом /v1/payments/registry/{request_id}. Метод отобразит статус начисления реестра в приложение; для проверки списаний из приложения воспользуйтесь методом /v1/payments.

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

 - [POST /v1/payments/direct](https://open-api.haskaplan.ru/openapi/vyplaty/createdirectpayment.md): Для каждого исполнителя необходимо передать тип платежного метода и реквизиты. 

После создания реестра выплат необходимо проверить статус выплат методом /v1/payments/registry/{request_id}.

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

 - [GET /v1/payments/registry/{request_id}](https://open-api.haskaplan.ru/openapi/vyplaty/getpaymentregistrystatus.md): Возвращает список платежей в реестре и их статусов с кодом ошибки

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

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

### Получить список всех групп исполнителей

 - [GET /v1/groups](https://open-api.haskaplan.ru/openapi/gruppy-ispolnitelej/getallgroups.md): Получить список всех групп исполнителей

### Создать новую группу исполнителей

 - [POST /v1/groups](https://open-api.haskaplan.ru/openapi/gruppy-ispolnitelej/creategroup.md): Метод также позволяет отредактировать существующую группу

### Удалить группу исполнителей

 - [DELETE /v1/groups/{group_id}](https://open-api.haskaplan.ru/openapi/gruppy-ispolnitelej/deletegroup.md): Удалить можно только пустую группу - перед выполнением действия необходимо перенести всех исполнителей в другие группы. Группу по умолчанию удалить нельзя

### Получить список исполнителей в группе

 - [GET /v1/groups/{group_id}](https://open-api.haskaplan.ru/openapi/gruppy-ispolnitelej/getgroupperformers.md): Получить список исполнителей в группе

### Перенести исполнителей в другую группу

 - [POST /v1/groups/transfer](https://open-api.haskaplan.ru/openapi/gruppy-ispolnitelej/transferperformerstogroup.md): Перенести исполнителей в другую группу

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

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

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


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

 - [GET /v1/documents/agreements](https://open-api.haskaplan.ru/openapi/rabota-s-dokumentami/getsignedagreements.md): Получить все подписанные договоры

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

 - [GET /v1/documents/acts](https://open-api.haskaplan.ru/openapi/rabota-s-dokumentami/getsignedacts.md): Получить все подписанные акты выполненных работ

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

 - [GET /v1/documents/self-employed/receipts](https://open-api.haskaplan.ru/openapi/rabota-s-dokumentami/getselfemployedreceipts.md): Получить все выставленные чеки

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

 - [GET /v1/documents/{document_type}/{id}/file](https://open-api.haskaplan.ru/openapi/rabota-s-dokumentami/downloaddocumentfile.md): Скачать документ по идентификатору