B2B

Запрос информации по зарегистрированным доходам с разбивкой по чекам

Пром POST https://baas.alfabank.ru/api/semp/v1/selfemployed/income

Песочница POST https://sandbox.alfabank.ru/api/semp/v1/selfemployed/income

Scope

as-accrual-and-debt

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

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

vatin
stringrequired

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

from
stringrequired

Дата, начиная с которой отображать зарегистрированные доходы

to
stringrequired

Дата, до которой отображать зарегистрированные доходы

objectoptional

Данные пагинации

limit
stringoptional

Количество записей на одной странице

offset
stringoptional

Количество объектов в списке, которые необходимо пропустить

totalCount
stringoptional

Общее количество записей

Пример запроса
curl -X POST https://baas.alfabank.ru/api/semp/v1/selfemployed/income \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "584276e3-a49f-423e-a1dd-14f45233d463",
    "vatin": "936144570006",
    "from": "2023-06-30T00:00:00+03:00",
    "to": "2023-06-30T23:59:59+03:00",
    "limit": 10, 
    "offset": 0 }

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

Пример ответа 200 (ОК)
{
  "requestId": "83ca6d9b-4c72-4044-bcee-789b36c1943f",
  "externalId": "584276e3-a49f-423e-a1dd-14f45233d463"
}
requestId
stringoptional

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

externalId
stringoptional

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

Пример ответа 200 (ОК)
{
  "requestId": "83ca6d9b-4c72-4044-bcee-789b36c1943f",
  "externalId": "584276e3-a49f-423e-a1dd-14f45233d463"
}
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"
}
Нет тела ответа

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