B2BH2H

Получение отчёта по счетам эскроу

Песочница
POST https://sandbox.alfabank.ru/api/jp/v1/escrow-reports
Пром
POST https://baas.alfabank.ru/api/jp/v1/escrow-reports
Scope

escrow-reports

Описание

Метод возвращает данные для формирования отчёта по счетам эскроу застройщика на основе списка объектов и этапов строительства застройщика, полученных с помощью метода «Получение объектов и этапов строительства для отчёта по счетам эскроу».

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

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

offset
integerrequired

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

periodFrom
stringrequired

Начальная дата периода для формирования отчёта

periodTo
stringrequired

Конечная дата периода для формирования отчёта

BODY
Атрибут
Описание
array of objectsrequired

Информация об объектах строительства

buildPermitNumber
stringrequired

Номер РНС (разрешение на строительство)

projectNumber
stringrequired

Номер проекта строительства

commercialName
stringoptional

Коммерческое обозначение объекта

actualProjectCompletionDate
stringoptional

Дата РНС

array of objectsrequired

Этапы строительства

index
integerrequired

Порядковый номер этапа строительства в пределах проекта

name
stringoptional

Краткое имя этапа строительства

termEscrowOrder
stringoptional

Срок учёта и блокирования депонированной суммы на счёте эскроу по ДДУ

showAccountTransactions
booleanrequired

Признак отображения транзакций

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/escrow-reports?limit={limit}&offset={offset}&periodFrom={periodFrom}&periodTo={periodTo}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "buildProjects": [
7    {
8      "buildPermitNumber": "№599-35-92-2024",
9      "projectNumber": "503-302",
10      "commercialName": "Тестовый жилой комплекс",
11      "actualProjectCompletionDate": "2024-02-10T00:00:00.000Z",
12      "phases": [
13        {
14          "index": 1,
15          "name": "Дом",
16          "termEscrowOrder": "2024-02-10T00:00:00.000Z"
17        }
18      ]
19    }
20  ],
21  "showAccountTransactions": true
22}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "report": {
3    "pagination": {
4      "limit": 10,
5      "offset": 2,
6      "totalCount": 90
7    },
8    "commonInfo": {
9      "customerNameTo": "Тестовая организация ИНН 0000000",
10      "periodTo": "2024-02-10T00:00:00.000Z",
11      "periodFrom": "2022-02-10T00:00:00.000Z",
12      "reportGenerationDate": "2024-02-10T00:00:00.000Z"
13    },
14    "escrowAccountInfo": [
15      {
16        "buildPermitNumber": "№599-35-92-2024",
17        "commercialName": "Тестовый жилой комплекс",
18        "buildProjectPhase": 2,
19        "phaseDescription": "Паркинг",
20        "escrowAccountNumber": "40824810906580012508",
21        "escrowAccountCurrentStatus": "Пополнен",
22        "escrowAccountOpenDate": "2024-02-10T00:00:00.000Z",
23        "escrowAccountOpenPlace": "Онлайн",
24        "escrowAccountReservePlace": "Онлайн",
25        "developerManager": "Иванов Иван Иванович",
26        "objectType": "Квартира",
27        "apartmentCost": "12600000.55",
28        "incomingBalance": "0.00",
29        "outcomingBalance": "12600000.55",
30        "balanceChange": "12600000.55",
31        "depositCompletionDate": "2024-02-10T00:00:00.000Z",
32        "deponentName": "Сергеев Сергей Сергеевич",
33        "deponentINN": "184514811334",
34        "shareAgreementNumber": "22-444/111П-1234",
35        "shareAgreementDate": "2024-02-10T00:00:00.000Z",
36        "assignmentAgreementNumber": "ДУ 103-4 от 12.02.2023",
37        "assignmentAgreementDate": "2024-02-10T00:00:00.000Z",
38        "escrowAccountCloseDate": "2024-02-10T00:00:00.000Z",
39        "isRegisteredShareAgreementProvided": "Y",
40        "transactions": [
41          {
42            "operationDate": "2024-02-10T00:00:00.000Z",
43            "transactionAmount": "150000.55",
44            "primaryDocumentNumber": "23234",
45            "primaryDocumentDate": "2025-01-31T00:00:00.000Z",
46            "bicBank": "044525593"
47          }
48        ]
49      }
50    ]
51  }
52}
BODY
атрибут
описание
objectoptional

Данные для отчёта по счетам эскроу

objectoptional

Пагинация

limit
integeroptional

Количество возвращаемых записей

offset
integeroptional

Количество записей для смещения

totalCount
integeroptional

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

objectoptional

Данные об отчёте

customerNameTo
stringoptional

Наименование организации застройщика

periodTo
stringoptional

Конечная дата периода для формирования отчёта

periodFrom
stringoptional

Начальная дата периода для формирования отчёта

reportGenerationDate
stringoptional

Дата формирования отчёта

