B2B

Получение информации о состоянии Лицевого счета самозанятого

Пром GET https://baas.alfabank.ru/api/semp/v1/selfemployed/taxpayer-account-info/{requestId}

Песочница GET https://sandbox.alfabank.ru/api/semp/v1/selfemployed/taxpayer-account-info/{requestId}

Scope

as-accrual-and-debt

Описание

Для получения информации о состоянии Лицевого счета налогоплательщика необходимо отправить запрос GET https://baas.alfabank.ru/api/semp/v1/selfemployed/taxpayer-account-info/{requestId} , с access_token , полученным в Alfa ID по Authorization Code Flow, со scope = as-accrual-and-debt и параметрами запроса.

Параметры запроса

HEADERS
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
requestId
stringrequired

Уникальный идентификатор запроса

Пример запроса
curl -X GET https://baas.alfabank.ru/api/semp/v1/selfemployed/taxpayer-account-info/61d886e0-1dfc-4d58-ac4c-810aed991e3a \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json'

Параметры ответа

Пример ответа 200 (OK)
{
    "status": "SUCCESS",
    "bonusAmount": 0,
    "unpaidAmount": 2916.5,
    "debtAmount": 2916.5
}
status
stringoptional

Статус

bonusAmount
stringoptional

Сумма бонусного счета

unpaidAmmount
stringoptional

Общая сумма неоплаченных платежей

debtAmount
stringoptional

Сумма задолжности (включена в общая сумму неоплаченных платежей)

Пример ответа 200 (OK)
{
    "status": "SUCCESS",
    "bonusAmount": 0,
    "unpaidAmount": 2916.5,
    "debtAmount": 2916.5
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - Доступ к счету запрещен

error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.

Запрос информации о состоянии Лицевого счета самозанятогоАннулирование чеков в ФНС