B2BH2H

Получение данных на оплату налоговых начислений, задолженности и пеней самозанятого

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

as-accrual-and-debt

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

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

application/json

Content-Type
stringoptional

application/json

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

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

QUERY
Атрибут
Описание
limit
integeroptional

Количество объектов на одной странице

offset
integeroptional

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

Пример запроса
1curl -X GET https://baas.alfabank.ru/api/semp/v1/selfemployed/payment-documents/4e817e78-5876-4608-a873-bcc141454045?limit=1000&offset=0 \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
1{
2  "pagination": {
3    "limit": 1000,
4    "offset": 0,
5    "totalCount": 10000
6  },
7  "requestId": "4e817e78-5876-4608-a873-bcc141454045",
8  "externalId": "4feF748b-908F-3f75-20bd-7A96BD7E8aef",
9  "paymentDocumentListState": [
10    {
11      "vatin": "936144570006",
12      "status": "SUCCESS",
13      "paymentDocumentList": [
14        {
15          "accrualType": "DEBT",
16          "documentIndex": "18209997230000047085",
17          "name": "Гонимый Раскол Паскалевич",
18          "address": "603093, РОССИЯ, , , г Нижний Новгород, , ул Родионова, 23А, , офис 307",
19          "taxpayerVatin": "936144570006",
20          "amount": 2916.5,
21          "recipientBank": "ОТДЕЛЕНИЕ ТУЛА БАНКА РОССИИ//УФК по Тульской области, г Тула",
22          "recipientBic": "017003983",
23          "recipientBankAccount": "40102810445370000059",
24          "recipientName": "Казначейство России (ФНС России)",
25          "recipientAccount": "03100643000000018500",
26          "recipientVatin": "7727406020",
27          "recipientKpp": "770801001",
28          "kbk": "18210506000011000110",
29          "oktmo": "45000000",
30          "code101": "01",
31          "code106": "ЗД",
32          "code107": "15.09.2023",
33          "code110": "0",
34          "dueDate": "2023-09-15",
35          "createdAt": "2023-09-15T13:14:08.136+03:00",
36          "internalId": 58469
37        }
38      ]
39    }
40  ]
41}
objectoptional

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

limit
integeroptional

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

offset
integeroptional

Количество записей в списке, которые были пропущены

totalCount
integeroptional

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

requestId
stringoptional

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

externalId
stringoptional

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

array of objectoptional

Статусы получения данных из ФНС по самозанятым

vatin
stringoptional

ИНН

status
stringoptional

Статус получения данных из ФНС по самозанятому. Возможные значения: NEW - запись создана; SUCCESS - результат получен;IN_PROGRESS - ожидается ответ ФНС; ERROR - получена ошибка ФНС

ftsError
stringoptional

Ошибка ФНС

array of objectoptional

Список платёжных документов

accrualType
stringoptional

Тип начисления. Возможные значения: TAX- налоговое начисление; DEBT - задолженность; PENALTY - пени

documentIndex
stringoptional

Индекс документа (УИН)

name
stringoptional

ФИО налогоплательщика

address
stringoptional

Адрес места жительства налогоплательщика

taxpayerVatin
stringoptional

ИНН налогоплательщика

amount
stringoptional

Сумма к оплате

recipientBank
stringoptional

Банк получателя

recipientBic
stringoptional

БИК банка получателя

recipientBankAccount
stringoptional

Счёт банка получателя

recipientName
stringoptional

Получатель

recipientAccount
stringoptional

Счёт получателя

recipientVatin
stringoptional

ИНН получателя

recipientKpp
stringoptional

КПП получателя

kbk
stringoptional

КБК налогового начисления или КРСБ

oktmo
stringoptional

ОКТМО налогового начисления или КРСБ

code101
stringoptional

Код для поля 101

code106
stringoptional

Код для поля 106

code107
stringoptional

Код для поля 107

code110
stringoptional

Код для поля 110

dueDate
stringoptional

Срок оплаты

createdAt
stringoptional

Дата/Время создания документа

internalId
numberoptional

Внутренний идентификатор источника документа в ПП НПД

Пример ответа 200 (ОК)
1{
2  "pagination": {
3    "limit": 1000,
4    "offset": 0,
5    "totalCount": 10000
6  },
7  "requestId": "4e817e78-5876-4608-a873-bcc141454045",
8  "externalId": "4feF748b-908F-3f75-20bd-7A96BD7E8aef",
9  "paymentDocumentListState": [
10    {
11      "vatin": "936144570006",
12      "status": "SUCCESS",
13      "paymentDocumentList": [
14        {
15          "accrualType": "DEBT",
16          "documentIndex": "18209997230000047085",
17          "name": "Гонимый Раскол Паскалевич",
18          "address": "603093, РОССИЯ, , , г Нижний Новгород, , ул Родионова, 23А, , офис 307",
19          "taxpayerVatin": "936144570006",
20          "amount": 2916.5,
21          "recipientBank": "ОТДЕЛЕНИЕ ТУЛА БАНКА РОССИИ//УФК по Тульской области, г Тула",
22          "recipientBic": "017003983",
23          "recipientBankAccount": "40102810445370000059",
24          "recipientName": "Казначейство России (ФНС России)",
25          "recipientAccount": "03100643000000018500",
26          "recipientVatin": "7727406020",
27          "recipientKpp": "770801001",
28          "kbk": "18210506000011000110",
29          "oktmo": "45000000",
30          "code101": "01",
31          "code106": "ЗД",
32          "code107": "15.09.2023",
33          "code110": "0",
34          "dueDate": "2023-09-15",
35          "createdAt": "2023-09-15T13:14:08.136+03:00",
36          "internalId": 58469
37        }
38      ]
39    }
40  ]
41}
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

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

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

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

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