openapi: 3.2.0 info: title: Raiffeisen Ru Report V1 API version: 1.0.0 description: 'Operations tagged Report V1 across 2 of this provider''s published API definitions: raiffeisen-ru-bank-statements-openapi.yml, raiffeisen-ru-bank-statements-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.raiffeisen.ru/bank-statements tags: - name: Report V1 paths: /v1/reports/xml: post: tags: - Report V1 summary: Генерация выписки в формате XML description: Генерация XML отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: xmlRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateXmlReportRequest' examples: xmlRequestOnlyRequired: $ref: '#/components/examples/xmlRequestOnlyRequired' xmlRequestAllFields: $ref: '#/components/examples/xmlRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/excel: post: tags: - Report V1 summary: Генерация выписки в формате Excel description: Генерация Excel отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: excelRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExcelReportRequest' examples: excelRequestOnlyRequired: $ref: '#/components/examples/excelRequestOnlyRequired' excelRequestAllFields: $ref: '#/components/examples/excelRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/mt-942: post: tags: - Report V1 summary: Генерация выписки в формате MT942 description: Генерация MT942 отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: mt942Request parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: description: Для MT942 валидируется условие "from" == "to" == "текущая дата". content: application/json: schema: $ref: '#/components/schemas/CreateMt942ReportRequest' examples: mt942RequestOnlyRequired: $ref: '#/components/examples/mt942RequestOnlyRequired' mt942RequestAllFields: $ref: '#/components/examples/mt942RequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/mt-942-delta: post: tags: - Report V1 summary: Генерация инкрементальной внутридневной выписки в формате MT942 description: 'Генерация инкрементального MT942 отчета за текущий день по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. Для получения первой инкрементальной выписки за текущую дату отправьте запрос без параметра lastStatementNumber. Для получения следующих инкрементов укажите в параметре lastStatementNumber номер ранее полученной инкрементальной выписки (поле 28С). В течение календарного года номера инкрементальных выписок начинаются с 1 и последовательно увеличиваются, в начале нового календарного года нумерация снова начинается с 1.' operationId: mt942DeltaRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMt942DeltaReportRequest' examples: mt942RequestOnlyRequired: $ref: '#/components/examples/mt942DeltaRequestOnlyRequired' mt942RequestAllFields: $ref: '#/components/examples/mt942DeltaRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/mt-940: post: tags: - Report V1 summary: Генерация выписки в формате MT940 description: Генерация MT940 отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: mt940Request parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: description: Для MT940 валидируется условие "to" != "текущая дата". content: application/json: schema: $ref: '#/components/schemas/CreateMt940ReportRequest' examples: mt940RequestOnlyRequired: $ref: '#/components/examples/mt940RequestOnlyRequired' mt940RequestAllFields: $ref: '#/components/examples/mt940RequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/pdf/attachments: post: tags: - Report V1 summary: Генерация приложений к выписке в формате PDF description: Генерация приложений PDF отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: pdfAttachmentsRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePdfAttachmentsReportRequest' examples: pdfAttachmentsRequestOnlyRequired: $ref: '#/components/examples/pdfAttachmentsRequestOnlyRequired' pdfAttachmentsRequestAllFields: $ref: '#/components/examples/pdfAttachmentsRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorPdfAttachmentsReportRequest' '404': $ref: '#/components/responses/noStatementsErrorPdfAttachmentsReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/pdf: post: tags: - Report V1 summary: Генерация выписки в формате PDF с приложениями или без приложений description: Генерация PDF отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: pdfRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePdfReportRequest' examples: pdfRequestOnlyRequired: $ref: '#/components/examples/pdfRequestOnlyRequired' pdfRequestAllFields: $ref: '#/components/examples/pdfRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorPdfReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/1c: post: tags: - Report V1 summary: Генерация выписки в формате 1С description: Генерация 1C отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: oneCRequest parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/Create1CReportRequest' examples: oneCRequestOnlyRequired: $ref: '#/components/examples/oneCRequestOnlyRequired' oneCRequestAllFields: $ref: '#/components/examples/oneCRequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/camt-053: post: tags: - Report V1 summary: Генерация выписки в формате camt.053 description: Генерация camt.053 отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: camt053Request parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: description: Для camt.053 валидируется условие "to" != "текущая дата". content: application/json: schema: $ref: '#/components/schemas/CreateCamt053ReportRequest' examples: camt053RequestOnlyRequired: $ref: '#/components/examples/camt053RequestOnlyRequired' camt053RequestAllFields: $ref: '#/components/examples/camt053RequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/camt-052: post: tags: - Report V1 summary: Генерация выписки в формате camt.052 description: Генерация camt.052 отчета по переданным параметрам запроса. В ответе возвращается идентификатор генерации отчета. operationId: camt052Request parameters: - $ref: '#/components/parameters/dryRun' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' requestBody: description: Для camt.052 валидируется условие "from" == "to" == "текущая дата". content: application/json: schema: $ref: '#/components/schemas/CreateCamt052ReportRequest' examples: camt052RequestOnlyRequired: $ref: '#/components/examples/camt052RequestOnlyRequired' camt052RequestAllFields: $ref: '#/components/examples/camt052RequestAllFields' required: true responses: '200': $ref: '#/components/responses/dryRunCheckSuccess' '202': $ref: '#/components/responses/reportRequestGenerationAccepted' '400': $ref: '#/components/responses/requestValidationErrorReportRequest' '404': $ref: '#/components/responses/noStatementsErrorReportRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/{reportId}/status: get: tags: - Report V1 summary: Получение статуса генерации отчета description: Возвращает статус генерации отчета по переданному идентификатору. operationId: reportStatus parameters: - $ref: '#/components/parameters/reportId' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' responses: '200': $ref: '#/components/responses/reportStatus' '400': $ref: '#/components/responses/requestValidationErrorReportStatus' '404': $ref: '#/components/responses/reportNotFound' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements /v1/reports/{reportId}/file: get: tags: - Report V1 summary: Скачивание файла отчета description: Возвращает сгенерированный файл отчета. operationId: downloadReportFile parameters: - $ref: '#/components/parameters/range' - $ref: '#/components/parameters/reportId' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' responses: '200': $ref: '#/components/responses/fileContent' '400': $ref: '#/components/responses/requestValidationErrorFileStorage' '404': $ref: '#/components/responses/reportNotFound' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' head: tags: - Report V1 summary: Получение метаданных файла отчета description: Возвращает метаданные сгенерированного файла отчета operationId: downloadReportFileHead parameters: - $ref: '#/components/parameters/range' - $ref: '#/components/parameters/ifNoneMatch' - $ref: '#/components/parameters/reportId' - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' responses: '200': $ref: '#/components/responses/fileMetadata' '400': $ref: '#/components/responses/requestValidationErrorFileStorage' '404': $ref: '#/components/responses/reportNotFound' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' servers: - url: https://api.raiffeisen.ru/bank-statements components: examples: pdfAttachmentsRequestAllFields: summary: Запрос PDF приложения все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' fileName: file intraday: true debitCreditFilter: DEBIT counterpartyInn: '7718266916' counterpartyAccounts: - '40701978200000000001' - '40701978200000000001' splitBy: OPERATION sign: true sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC reportStatusCompleted: summary: Генерация отчета завершена value: reportId: 819e5e3c-07f8-4dda-a640-9d6d47bd9344 status: COMPLETED fileIsNotReady: summary: Файл отчета не готов value: code: report-file-is-not-ready message: Requested report file is not ready yet. statementsSignParamsError: summary: Невозможно подписать выписки. Внутридневные или разделенные на файлы выписки не могут быть подписаны. value: code: statements-sign-params-error message: 'Statements cannot be signed: intraday or split statements cannot be signed.' excelRequestAllFields: summary: Запрос Excel все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-09-06' to: '2023-10-06' zero: true fileName: file sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC intraday: true debitCreditFilter: DEBIT counterpartyInn: '7718266916' counterpartyAccounts: - '40701978200000000001' - '40701978200000000001' splitBy: ACCOUNT noStatements: summary: Выписок не найдено value: code: no-statements message: No statements were found that match the request parameters reportRequestGenerationAccepted: summary: Запрос на генерацию отчета был принят value: reportId: 819e5e3c-07f8-4dda-a640-9d6d47bd9344 oneCRequestOnlyRequired: summary: Запрос 1C только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' mt940RequestOnlyRequired: summary: Запрос MT940 только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' xmlRequestOnlyRequired: summary: Запрос XML только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' mt940RequestAllFields: summary: Запрос MT940 все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' fileName: file zero: true sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC splitBy: ACCOUNT_DATE encoding: WINDOWS showHeader: false field25: format: CUSTOM customValue: Счёт [Account Number] с БИКом [RCBIC] вставлен в отчёт field86: SEPA transliteration: true replacements: a:b;c:d;e:empty;f:space pdfAttachmentsRequestOnlyRequired: summary: Запрос PDF приложения только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' camt052RequestOnlyRequired: summary: Запрос camt052 только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' noTransactions: summary: Операций не найдено value: code: no-transactions message: No transactions were found that match the request parameters mt942DeltaRequestOnlyRequired: summary: Запрос инкрементальной выписки MT942 только обязательные поля value: accountKey: '40702810500001306832' oneCRequestAllFields: summary: Запрос 1C все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' zero: true fileName: file intraday: true debitCreditFilter: DEBIT includeHolds: true encoding: WINDOWS splitBy: ACCOUNT_DATE zeroIfNoStatementExpected: true sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC pdfRequestOnlyRequired: summary: Запрос PDF только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' withAttachments: true tooManyTransactionsError: summary: Превышено допустимое количество операций для генерации value: code: too-many-transactions-error message: Too many transactions for generation camt053RequestAllFields: summary: Запрос camt053 все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-09-06' to: '2023-10-06' zero: true fileName: file sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC excelRequestOnlyRequired: summary: Запрос Excel только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-09-06' to: '2023-10-06' statementsSignPeriodError: summary: Невозможно подписать выписки. Параметр "to" должен быть меньше текущей даты. value: code: statements-sign-period-error message: 'Statements cannot be signed: ''to'' is greater than or equal to current date.' xmlRequestAllFields: summary: Запрос XML все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' fileName: file zero: true sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC splitBy: ACCOUNT intraday: false reportStatusFailed: summary: Генерация отчета завершилась ошибкой value: reportId: 819e5e3c-07f8-4dda-a640-9d6d47bd9344 status: FAILED camt052RequestAllFields: summary: Запрос camt052 все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' zero: true fileName: file sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC uuidValidationError: summary: Ошибка валидации UUID value: code: bad-request message: 'Failed to read request Invalid UUID string: 8770a120-4280-423a-be0' reportStatusCreated: summary: Запрос на создание отчета создан value: reportId: 819e5e3c-07f8-4dda-a640-9d6d47bd9344 status: CREATED mt942RequestAllFields: summary: Запрос MT942 все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' fileName: file sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC splitBy: ACCOUNT_DATE encoding: WINDOWS showHeader: false field25: format: CUSTOM customValue: Счёт [Account Number] с БИКом [RCBIC] вставлен в отчёт field86: SEPA transliteration: true replacements: a:b;c:d;e:empty;f:space mt942RequestOnlyRequired: summary: Запрос MT942 только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-10-06' to: '2023-10-06' pdfRequestAllFields: summary: Запрос PDF все поля value: accountKeys: - 40701978200000000001:401867 - 40701978200000000001:401867 from: '2023-10-06' to: '2023-10-06' zero: true fileName: file intraday: true debitCreditFilter: DEBIT counterpartyInn: '7718266916' counterpartyAccounts: - '40701978200000000001' - '40701978200000000001' splitBy: ACCOUNT sign: true withAttachments: true sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC statementsSignNotReadyError: summary: Невозможно подписать выписки. Данные выписок не готовы. value: code: statements-sign-not-ready-error message: 'Statements cannot be signed: statements data is not ready yet.' reportStatusStarted: summary: Генерация отчета начата value: reportId: 819e5e3c-07f8-4dda-a640-9d6d47bd9344 status: STARTED mt942DeltaRequestAllFields: summary: Запрос инкрементальной выписки MT942 все поля value: accountKey: 40701978200000000001:401867 lastStatementNumber: 260 fileName: file sort: - sortBy: DEBIT orderBy: ASC - sortBy: CREDIT orderBy: ASC encoding: WINDOWS showHeader: false field25: format: CUSTOM customValue: Счёт [Account Number] с БИКом [RCBIC] вставлен в отчёт field86: SEPA transliteration: true replacements: a:b;c:d;e:empty;f:space accountKeyValidationError: summary: Ошибка валидации AccountKey value: code: account-key-parse-error message: 'Failed to read request JSON parse error: Wrong accountKey format [4070103610000000060867:::321312]' camt053RequestOnlyRequired: summary: Запрос camt053 только обязательные поля value: accountKeys: - 40701978200000000001:401867 - '40702810500001306832' from: '2023-09-06' to: '2023-10-06' schemas: Field25CustomValue: type: string description: Значение 25 поля для формата CUSTOM example: Счёт [Account Number] с БИКом [RCBIC] вставлен в отчёт SplitByExcel: type: string enum: - ACCOUNT - ACCOUNT_DATE - MULTIPLE_ACCOUNT_DATE description: "Разделить выписки на отдельные файлы и генерировать zip архив. \nACCOUNT - разделить по счетам (в архиве каждый файл будет содержать выписки за период по одному счету), \nACCOUNT_DATE - разделить по счетам и дням (в архиве каждый файл будет содержать выписки по счету за один день),\nMULTIPLE_ACCOUNT_DATE - разделить по дням (в архиве каждый файл будет содержать выписки по нескольким счетам за один день),\nnull - генерируется один файл. \nПо умолчанию генерируется один файл." example: ACCOUNT Intraday: type: boolean description: 'Включать внутридневные выписки: true - включать, false - не включать' default: false example: true DebitCreditFilter: type: string enum: - DEBIT - CREDIT - ALL description: 'Фильтр дебетовых/кредитовых операций: DEBIT - только дебетовые операции, CREDIT - только кредитовые операции, ALL - все операции' default: ALL example: DEBIT ReportSort: type: array items: $ref: '#/components/schemas/ServiceSortReportSortFields' SplitByAccountDateMT: type: string enum: - ACCOUNT_DATE - ACCOUNT_DATE_CHUNKS description: "Разделить выписки на отдельные файлы и генерировать zip архив. \nACCOUNT_DATE - разделить по счетам за день (в архиве каждый файл будет содержать выписки за один день по одному счету), \nACCOUNT_DATE_CHUNKS - разделить по счетам за день, разбивая файл на части по 1000 символов (в архиве каждый файл будет содержать часть выписки за один день по одному счету),\nnull - генерируется один файл. По умолчанию генерируется один файл." example: ACCOUNT_DATE LastStatementNumber: type: integer description: 'Номер последней полученной инкрементальной выписки MT942 (поле 28С). Параметр должен содержать корректный номер ранее полученной инкрементальной выписки за текущую дату либо может быть не заполнен для получения первой выписки за текущую дату.' example: 260 CounterpartyInn: type: string description: Фильтр операций по ИНН контрагента example: '7718266916' CreateCamt052ReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' required: - accountKeys - from - to Field25: type: object properties: format: $ref: '#/components/schemas/Field25Format' customValue: $ref: '#/components/schemas/Field25CustomValue' required: - format description: Настройка поля 25 example: format: CUSTOM customValue: Счёт [Account Number] с БИКом [RCBIC] вставлен в отчёт default: format: SWIFT_ACCOUNT_CURRENCY WithAttachments: type: boolean description: 'Генерировать выписку с приложениями или без приложений: true - with, false - without' example: true CreateMt942ReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' splitBy: $ref: '#/components/schemas/SplitByAccountDateMT' encoding: $ref: '#/components/schemas/EncodingMt' showHeader: $ref: '#/components/schemas/ShowHeader' field25: $ref: '#/components/schemas/Field25' field86: $ref: '#/components/schemas/Field86' transliteration: $ref: '#/components/schemas/Transliteration' replacements: $ref: '#/components/schemas/Replacements' required: - accountKeys - from - to RequestIntervalFrom: type: string format: date description: Дата выписки с example: '2023-10-06' SplitByAccount: type: string enum: - ACCOUNT description: Разделить выписки на отдельные файлы и генерировать zip архив. ACCOUNT - разделить по счетам (в архиве каждый файл будет содержать выписки за период по одному счету), null - генерируется один файл. По умолчанию генерируется один файл. example: ACCOUNT ErrorResponse: type: object required: - code properties: code: $ref: '#/components/schemas/ErrorType' message: $ref: '#/components/schemas/ErrorMessage' example: code: too-many-transactions-error message: Too many transactions for print Transliteration: type: boolean description: Транслитерация в поле 86 example: true default: false CreateCamt053ReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' required: - accountKeys - from - to ShowVat: type: boolean description: Признак добавления колонки "Сумма НДС". Значение НДС извлекается из текста назначения платежа по шаблонам и может отсутствовать или быть определено некорректно. true - добавить колонку "Сумма НДС" (только для рублёвых счетов), false - не добавлять колонку default: false example: true ReportGenerationRequestResponse: type: object properties: reportId: $ref: '#/components/schemas/ReportId' example: reportId: 4c8d9891-4ee9-4ac8-ae2d-e41ad9f5ee10 SplitByPdf: type: string enum: - ACCOUNT - ACCOUNT_DATE - MULTIPLE_ACCOUNT_DATE description: 'Разделить выписки на отдельные файлы и генерировать zip архив. ACCOUNT - разделить по счетам (в архиве каждый файл будет содержать выписки за период по одному счету), ACCOUNT_DATE - разделить по счетам и дням (в архиве каждый файл будет содержать выписки по счету за один день), MULTIPLE_ACCOUNT_DATE - разделить по дням (в архиве каждый файл будет содержать выписки по нескольким счетам за один день), null - генерируется один файл. По умолчанию генерируется один файл.' example: ACCOUNT SplitByOperation: type: string enum: - OPERATION description: Разделить приложения к выписке на отдельные файлы и генерировать zip архив. OPERATION - разделить по операциям (в архиве каждый файл будет содержать отдельную операцию), null - генерируется один файл. По умолчанию генерируется один файл. example: OPERATION FileName: type: string description: Имя сгенерированного файла example: qwerty SortBy: type: string enum: - DEBIT - CREDIT description: Поле сортировки example: CREDIT CreateXmlReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' intraday: $ref: '#/components/schemas/Intraday' splitBy: $ref: '#/components/schemas/SplitByAccount' required: - accountKeys - from - to ServiceSortReportSortFields: type: object properties: sortBy: $ref: '#/components/schemas/SortBy' orderBy: $ref: '#/components/schemas/OrderBy' required: - sortBy - orderBy example: sortBy: DEBIT orderBy: ASC Field86: type: string enum: - SEPA - OLD - DISABLED description: Формат 86 поля. SEPA - формта SEPA, OLD - Старый формат (NZP/[Details of payment]), DISABLED - не добавлять поле 86 example: OLD default: SEPA Create1CReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' intraday: $ref: '#/components/schemas/Intraday' debitCreditFilter: $ref: '#/components/schemas/DebitCreditFilter' includeHolds: $ref: '#/components/schemas/IncludeHolds' encoding: $ref: '#/components/schemas/Encoding1C' splitBy: $ref: '#/components/schemas/SplitByAccountDate' zeroIfNoStatementExpected: $ref: '#/components/schemas/ZeroIfNoStatementExpected' required: - accountKeys - from - to ErrorType: type: string enum: - BAD_REQUEST - STATEMENT_KEY_PARSE_ERROR - ACCOUNT_KEY_PARSE_ERROR - TRANSACTION_KEY_PARSE_ERROR - STMT_FILE_NAME_PARSE_ERROR - REPLACEMENTS_PARSE_ERROR - TOO_MANY_TRANSACTIONS_ERROR - NO_STATEMENTS - NO_TRANSACTIONS - STATEMENTS_PERIOD_BEFORE_OPEN_ERROR - STATEMENTS_PERIOD_NOT_READY_ERROR - STATEMENTS_PERIOD_NO_COB_ERROR - STATEMENTS_SIGN_NOT_READY_ERROR - STATEMENTS_SIGN_PERIOD_ERROR - STATEMENTS_SIGN_PARAMS_ERROR - REPORT_FILE_IS_NOT_READY CreateExcelReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' intraday: $ref: '#/components/schemas/Intraday' debitCreditFilter: $ref: '#/components/schemas/DebitCreditFilter' counterpartyInn: $ref: '#/components/schemas/CounterpartyInn' counterpartyAccounts: $ref: '#/components/schemas/CounterpartyAccounts' splitBy: $ref: '#/components/schemas/SplitByExcel' showVat: $ref: '#/components/schemas/ShowVat' required: - accountKeys - from - to EncodingMt: type: string enum: - WINDOWS - DOS - UTF8 description: 'Кодировка файла: WINDOWS - cp1251, DOS - cp866, UTF8 - utf-8' default: WINDOWS example: DOS IncludeHolds: type: boolean description: 'Включать холды: true - включать, false - не включать' default: true example: false Replacements: type: string description: Правила корректировки символов SWIFT в поле 86 и 61. В формате "sourceChar1:targetChar1;sourceChar2:targetChar2". В targetChar могут быть символы пустой строки и пробела ('empty', 'space'). example: a:b;c:d;e:empty;f:space AccountKeys: type: array description: 'Бизнес-ключ счета. Формат: `<20-значный номер счета>` или `<20-значный номер счета>:`' example: - 40701978200000000001:401867 - '40702810500001306832' items: type: string CreateMt942DeltaReportRequest: type: object properties: accountKey: $ref: '#/components/schemas/AccountKey' lastStatementNumber: $ref: '#/components/schemas/LastStatementNumber' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' encoding: $ref: '#/components/schemas/EncodingMt' showHeader: $ref: '#/components/schemas/ShowHeader' field25: $ref: '#/components/schemas/Field25' field86: $ref: '#/components/schemas/Field86' transliteration: $ref: '#/components/schemas/Transliteration' replacements: $ref: '#/components/schemas/Replacements' required: - accountKey CreatePdfReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' intraday: $ref: '#/components/schemas/Intraday' debitCreditFilter: $ref: '#/components/schemas/DebitCreditFilter' counterpartyInn: $ref: '#/components/schemas/CounterpartyInn' counterpartyAccounts: $ref: '#/components/schemas/CounterpartyAccounts' splitBy: $ref: '#/components/schemas/SplitByPdf' sign: $ref: '#/components/schemas/Sign' withAttachments: $ref: '#/components/schemas/WithAttachments' required: - accountKeys - from - to - withAttachments Field25Format: type: string enum: - SWIFT_ACCOUNT_CURRENCY - SWIFT_ACCOUNT - RCBIC_ACCOUNT - CUSTOM description: "Формат поля 25. SWIFT_ACCOUNT_CURRENCY - строка формата [SWIFT][Счет][Валюта счета], SWIFT_ACCOUNT - строка формата [SWIFT][Счет], RCBIC_ACCOUNT - строка формата [RCBIC][Счет], CUSTOM - кастомизируемый формат. \nДля формата CUSTOM доступны переменные: [Account Number] - счет, [RCBIC] - БИК Банка, [SWIFT] - SWIFT код банка, [Cur] - валюта счета." example: RCBIC_ACCOUNT default: SWIFT_ACCOUNT_CURRENCY Zero: type: boolean description: Включать нулевые выписки, true - все выписки (с движениями по счету и без), false - только выписки с движениями по счету (ненулевые) default: false example: true SplitByAccountDate: type: string enum: - ACCOUNT_DATE description: Разделить выписки на отдельные файлы и генерировать zip архив. ACCOUNT_DATE - разделить по счетам за день (в архиве каждый файл будет содержать выписки за один день по одному счету), null - генерируется один файл. По умолчанию генерируется один файл. example: ACCOUNT_DATE Sign: type: boolean description: 'Подписывать итоговые выписки: true - подписывать, false - не подписывать' default: false example: true OrderBy: type: string enum: - ASC - DESC description: Направление сортировки example: ASC RequestIntervalTo: type: string format: date description: Дата выписки по example: '2023-10-06' CreateMt940ReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' zero: $ref: '#/components/schemas/Zero' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' splitBy: $ref: '#/components/schemas/SplitByAccountDateMT' encoding: $ref: '#/components/schemas/EncodingMt' showHeader: $ref: '#/components/schemas/ShowHeader' field25: $ref: '#/components/schemas/Field25' field86: $ref: '#/components/schemas/Field86' transliteration: $ref: '#/components/schemas/Transliteration' replacements: $ref: '#/components/schemas/Replacements' required: - accountKeys - from - to CounterpartyAccounts: type: array description: Фильтр операций по счетам контрагента example: - '40701978200000000001' - '40701978200000000002' items: type: string ShowHeader: type: boolean description: Отображать заголовок выписок example: true default: false Encoding1C: type: string enum: - WINDOWS - DOS description: 'Кодировка файла: WINDOWS - cp1251, DOS - cp866' default: WINDOWS example: DOS ErrorMessage: type: string description: Сообщение об ошибке example: Too many transactions for print AccountKey: type: string description: 'Бизнес-ключ счета. Формат: `<20-значный номер счета>` или `<20-значный номер счета>:`' example: '40702810500001306832' ZeroIfNoStatementExpected: type: boolean description: Генерировать синтетическую нулевую итоговую выписку, когда обычная выписка не будет генерироваться. example: true default: false ReportGenerationStatusResponse: type: object properties: reportId: $ref: '#/components/schemas/ReportId' status: type: string enum: - CREATED - STARTED - FAILED - STOPPED - RESTARTED - COMPLETED - CANCELLED required: - status - reportId example: reportId: 4c8d9891-4ee9-4ac8-ae2d-e41ad9f5ee10 status: STARTED CreatePdfAttachmentsReportRequest: type: object properties: accountKeys: $ref: '#/components/schemas/AccountKeys' from: $ref: '#/components/schemas/RequestIntervalFrom' to: $ref: '#/components/schemas/RequestIntervalTo' fileName: $ref: '#/components/schemas/FileName' sort: $ref: '#/components/schemas/ReportSort' intraday: $ref: '#/components/schemas/Intraday' debitCreditFilter: $ref: '#/components/schemas/DebitCreditFilter' counterpartyInn: $ref: '#/components/schemas/CounterpartyInn' counterpartyAccounts: $ref: '#/components/schemas/CounterpartyAccounts' splitBy: $ref: '#/components/schemas/SplitByOperation' sign: $ref: '#/components/schemas/Sign' required: - accountKeys - from - to ReportId: type: string format: uuid description: Идентификатор отчета example: 4c8d9891-4ee9-4ac8-ae2d-e41ad9f5ee10 parameters: contentLength: name: Content-Length in: header description: Стандартное поведение заголовка Content-Length. schema: type: string example: '1809115' AuthorizationHeader: name: Authorization in: header description: Токен доступа required: true schema: type: string format: byte example: Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc= ifNoneMatch: name: If-None-Match in: header description: Проверить был ли модифицирован файл по значению заголовка ETag schema: type: string example: b7a68b1bfd796350eebccce70ae597e4 reportId: name: reportId in: path description: Идентификатор отчета required: true schema: type: string format: uuid example: f81d4fae-7dec-11d0-a765-00a0c91e6bf6 range: name: Range in: header description: Скачивать определенный интервал байтов файла required: false schema: type: string example: bytes=500-999 eTag: name: ETag in: header description: Идентификатор версии ресурса schema: type: string example: b7a68b1bfd796350eebccce70ae597e4 dryRun: name: dryRun in: query description: "Параметр позволяет выполнить проверку необходимых условий для формирования отчета без запуска генерации. \ntrue - будут выполнены все необходимые проверки перед формированием отчета без запуска генерации. В случае невозможности сгенерировать отчет будет возвращаться ошибка. \nfalse - проверка необходимых условий для формирования отчета будет выполнена и затем запущена генерация." schema: type: boolean default: false example: true IdTokenHeader: name: Id-Token in: header description: Идентификационный токен пользователя required: true schema: type: string format: byte example: SUQgVE9LRU4gRk9SIFRFU1RJTkc= contentDisposition: name: Content-Disposition in: header description: Стандартное поведение заголовка Content-Disposition. schema: type: string example: attachment; filename="export_to_pdf_05-05-2025_20-38-50.zip" acceptRanges: name: Accept-Ranges in: header description: Стандартное поведение заголовка Accept-Ranges. schema: type: string example: bytes responses: reportStatus: description: Статус задачи content: application/json: schema: $ref: '#/components/schemas/ReportGenerationStatusResponse' examples: reportStatusCreated: $ref: '#/components/examples/reportStatusCreated' reportStatusStarted: $ref: '#/components/examples/reportStatusStarted' reportStatusFailed: $ref: '#/components/examples/reportStatusFailed' reportStatusCompleted: $ref: '#/components/examples/reportStatusCompleted' dryRunCheckSuccess: description: Проверка возможности генерации выполнена успешно fileMetadata: description: Метаданные файла headers: ETag: schema: $ref: '#/components/parameters/eTag' Content-Disposition: schema: $ref: '#/components/parameters/contentDisposition' Accept-Ranges: schema: $ref: '#/components/parameters/acceptRanges' Content-Length: schema: $ref: '#/components/parameters/contentLength' requestValidationErrorPdfReportRequest: description: Ошибка валидации запроса content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: tooManyTransactionsError: $ref: '#/components/examples/tooManyTransactionsError' accountKeyValidationError: $ref: '#/components/examples/accountKeyValidationError' statementsSignNotReadyError: $ref: '#/components/examples/statementsSignNotReadyError' statementsSignPeriodError: $ref: '#/components/examples/statementsSignPeriodError' statementsSignParamsError: $ref: '#/components/examples/statementsSignParamsError' InternalError: description: Внутренняя ошибка noStatementsErrorReportRequest: description: Нет выписок по указанным параметрам content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: noStatements: $ref: '#/components/examples/noStatements' requestValidationErrorReportStatus: description: Ошибка валидации запроса content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: uuidValidationError: $ref: '#/components/examples/uuidValidationError' requestValidationErrorPdfAttachmentsReportRequest: description: Ошибка валидации запроса content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: tooManyTransactionsError: $ref: '#/components/examples/tooManyTransactionsError' accountKeyValidationError: $ref: '#/components/examples/accountKeyValidationError' statementsSignNotReadyError: $ref: '#/components/examples/statementsSignNotReadyError' statementsSignPeriodError: $ref: '#/components/examples/statementsSignPeriodError' statementsSignParamsError: $ref: '#/components/examples/statementsSignParamsError' reportNotFound: description: Отчета не найдено requestValidationErrorReportRequest: description: Ошибка валидации запроса content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: tooManyTransactionsError: $ref: '#/components/examples/tooManyTransactionsError' accountKeyValidationError: $ref: '#/components/examples/accountKeyValidationError' fileContent: description: Содержимое файла. headers: ETag: schema: $ref: '#/components/parameters/eTag' Content-Disposition: schema: $ref: '#/components/parameters/contentDisposition' Accept-Ranges: schema: $ref: '#/components/parameters/acceptRanges' Content-Length: schema: $ref: '#/components/parameters/contentLength' content: application/xml: schema: type: string format: binary application/pdf: schema: type: string format: binary application/zip: schema: type: string format: binary application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary text/plain: schema: type: string format: binary reportRequestGenerationAccepted: description: Запрос на генерацию принят content: application/json: schema: $ref: '#/components/schemas/ReportGenerationRequestResponse' examples: reportRequestGenerationAcceptedResponse: $ref: '#/components/examples/reportRequestGenerationAccepted' noStatementsErrorPdfAttachmentsReportRequest: description: Нет выписок или операций по указанным параметрам content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: noStatements: $ref: '#/components/examples/noStatements' noTransactions: $ref: '#/components/examples/noTransactions' requestValidationErrorFileStorage: description: Ошибка валидации запроса content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: uuidValidationError: $ref: '#/components/examples/uuidValidationError' fileIsNotReady: $ref: '#/components/examples/fileIsNotReady' Unauthorized: description: Аутентификация не пройдена x-refined-from: - raiffeisen-ru-bank-statements-openapi.yml - raiffeisen-ru-bank-statements-openapi.yml