B2BH2H

Получение информации по доходу самозанятого за период

Песочница
GET https://sandbox.alfabank.ru/api/semp/v1/selfemployed/income-for-period/{requestId}
Пром
GET https://baas.alfabank.ru/api/semp/v1/selfemployed/income-for-period/{requestId}
Scope

as-accrual-and-debt

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

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

application/json

Content-Type
stringoptional

application/json

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

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

Пример запроса
1curl -X GET https://baas.alfabank.ru/api/semp/v1/selfemployed/income-for-period/aa6baff2-e88b-4766-bd52-b7057fdfdb87\
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json'

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

Пример ответа 200 (OK)
1{
2    "status": "SUCCESS",
3    "totalAmount": 122201.95,
4    "canceledTotalAmount": 288.83,
5    "tax": 4890.3648
6}
status
stringoptional

Статус

totalAmount
stringoptional

Сумма зарегистрированного дохода за период

canceledTotalAmount
stringoptional

Сумма сторнированного дохода за период

tax
stringoptional

Рассчитанный налог за период

Пример ответа 200 (OK)
1{
2    "status": "SUCCESS",
3    "totalAmount": 122201.95,
4    "canceledTotalAmount": 288.83,
5    "tax": 4890.3648
6}
error
stringrequired

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

error_description
stringoptional

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

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

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

error_description
stringoptional

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

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

Код ошибки. Принимает возможные значения: insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent; access_denied - доступ к счёту запрещён

error_description
stringoptional

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

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

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

error_description
stringoptional

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

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

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