array of objectsoptional

Данные о счёте эскроу

buildPermitNumber
stringoptional

Номер РНС

commercialName
stringoptional

Наименование проекта строительства

buildProjectPhase
integeroptional

Порядковый номер этапа строительства в пределах проекта

phaseDescription
stringoptional

Наименование этапа строительства

escrowAccountNumber
stringoptional

Номер счёта

escrowAccountCurrentStatus
stringoptional

Текущий статус

escrowAccountOpenDate
stringoptional

Дата открытия счёта

escrowAccountOpenPlace
stringoptional

Место открытия счёта эскроу

escrowAccountReservePlace
stringoptional

Место резервирования счёта эскроу

developerManager
stringoptional

ФИО менеджера, который резервировал счёт эскроу

objectType
stringoptional

Вид помещения

apartmentCost
stringoptional

Стоимость объекта по ДДУ в рублях

incomingBalance
stringoptional

Входящий остаток на начало периода в рублях

outcomingBalance
stringoptional

Исходящий остаток на конец периода в рублях

balanceChange
stringoptional

Изменение остатка за период отчёта в рублях

depositCompletionDate
stringoptional

Дата завершения срока условного депонирования

deponentName
stringoptional

ФИО депозитора

deponentINN
stringoptional

ИНН депозитора

shareAgreementNumber
stringoptional

Данные договора об участии счёта

shareAgreementDate
stringoptional

Дата ДДУ

assignmentAgreementNumber
stringoptional

Номер договора переуступки

assignmentAgreementDate
stringoptional

Дата договора переуступки

escrowAccountCloseDate
stringoptional

Дата закрытия счёта

isRegisteredShareAgreementProvided
stringoptional

Признак предоставления зарегистрированного ДДУ:

  • Y - зарегистрированный ДДУ предоставлен;
  • N - зарегистрированный ДДУ не предоставлен
array of objectsoptional

Данные о транзакциях

operationDate
stringoptional

Дата ввода полупроводки

transactionAmount
stringoptional

Сумма транзакции со знаком в минимальных единицах валюты счёта

primaryDocumentNumber
stringoptional

Номер платёжного документа (первичного документа) по операции

primaryDocumentDate
stringoptional

Дата платёжного (первичного документа) документа по операции

bicBank
stringoptional

БИК банка отправителя по операции

Пример ответа 200 (OK)
1{
2  "report": {
3    "pagination": {
4      "limit": 10,
5      "offset": 2,
6      "totalCount": 90
7    },
8    "commonInfo": {
9      "customerNameTo": "Тестовая организация ИНН 0000000",
10      "periodTo": "2024-02-10T00:00:00.000Z",
11      "periodFrom": "2022-02-10T00:00:00.000Z",
12      "reportGenerationDate": "2024-02-10T00:00:00.000Z"
13    },
14    "escrowAccountInfo": [
15      {
16        "buildPermitNumber": "№599-35-92-2024",
17        "commercialName": "Тестовый жилой комплекс",
18        "buildProjectPhase": 2,
19        "phaseDescription": "Паркинг",
20        "escrowAccountNumber": "40824810906580012508",
21        "escrowAccountCurrentStatus": "Пополнен",
22        "escrowAccountOpenDate": "2024-02-10T00:00:00.000Z",
23        "escrowAccountOpenPlace": "Онлайн",
24        "escrowAccountReservePlace": "Онлайн",
25        "developerManager": "Иванов Иван Иванович",
26        "objectType": "Квартира",
27        "apartmentCost": "12600000.55",
28        "incomingBalance": "0.00",
29        "outcomingBalance": "12600000.55",
30        "balanceChange": "12600000.55",
31        "depositCompletionDate": "2024-02-10T00:00:00.000Z",
32        "deponentName": "Сергеев Сергей Сергеевич",
33        "deponentINN": "184514811334",
34        "shareAgreementNumber": "22-444/111П-1234",
35        "shareAgreementDate": "2024-02-10T00:00:00.000Z",
36        "assignmentAgreementNumber": "ДУ 103-4 от 12.02.2023",
37        "assignmentAgreementDate": "2024-02-10T00:00:00.000Z",
38        "escrowAccountCloseDate": "2024-02-10T00:00:00.000Z",
39        "isRegisteredShareAgreementProvided": "Y",
40        "transactions": [
41          {
42            "operationDate": "2024-02-10T00:00:00.000Z",
43            "transactionAmount": "150000.55",
44            "primaryDocumentNumber": "23234",
45            "primaryDocumentDate": "2025-01-31T00:00:00.000Z",
46            "bicBank": "044525593"
47          }
48        ]
49      }
50    ]
51  }
52}
BODY
атрибут
описание
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}
BODY
атрибут
описание
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}
BODY
атрибут
описание
error
stringrequired

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

  • insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope;
  • 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}
BODY
атрибут
описание
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}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

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

  • internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

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

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

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