Skip to content
/
Получить список реестров...

Haskaplan API (1.0.0)

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

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

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

Dev сервер

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

payments

Operations

balances

Operations

registries

Operations

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

Request

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

Security
ClientId and ClientSecret and RequestSignature
Query
pageinteger>= 1
Default 1
limitinteger[ 1 .. 100 ]
Default 50
curl -i -X GET \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/registries?page=1&limit=50' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/json
registriesArray of objects(RegistryInfo)required
registries[].​idstring(uuid)required
Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
registries[].​created_atstring(date-time)required
Example: "2024-01-15T14:30:00Z"
registries[].​created_bystring
Example: "ivanov@company.ru"
registries[].​statusstringrequired
Enum"loaded""processing""completed""failed""cancelled"
Example: "loaded"
registries[].​amount_loadedstring
Example: "100000.00"
registries[].​filenamestringrequired
Example: "registry.xlsx"
pageinteger
Example: 1
limitinteger
Example: 50
totalinteger
Example: 10
Response
application/json
{
  "registries": [
    { … }
  ],
  "page": 1,
  "limit": 50,
  "total": 10
}

Загрузить реестр выплат из Excel файла

Request

Загружает и создает записи о выплатах из Excel реестра

Security
ClientId and ClientSecret and RequestSignature
Bodymultipart/form-datarequired
filestring(binary)required

Excel файл с реестром выплат

curl -i -X POST \
  https://open-api.haskaplan.ru/_mock/openapi/v1/registries \
  -H 'Content-Type: multipart/form-data' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE' \
  -F file=string

Responses

Успешная загрузка реестра

Bodyapplication/json
registry_idstring(uuid)required
Example: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
statusstringrequired
Enum"loaded""processing""completed""failed"
Example: "loaded"
errorsobject
Response
application/json
{
  "registry_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "status": "loaded",
  "errors": {
    "error_reason": "обнаружены ошибки при импорте платежей из реестра",
    "payment_errors": [ … ]
  }
}

Удалить реестр выплат

Request

Удаляет реестр выплат и все связанные платежи

Security
ClientId and ClientSecret and RequestSignature
Path
idstring(uuid)required
curl -i -X DELETE \
  'https://open-api.haskaplan.ru/_mock/openapi/v1/registries/{id}' \
  -H 'client-id: YOUR_API_KEY_HERE' \
  -H 'client-secret: YOUR_API_KEY_HERE' \
  -H 'request-signature: YOUR_API_KEY_HERE'

Responses

Успешное удаление

Response
No content