B2BH2H

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

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

as-accrual-and-debt

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

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
externalId
stringrequired

Внешний идентификатор запроса, переданный Клиентом

taxPeriodId
stringrequired

ID налогового периода в формате YYYYMM

vatin
stringrequired

ИНН самозанятого

Пример запроса
1curl -X POST https://baas.alfabank.ru/api/semp/v1/selfemployed/income-for-period \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json' \
5  -d '{
6    "externalId": "584276e3-a49f-423e-a1dd-14f45233d463",
7    "taxPeriodId": "202301",
8    "vatin": "936144570006" }

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

Пример ответа 200 (ОК)
1{
2  "requestId": "9cf7ccbf-c72a-4cff-8e1a-9e4b4dd486d2",
3  "externalId": "f8c1ffe6-696b-4e35-994f-904a9187806d"
4}
requestId
stringoptional

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

externalId
stringoptional

Внешний идентификатор запроса, переданный Клиентом

Пример ответа 200 (ОК)
1{
2  "requestId": "9cf7ccbf-c72a-4cff-8e1a-9e4b4dd486d2",
3  "externalId": "f8c1ffe6-696b-4e35-994f-904a9187806d"
4}
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}
Нет тела ответа

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