openapi: 3.2.0
info:
  title: Raiffeisen Ru Deal Conditions API
  version: 1.0.0
  description: 'Operations tagged DealConditions across 2 of this provider''s published API definitions: raiffeisen-ru-factoring-openapi.yml, raiffeisen-ru-factoring-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.raiffeisen.ru/factoring
tags:
- description: Основные условия обслуживания поставщик-дебитор
  name: DealConditions
paths:
  /v1/deal-conditions:
    get:
      description: Метод получения основных условий обслуживания поставщик-дебитор по параметрам
      operationId: getDealConditions
      parameters:
      - description: Идентификатор договора Факторинга
        in: query
        name: agreementId
        required: false
        schema:
          example: ba705955-3e0f-4956-84e0-e12616e84e2b
          format: uuid
          type: string
      - $ref: '#/components/parameters/IdTokenHeader'
      - $ref: '#/components/parameters/AuthorizationHeader'
      responses:
        '200':
          content:
            application/json:
              examples:
                for-one-agreement:
                  description: Основные условия обслуживания для одного договора. Например, был указан agreementId
                  summary: Основные условия обслуживания для одного договора
                  value:
                    dealConditions:
                    - id: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
                      agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
                      debtorId: 8867503f-10a5-4591-b739-78d75f3607c1
                      state:
                        status: APPROVED
                        statusDate: '2025-10-16T12:00:01.321458'
                        errors: []
                        cqrsVersion: 1742767789
                    - id: b2a81463-24ea-4917-aaae-3c72170ec117
                      agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
                      debtorId: fcad2408-4ebb-4cdc-a93d-577ec4528f54
                      state:
                        status: IN_PROCESSING
                        statusDate: '2025-10-04T15:21:54.582162'
                        errors: []
                        cqrsVersion: 3816547290
                for-multiple-agreements:
                  description: Основные условия обслуживания для нескольких договоров. Такой результат возможен без указания agreementId
                  summary: Основные условия обслуживания для нескольких договоров
                  value:
                    dealConditions:
                    - id: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
                      agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
                      debtorId: 8867503f-10a5-4591-b739-78d75f3607c1
                      state:
                        status: APPROVED
                        statusDate: '2025-10-16T12:00:01.321458'
                        errors: []
                        cqrsVersion: 1742767789
                    - id: b2a81463-24ea-4917-aaae-3c72170ec117
                      agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
                      debtorId: fcad2408-4ebb-4cdc-a93d-577ec4528f54
                      state:
                        status: IN_PROCESSING
                        statusDate: '2025-10-04T15:21:54.651823'
                        errors: []
                        cqrsVersion: 3816547290
                    - id: 3c6251f9-fe4d-4f2b-b9aa-e284b1c95ccd
                      agreementId: bbf1240d-25fc-4948-bcba-03cfdf614a63
                      debtorId: 17becb1e-1fa3-4d9d-bd59-87d657698fab
                      state:
                        status: APPROVED
                        statusDate: '2025-11-05T10:13:40.612333'
                        errors: []
                        cqrsVersion: 1256544810
              schema:
                $ref: '#/components/schemas/DealConditionsListResponse'
          description: OK
        '400':
          content:
            application/json:
              examples:
                simple:
                  summary: Ошибка
                  value:
                  - code: REST_ERROR_5001
                    message: General service error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: BAD_REQUEST
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      summary: Получение основных условий обслуживания поставщик-дебитор
      tags:
      - DealConditions
    servers:
    - url: https://api.raiffeisen.ru/factoring
