Получение информации по реестру
Для получения подробной информации о статусе реестра, можно воспользоваться методом получения информации по конкретному реестру.
В запросе используется идентификатор, ранее созданного реестра - {id}.
Для вызова метода передать X-Login и X-Password в Headers запроса, в Path указать идентификатор реестра по которому необходимо получить информацию.
Запрос
Метод: GET https://business.selfwork.ru/selfemployed/business/v1/payouts/info-by-id/{id}
Path Parameters
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| id | int32 | Да | Идентификатор реестра |
Headers
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| X-Login | string | Да | Логин пользователя |
| X-Password | string | Да | Пароль пользователя |
Пример
- cURL
curl -X GET "https://business.selfwork.ru/selfemployed/business/v1/payouts/info-by-id/123" \
-H "X-Login: your_login_here" \
-H "X-Password: your_password_here" \
-H "Content-Type: application/json"
Ответы
- 200: OK
- 401: Unauthorized
- 500: Internal Server Error
Запрос выполнен успешно
{
"id": 20,
"state": 0,
"comment": "Comment",
"individualPayouts": [
{
"idIndividual": 15,
"payouts": [
{
"sum": 125000,
"state": 3,
"billLink": "https://himself-ktr.nalog.ru/api/v1/receipt/220807908487/0009xxpxss/print",
"taxEstimated": 15000,
"billDate": "2020-03-06 02:14:38.005599",
"sumComm": 10,
"comment": "Comment 1"
}
]
}
],
"autoGenerateDocs": true
}
Описание ответа:
| Ключ | Описание |
|---|---|
| id | Идентификатор реестра |
| state | Статус реестра |
| comment | Комментарий к реестру |
| individualPayouts | Массив выплат по самозанятым |
| idIndividual | Идентификатор СЗ |
| payouts | Операции СЗ |
| sum | Сумма операции в копейках |
| state | Статус операции |
| billLink | Ссылка на чек |
| taxEstimated | Сумма захолдированного налога в копейках |
| billDate | Дата регистрации чека |
| sumComm | Сумма онлайн комиссии |
| comment | Комментарий к выплате |
| autoGenerateDocs | Автоматическая генерация документа |
Не валидные авторизационные данные
{
"errorCode": 1,
"message": "Access denied"
}
Системная ошибка
{
"errorCode": 100,
"message": "Internal server error"
}
Описание ошибки:
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, вернувшийся с сервера |
| message | Сообщение сервера, описывающее ошибку |
Справочник статусов (state)
| Статус | Описание |
|---|---|
| 0 | Новый |
| 1 | Предварительная обработка (резерв перенос обработки в шлюзы, не финальный) |
| 2 | Проверен, нет ошибок (не финальный) |
| 3 | Проверен, есть ошибки |
| 4 | Обработан (все выплаты успешны, статус финальный, с реестром более ничего делать нельзя) |
| 5 | Обработан, есть ошибки (по некоторым выплатам реестра операции не созданы или в ошибке, статус финальный, с реестром более ничего делать нельзя) |
| 6 | Ошибка обработки (все выплаты в ошибке, операции не созданы, реестр можно редактировать) |
| 7 | Проверен, нельзя создать выплаты |
| 8 | В процессе выплаты |