openapi: 3.2.0 info: title: Raiffeisen Ru Condition API version: 1.0.0 description: 'Operations tagged Condition across 2 of this provider''s published API definitions: raiffeisen-ru-payment-control-openapi.yml, raiffeisen-ru-payment-control-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.raiffeisen.ru/pay-control tags: - description: Условия name: Condition paths: /v1/conditions: get: description: Метод получение списка условий обслуживания по фильтрам operationId: getConditions parameters: - description: Клиентский номер examples: oneCnum: summary: Пример с одним клиентский номером value: - AAAAAA multipleCnums: summary: Пример с несколькими клиентскими номерами value: - AAAAAA - BBBBBB in: query name: cnums required: false schema: example: - AAAAAA items: example: AAAAAA type: string type: array - description: ИНН или наименование покупателя examples: inn: summary: Только инн value: '33333333' name: summary: Только наименование value: Ромаш in: query name: buyerInnOrNameSearchParam required: false schema: example: Ромаш type: string - description: Номер контракта examples: simple: summary: Номер контракта value: КОНТРАКТ-1 in: query name: contractNumber required: false schema: example: КОНТРАКТ-1 type: string - description: Статусы условия обслуживания examples: oneStatus: summary: Один статус value: - APPROVED multipleStatuses: summary: Несколько статусов value: - APPROVED - SENT_TO_SIGN in: query name: statuses required: false schema: example: - APPROVED items: $ref: '#/components/schemas/ConditionStatus' type: array - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Успешно создан value: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contractNumber: ДП-1 contractDate: '2025-07-10' client: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 buyer: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' fullName: Акционерное общество Ромашка shortName: АО Ромашка inn: '1234567890' kpp: '123456789' ogrn: '123456789012345' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 tariffs: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: LITE paymentPeriod: 0 startDate: '2025-01-10' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 wasApproved: true state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: SENT_TO_SIGN cqrsVersion: -1628796591 schema: $ref: '#/components/schemas/ConditionList' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение списка условий обслуживания по фильтрам tags: - Condition post: description: Метод создания и обновления условий обслуживания operationId: createOrUpdateCondition requestBody: content: application/json: examples: create: summary: Создание условий value: contractNumber: ДП-1 contractDate: '2025-07-10' clientId: 2c44306f-fc96-4780-9b37-6447273b190e buyerId: 2c44306f-fc96-4780-9b37-6447273b190e comment: Комментарий contacts: - fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий newTariff: tariffType: PRO paymentPeriod: 60 update: summary: Обновление условий value: id: 2c44306f-fc96-4780-9b37-6447273b190e contractNumber: ДП-1 contractDate: '2025-07-10' clientId: 2c44306f-fc96-4780-9b37-6447273b190e buyerId: 2c44306f-fc96-4780-9b37-6447273b190e comment: Комментарий contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий cqrsVersion: 222222 newTariff: id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 cqrsVersion: 3333333 cqrsVersion: 111111 updateWithReplaceContactsAndNewTariff: summary: Обновление с заменой ранее введенных контактов и тарифов value: id: 2c44306f-fc96-4780-9b37-6447273b190e contractNumber: ДП-1 contractDate: '2025-07-10' clientId: 2c44306f-fc96-4780-9b37-6447273b190e buyerId: 2c44306f-fc96-4780-9b37-6447273b190e comment: Комментарий contacts: - fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий newTariff: tariffType: LITE cqrsVersion: 111111 schema: $ref: '#/components/schemas/ConditionRequest' description: Параметры для создания required: true responses: '200': content: application/json: examples: simple: summary: Успешно создан value: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contractNumber: ДП-1 contractDate: '2025-07-10' client: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '1234567890123' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: AO Romashka cnum: AAAAAA fullNameEn: Joint Stock Company Romashka okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: client@example.com state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: 111111 state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 222222 buyer: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' fullName: Акционерное общество Ромашка shortName: АО Ромашка inn: '1234567890' kpp: '123456789' ogrn: '1234567890123' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 333333 contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: ivanov@example.com phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: 444444 tariffs: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 555555 wasApproved: true state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: SENT_TO_SIGN cqrsVersion: 666666 schema: $ref: '#/components/schemas/Condition' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Управление условиями tags: - Condition parameters: - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' servers: - url: https://api.raiffeisen.ru/pay-control /v1/conditions/{id}/digest: get: description: Метод получения дайджеста условия обслуживания для подписи operationId: getConditionDigest parameters: - description: Идентификатор условий обслуживания in: path name: id required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Дайджест value: digest: 0JLQvtGCINGN0YLQviDQvdGD0LbQvdC+INC/0L7QtNC/0LjRgdCw0YLRjA== schema: $ref: '#/components/schemas/DigestResponse' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение дайджеста условия обслуживания для подписи tags: - Condition servers: - url: https://api.raiffeisen.ru/pay-control /v1/conditions/{id}: get: description: Метод получения условия обслуживания по идентификатору operationId: getConditionById parameters: - description: Идентификатор условий обслуживания in: path name: id required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Условие обслуживания value: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contractNumber: ДП-1 contractDate: '2025-07-10' client: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '1234567890123' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: AO Romashka cnum: AAAAAA fullNameEn: Joint Stock Company Romashka okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: client@example.com state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: 111111 state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 222222 buyer: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' fullName: Акционерное общество Ромашка shortName: АО Ромашка inn: '1234567890' kpp: '123456789' ogrn: '1234567890123' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 333333 contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: ivanov@example.com phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: 444444 tariffs: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: 555555 wasApproved: true state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: SENT_TO_SIGN cqrsVersion: 666666 schema: $ref: '#/components/schemas/Condition' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение условия обслуживания по идентификатору tags: - Condition servers: - url: https://api.raiffeisen.ru/pay-control /v1/conditions/{id}/change-status-to-retired: post: description: Метод удаления условия обслуживания по идентификатору operationId: deleteConditionById parameters: - description: Идентификатор условий обслуживания in: path name: id required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' requestBody: content: application/json: examples: simple: summary: Удаление условия value: cqrsVersion: 666666 schema: $ref: '#/components/schemas/CqrsRequest' description: Параметры для удаления условия required: true responses: '200': description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Удаление условия обслуживания по идентификатору tags: - Condition servers: - url: https://api.raiffeisen.ru/pay-control /v1/conditions/{id}/report: get: description: Метод получения документа условий обслуживания в формате base64 для предпросмотра operationId: getConditionReport parameters: - description: Идентификатор условий обслуживания in: path name: id required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Документ для предпросмотра value: content: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg== schema: $ref: '#/components/schemas/ConditionReportResponse' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение документа условий обслуживания для предпросмотра tags: - Condition servers: - url: https://api.raiffeisen.ru/pay-control /v1/conditions/{id}/sign: post: description: Метод перевода условия обслуживания из статуса DRAFT в статус SENT_TO_SIGN operationId: sendConditionToSign parameters: - description: Идентификатор условий обслуживания in: path name: id required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' requestBody: content: application/json: examples: simple: summary: Перевод в статус SENT_TO_SIGN value: cqrsVersion: 666666 schema: $ref: '#/components/schemas/CqrsRequest' description: Параметры для перевода условия в статус SENT_TO_SIGN required: true responses: '200': description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Перевод условия обслуживания в статус SENT_TO_SIGN tags: - Condition servers: - url: https://api.raiffeisen.ru/pay-control components: schemas: RestErrorCodes: description: '| code | description | |-----------------|------------------------------------------------------------------| | REST_ERROR_5001 | General service error | | REST_ERROR_5002 | Current CQRS version is different | | REST_ERROR_0001 | inn not valid | | REST_ERROR_0002 | ogrn not valid | | REST_ERROR_0003 | okved not valid | | REST_ERROR_0004 | opf not valid | | REST_ERROR_0005 | fullNameRus not valid | | REST_ERROR_0006 | shortNameRus not valid | | REST_ERROR_0007 | fullNameEn not valid | | REST_ERROR_0008 | shortNameEn not valid | | REST_ERROR_0009 | address not valid | | REST_ERROR_0010 | you can`t use product | | REST_ERROR_0011 | buyer already exists | | REST_ERROR_0012 | can''t fetched buyer requisites from DaData | | REST_ERROR_0013 | can''t find data for buyer requisites | | REST_ERROR_0014 | client not valid | | REST_ERROR_0015 | agreement not valid | | REST_ERROR_0016 | buyer not valid | | REST_ERROR_0017 | condition with contract number and date already exists | | REST_ERROR_0018 | for the PRO tariff, at least one contact must be fully filled in | | REST_ERROR_0019 | for the PRO newTariff, payment period must be filled | | REST_ERROR_0020 | for the PRO newTariff, payment period must be less then max | | REST_ERROR_0021 | contract date must be after then current date | | REST_ERROR_0022 | agreement already exists for client | | REST_ERROR_0023 | condition with current contract number and date already exist | | REST_ERROR_1000 | Unexpected error. Call to support team - paycontrol.support@raiffeisen.ru. | | REST_ERROR_1001 | File contains viruses | | REST_ERROR_1002 | Incorrect file format | | REST_ERROR_1003 | Supplies number exceeds limit | | REST_ERROR_1004 | The file size exceeds 1 MB | | REST_ERROR_1005 | Invalid cell type (row %d, column %d) | | REST_ERROR_1006 | Incorrect number of columns, expected: %d, found: %d | | REST_ERROR_1007 | Invalid header, expected: %s, found: %s | | REST_ERROR_1008 | INN must contain 10 or 12 digits | | REST_ERROR_1009 | INN cannot be empty | | REST_ERROR_1010 | contract number cannot be empty | | REST_ERROR_1011 | contract date cannot be empty | | REST_ERROR_1012 | primary document number is empty | | REST_ERROR_1013 | primary document date is empty | | REST_ERROR_1014 | Supply sum cannot be empty | | REST_ERROR_1015 | Invalid KPP | | REST_ERROR_1016 | payment date is empty | | REST_ERROR_1017 | payment date is not found in calendar | | REST_ERROR_1018 | Supply already exists in file | | REST_ERROR_1019 | Date cannot be in the future: supply date | | REST_ERROR_1020 | Date cannot be in the future: additional document date | | REST_ERROR_1021 | File is empty | | REST_ERROR_2000 | Supply with this number/date already exists | | REST_ERROR_2001 | payment date must be later than contract date | | REST_ERROR_2002 | payment date must be later than the primary document date | | REST_ERROR_2003 | primary document date cannot be earlier than contract date | | REST_ERROR_2004 | additional document date cannot be earlier than contract date | | REST_ERROR_2005 | Supply amount cannot be less than payment amount | | REST_ERROR_3000 | Posting amount cannot be more than remaining amount | | REST_ERROR_3001 | Debt sum cannot be less than posting amount | | REST_ERROR_3002 | Supply already repaid | | REST_ERROR_4000 | Out payment order already exists for incoming payment | | REST_ERROR_4001 | Remaining amount must be equal zero | ' enum: - REST_ERROR_5001 - REST_ERROR_1000 - REST_ERROR_1001 - REST_ERROR_1002 - REST_ERROR_1003 - REST_ERROR_1004 - REST_ERROR_1005 - REST_ERROR_1006 - REST_ERROR_1007 - REST_ERROR_1008 - REST_ERROR_1009 - REST_ERROR_1010 - REST_ERROR_1011 - REST_ERROR_1012 - REST_ERROR_1013 - REST_ERROR_1014 - REST_ERROR_1015 - REST_ERROR_1016 - REST_ERROR_1017 - REST_ERROR_1018 - REST_ERROR_1019 - REST_ERROR_1020 - REST_ERROR_1021 - REST_ERROR_2000 - REST_ERROR_2001 - REST_ERROR_2002 - REST_ERROR_2003 - REST_ERROR_2004 - REST_ERROR_2005 example: REST_ERROR_5001 type: string ConditionList: example: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contractNumber: ДП-1 contractDate: '2025-07-10' client: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 buyer: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' fullName: Акционерное общество Ромашка shortName: АО Ромашка inn: '1234567890' kpp: '123456789' ogrn: '123456789012345' state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 tariffs: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: LITE paymentPeriod: 0 startDate: '2025-01-10' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 wasApproved: true state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: SENT_TO_SIGN cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Condition' type: array ErrorMessage: properties: code: $ref: '#/components/schemas/RestErrorCodes' description: description: Сообщение example: General service error type: string traceId: description: traceId example: 29bda8ca-4d33-11ec-81d3-0242ac130000 type: string required: - code - description type: object TariffStatus: description: Статус тарифа условий обслуживания enum: - CREATED - APPROVED example: APPROVED type: string CqrsRequest: description: Запрос с версией CQRS example: cqrsVersion: -1628796591 properties: cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion type: object BuyerStatus: description: Статус покупателя enum: - SENT_TO_CHECK - APPROVED - REJECTED example: APPROVED type: string Client: description: Клиент example: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED cqrsVersion: -1628796591 requisites: fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка fullNameEn: Joint-stock company Romashka shortNameEn: JSC Romashka inn: '1234567890' ogrn: '123456789012345' okved: '11.11' cnum: AAAAAA opf: OOO address: address state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 properties: id: description: Идентификатор клиента example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string contacts: description: Контакты example: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Contact' type: array requisites: $ref: '#/components/schemas/OrganizationRequisites' state: $ref: '#/components/schemas/ClientState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - contacts - cqrsVersion - createdAt - id - requisites - state type: object BuyerState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/BuyerStatus' type: object description: Состояние покупателя example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object ContactStatus: description: Статус контакта enum: - CREATED example: CREATED type: string Tariff: description: Контакты условий обслуживания properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string tariffType: $ref: '#/components/schemas/TariffType' paymentPeriod: description: Период оплаты example: 60 type: integer startDate: description: Дата начала действия example: '2025-01-01' format: date type: string state: $ref: '#/components/schemas/TariffState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion - id - paymentPeriod - startDate - state - tariffType type: object ErrorResponse: example: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 items: $ref: '#/components/schemas/ErrorMessage' type: array ConditionRequest: description: Запрос на обновление или создание условий обслуживания example: contractDate: '2025-07-10' clientId: 2c44306f-fc96-4780-9b37-6447273b190e newTariff: tariffType: LITE cqrsVersion: -1628796591 id: 2c44306f-fc96-4780-9b37-6447273b190e paymentPeriod: 60 cqrsVersion: -1628796591 contractNumber: ДП-1 comment: Комментарий id: 2c44306f-fc96-4780-9b37-6447273b190e buyerId: 2c44306f-fc96-4780-9b37-6447273b190e contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 properties: id: description: Идентификатор условий example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string contractNumber: description: Номер контракта example: ДП-1 type: string contractDate: description: Дата контракта example: '2025-07-10' format: date type: string clientId: description: Идентификатора клиента example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string buyerId: description: Идентификатор покупателя example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string comment: description: Комментарий example: Комментарий type: string contacts: description: Контакты example: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/ConditionContactRequest' type: array newTariff: $ref: '#/components/schemas/TariffRequest' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - buyerId - clientId - contacts - newTariff type: object Error: properties: code: $ref: '#/components/schemas/ErrorCodes' description: description: Сообщение example: General service error type: string required: - code - description type: object TariffState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/TariffStatus' type: object description: Состояние тарифа условий обслуживания example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object Contact: description: Контакт properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string email: description: Email example: foobar@mail.ru format: email type: string state: $ref: '#/components/schemas/ContactState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion - createdAt - email - id - state type: object ConditionContactRequest: description: Контакты условий обслуживания properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string fullName: description: Имя example: Иванов Иван Иванович type: string email: description: email example: test@mail.ru type: string phoneNumber: description: Номер телефона example: +9 999 999 99 99 type: string additionalNumber: description: Добавочный номер example: '999' type: string workPosition: description: Должность example: Бухгалтер type: string comment: description: Комментарий example: Комментарий type: string cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - email type: object DigestResponse: description: Дайджест для подписи example: digest: 0JLQvtGCINGN0YLQviDQvdGD0LbQvdC+INC/0L7QtNC/0LjRgdCw0YLRjA== properties: digest: description: Контент для подписи в формате base64 example: 0JLQvtGCINGN0YLQviDQvdGD0LbQvdC+INC/0L7QtNC/0LjRgdCw0YLRjA== type: string type: object ConditionContactState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ConditionContactStatus' type: object description: Состояние контакта условий обслуживания example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED type: object Condition: description: Условия обслуживания example: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contractNumber: ДП-1 contractDate: '2025-07-10' client: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 buyer: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' fullName: Акционерное общество Ромашка shortName: АО Ромашка inn: '1234567890' kpp: '123456789' ogrn: '123456789012345' state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED cqrsVersion: -1628796591 tariffs: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 wasApproved: true state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: SENT_TO_SIGN cqrsVersion: -1628796591 properties: id: description: Идентификатор условий example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string contractNumber: description: Номер контракта example: ДП-1 type: string contractDate: description: Дата контракта example: '2025-07-10' format: date type: string client: $ref: '#/components/schemas/Client' buyer: $ref: '#/components/schemas/Buyer' contacts: description: Контакты example: - id: 2c44306f-fc96-4780-9b37-6447273b190e fullName: Иванов Иван Иванович email: test@mail.ru phoneNumber: +9 999 999 99 99 additionalNumber: '999' workPosition: Бухгалтер comment: Комментарий state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/ConditionContact' type: array tariffs: description: Тарифы example: - id: 2c44306f-fc96-4780-9b37-6447273b190e tariffType: PRO paymentPeriod: 60 startDate: '2025-01-01' state: statusDate: '2025-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Tariff' type: array wasApproved: description: Признак, что ранее был подписан example: true type: boolean cdcDocumentId: description: Идентификатор документа в сервисе подписи example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string comment: description: Комментарий example: Комментарий type: string state: $ref: '#/components/schemas/ConditionState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - buyer - client - contacts - cqrsVersion - createdAt - id - state - tariffs - wasApproved type: object ConditionState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ConditionStatus' type: object description: Состояние условий обслуживания example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object Buyer: allOf: - $ref: '#/components/schemas/BuyerRequisites' - properties: id: description: Идентификатор покупателя example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string clients: description: Клиенты связанные с покупателем example: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Client' type: array state: $ref: '#/components/schemas/BuyerState' cqrsVersion: $ref: '#/components/schemas/CqrsVersion' required: - cqrsVersion - id - state type: object description: Покупатель example: ogrn: '123456789012345' createdAt: '2025-07-10T06:53:37.433211' clients: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 cqrsVersion: -1628796591 inn: '1234567890' fullName: Акционерное общество Ромашка kpp: '123456789' id: 2c44306f-fc96-4780-9b37-6447273b190e state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED shortName: АО Ромашка TariffRequest: description: Контакты условий обслуживания example: tariffType: LITE cqrsVersion: -1628796591 id: 2c44306f-fc96-4780-9b37-6447273b190e paymentPeriod: 60 properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string tariffType: $ref: '#/components/schemas/TariffType' paymentPeriod: description: Период оплаты example: 60 type: integer cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - tariffType type: object OrganizationRequisites: description: Реквизиты организации example: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' properties: fullNameRus: description: Полное наименование example: Акционерное общество Ромашка type: string shortNameRus: description: Краткое наименование example: АО Ромашка type: string fullNameEn: description: Полное наименование на английском языке example: Акционерное общество Ромашка type: string shortNameEn: description: Краткое наименование на английском языке example: АО Ромашка type: string inn: description: ИНН example: '1234567890' maxLength: 12 minLength: 10 type: string ogrn: description: ОГРН example: '123456789012345' maxLength: 15 minLength: 13 type: string kpp: description: КПП example: '123456789' maxLength: 9 minLength: 9 type: string okved: description: ОКВЭД example: '11.11' type: string cnum: description: Клиентский номер example: AAAAAA maxLength: 6 minLength: 6 type: string opf: description: Организационно правовая форма example: OOO type: string address: description: Адрес example: address type: string required: - address - cnum - fullNameEn - fullNameRus - inn - ogrn - okved - opf - shortNameEn - shortNameRus type: object ClientState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ClientStatus' description: Состояние клиента example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object ClientStatus: description: Статус клиента enum: - SENT_TO_CHECK - APPROVED - REJECTED type: string ConditionContactStatus: description: Статус контакта условий обслуживания enum: - CREATED example: CREATED type: string ConditionContact: description: Контакты условий обслуживания properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string fullName: description: Имя example: Иванов Иван Иванович type: string email: description: email example: test@mail.ru type: string phoneNumber: description: Номер телефона example: +9 999 999 99 99 type: string additionalNumber: description: Добавочный номер example: '999' type: string workPosition: description: Должность example: Бухгалтер type: string comment: description: Комментарий example: Комментарий type: string state: $ref: '#/components/schemas/ConditionContactState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion - email - id - state type: object ConditionReportResponse: description: Документ условий обслуживания для предпросмотра example: content: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg== properties: content: description: Содержимое документа в формате base64 example: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg== type: string type: object ContactState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ContactStatus' description: Состояние контакта example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED type: object ErrorCodes: description: '| code | description | |------------|--------------------------------------------------------------| | ERROR_2000 | General service error | | ERROR_2001 | Buyer not found | | ERROR_2002 | Condition not found | | ERROR_2003 | Duplicate supply | | ERROR_2004 | Payment date must be after then current date | | ERROR_2005 | Main document date must be after or equal then contract date | | ERROR_2006 | Buyer not valid | | ERROR_2007 | Additional document date must be after or equal then contract date | ' enum: - ERROR_2000 - ERROR_2001 - ERROR_2002 - ERROR_2003 - ERROR_2004 - ERROR_2005 - ERROR_2006 - ERROR_2007 example: ERROR_2000 type: string ConditionStatus: description: Статус условий обслуживания enum: - DRAFT - SENT_TO_SIGN - PARTLY_SIGN - APPROVED example: APPROVED type: string BuyerRequisites: description: Реквизиты покупателя example: fullName: АО Ромашка inn: '1234567890' ogrn: '123456789012345' kpp: '123456789' properties: fullName: description: Полное наименование example: Акционерное общество Ромашка type: string shortName: description: Краткое наименование example: АО Ромашка type: string inn: description: ИНН example: '1234567890' maxLength: 12 minLength: 10 type: string ogrn: description: ОГРН example: '123456789012345' maxLength: 15 minLength: 13 type: string kpp: description: КПП example: '123456789' maxLength: 9 minLength: 9 type: string required: - fullName - inn - ogrn type: object CqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer State: description: Состояние объекта properties: statusDate: description: yyyy-MM-dd'T'HH:mm:ss.SSSSSS format: date-time pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string errors: description: Ошибки items: $ref: '#/components/schemas/Error' type: array required: - statusDate type: object TariffType: description: Тип тарифа enum: - LITE - STANDARD - PRO example: LITE type: string parameters: AuthorizationHeader: name: Authorization in: header description: Токен доступа required: true schema: type: string format: byte example: Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc= IdTokenHeader: name: Id-Token in: header description: Идентификационный токен пользователя required: true schema: type: string format: byte example: SUQgVE9LRU4gRk9SIFRFU1RJTkc= responses: InternalError: description: Внутренняя ошибка Unauthorized: description: Аутентификация не пройдена x-refined-from: - raiffeisen-ru-payment-control-openapi.yml - raiffeisen-ru-payment-control-openapi.yml