components:
  schemas:
    RestErrorCodes:
      description: '| code            | description                                          |

        |-----------------|------------------------------------------------------|

        | REST_ERROR_5001 | General service error                                |

        | REST_ERROR_5004 | Agreement does not exist                             |

        | REST_ERROR_5017 | DealConditions does not exist                        |

        | REST_ERROR_5024 | Action is available at working hour                  |

        | REST_ERROR_5025 | Supplies are not found                               |

        | REST_ERROR_5026 | Approved contract does not exist                     |

        | REST_ERROR_5027 | Supplies must be selected on only one deal condition |

        | REST_ERROR_5028 | Approved deal conditions do not exist                |

        | REST_ERROR_5029 | Approved agreement does not exist                    |

        | REST_ERROR_5031 | Account for financing cannot be empty                |

        | REST_ERROR_5032 | Data validation failed                               |

        | REST_ERROR_5033 | File is infected                                     |

        | REST_ERROR_5034 | Invalid type of file                                 |

        | REST_ERROR_5035 | File is empty                                        |

        | REST_ERROR_5036 | Failed to read file                                  |

        | REST_ERROR_5037 | Supplier are not found                               |

        | SELECTED_ORGANIZATION_REQUIRED | selectedCnum is required when several organizations are available |

        | SELECTED_ORGANIZATION_NOT_ALLOWED | selectedCnum is not included in allowed organizations |

        '
      enum:
      - REST_ERROR_5001
      - REST_ERROR_5004
      - REST_ERROR_5017
      - REST_ERROR_5024
      - REST_ERROR_5025
      - REST_ERROR_5026
      - REST_ERROR_5027
      - REST_ERROR_5028
      - REST_ERROR_5029
      - REST_ERROR_5031
      - REST_ERROR_5032
      - REST_ERROR_5033
      - REST_ERROR_5034
      - REST_ERROR_5035
      - REST_ERROR_5036
      - SELECTED_ORGANIZATION_REQUIRED
      - SELECTED_ORGANIZATION_NOT_ALLOWED
      example: REST_ERROR_5001
      type: string
    ErrorMessage:
      properties:
        code:
          $ref: '#/components/schemas/RestErrorCodes'
        message:
          description: Сообщение
          example: General service error
          type: string
      required:
      - code
      - message
      type: object
    DealConditionsState:
      allOf:
      - $ref: '#/components/schemas/State'
      - properties:
          status:
            $ref: '#/components/schemas/DealConditionsStatus'
        required:
        - status
        type: object
      description: Состояние основных условий обслуживания поставщик-дебитор
      example:
        status: APPROVED
        statusDate: '2025-11-05T06:13:15.115212'
        errors: []
        cqrsVersion: 3456120025
      type: object
    DealConditionsListResponse:
      allOf:
      - properties:
          dealConditions:
            description: Основные условия обслуживания поставщик-дебитор
            items:
              $ref: '#/components/schemas/DealConditions'
            type: array
        type: object
      example:
        dealConditions:
        - id: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
          agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
          debtorId: 8867503f-10a5-4591-b739-78d75f3607c1
          state:
            status: APPROVED
            statusDate: '2025-10-16T12:00:01.321458'
            errors: []
            cqrsVersion: 1742767789
        - id: b2a81463-24ea-4917-aaae-3c72170ec117
          agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
          debtorId: fcad2408-4ebb-4cdc-a93d-577ec4528f54
          state:
            status: IN_PROCESSING
            statusDate: '2025-10-04T15:21:54.582162'
            errors: []
            cqrsVersion: 3816547290
      type: object
    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: Список ошибок в объекте. Может быть пустым списком или null
          items:
            $ref: '#/components/schemas/ErrorMessage'
          type: array
        cqrsVersion:
          description: hashCode от statusDate, status и errors
          example: -1628796591
          type: integer
      required:
      - cqrsVersion
      - statusDate
      type: object
    DealConditionsStatus:
      description: Статус основных условий обслуживания поставщик-дебитор
      enum:
      - IN_PROCESSING
      - APPROVED
      example: APPROVED
      type: string
    DealConditions:
      description: Основные условия обслуживания поставщик-дебитор
      example:
        id: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
        agreementId: ba705955-3e0f-4956-84e0-e12616e84e2b
        debtorId: 8867503f-10a5-4591-b739-78d75f3607c1
        state:
          status: APPROVED
          statusDate: '2025-11-05T06:13:15.115212'
          errors: []
          cqrsVersion: 3456120025
      properties:
        id:
          description: Идентификатор основных условий обслуживания поставщик-дебитор
          example: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
          format: uuid
          type: string
        agreementId:
          description: Идентификатор договора Факторинга
          example: ba705955-3e0f-4956-84e0-e12616e84e2b
          format: uuid
          type: string
        debtorId:
          description: Идентификатор дебитора
          example: 8867503f-10a5-4591-b739-78d75f3607c1
          format: uuid
          type: string
        state:
          allOf:
          - $ref: '#/components/schemas/DealConditionsState'
          description: Состояние основных условий обслуживания поставщик-дебитор
          type: object
      required:
      - agreementId
      - debtorId
      - id
      - state
      type: object
    ErrorResponse:
      example:
      - code: REST_ERROR_5001
        message: General service error
      items:
        $ref: '#/components/schemas/ErrorMessage'
      type: array
  responses:
    Unauthorized:
      description: Аутентификация не пройдена
    InternalError:
      description: Внутренняя ошибка
  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=
x-refined-from:
- raiffeisen-ru-factoring-openapi.yml
- raiffeisen-ru-factoring-openapi.yml