openapi: 3.2.0
info:
  title: Raiffeisen Ru Sublimit API
  version: 1.0.0
  description: 'Operations tagged Sublimit 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: Sublimit
paths:
  /v1/agreement-sums/sublimits:
    get:
      description: Метод получения сублимитов по параметрам
      operationId: getSublimits
      parameters:
      - description: 'Идентификатор основных условий обслуживания поставщик-дебитор. Если указан, в ответе будет возвращён список, содержащий не более одного элемента

          '
        in: query
        name: dealConditionsId
        required: false
        schema:
          example: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
          format: uuid
          type: string
      - $ref: '#/components/parameters/IdTokenHeader'
      - $ref: '#/components/parameters/AuthorizationHeader'
      responses:
        '200':
          content:
            application/json:
              examples:
                single:
                  description: Один сублимит. Такой результат возможен при указании dealConditionsId
                  summary: Один сублимит
                  value:
                    sublimits:
                    - id: 04ab216e-5626-4111-86d8-f606048fc000
                      dealConditionsId: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
                      amount: 2000000.0
                      utilizedAmount: 987654.38
                      state:
                        status: APPROVED
                        statusDate: '2025-10-16T12:00:01.024001'
                        errors: []
                        cqrsVersion: 1742767789
                multiple:
                  description: 'Несколько сублимитов для разных основных условий обслуживания. Такой результат возможен без указания dealConditionsId

                    '
                  summary: Несколько сублимитов
                  value:
                    sublimits:
                    - id: 04ab216e-5626-4111-86d8-f606048fc000
                      dealConditionsId: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
                      amount: 2000000.0
                      utilizedAmount: 987654.38
                      state:
                        status: APPROVED
                        statusDate: '2025-10-16T12:00:01.024001'
                        errors: []
                        cqrsVersion: 1742767789
                    - id: b76ab99e-067c-4eea-ab51-2f759d6d0bbe
                      dealConditionsId: 58a4683f-f1f6-41e8-9615-b1c8ea39523d
                      amount: 1500000.0
                      utilizedAmount: 0.0
                      state:
                        status: IN_PROCESSING
                        statusDate: '2025-08-12T19:31:43.645387'
                        errors: []
                        cqrsVersion: 1742767789
              schema:
                $ref: '#/components/schemas/SublimitListResponse'
          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:
      - Sublimit
    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
    SublimitState:
      allOf:
      - $ref: '#/components/schemas/State'
      - properties:
          status:
            $ref: '#/components/schemas/SublimitStatus'
        required:
        - status
        type: object
      description: Состояние сублимита
      example:
        status: APPROVED
        statusDate: '2025-10-25T16:05:48.531124'
        errors: []
        cqrsVersion: 8914661325
      type: object
    SublimitStatus:
      description: Статус сублимита
      enum:
      - IN_PROCESSING
      - APPROVED
      example: APPROVED
      type: string
    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
    Sublimit:
      description: Сублимит - лимит на дебитора в рамках конкретного договора Факторинга
      example:
        id: 04ab216e-5626-4111-86d8-f606048fc000
        dealConditionsId: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
        amount: 2000000.0
        utilizedAmount: 987654.38
        state:
          status: APPROVED
          statusDate: '2025-10-25T16:05:48.531124'
          errors: []
          cqrsVersion: 8914661325
      properties:
        id:
          description: Идентификатор сублимита
          example: 04ab216e-5626-4111-86d8-f606048fc000
          format: uuid
          type: string
        dealConditionsId:
          description: Идентификатор основных условий обслуживания поставщик-дебитор
          example: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
          format: uuid
          type: string
        amount:
          description: Сумма сублимита
          example: 2000000.0
          type: number
        utilizedAmount:
          description: Утилизированная сумма сублимита
          example: 987654.38
          type: number
        state:
          allOf:
          - $ref: '#/components/schemas/SublimitState'
          description: Состояние сублимита
          type: object
      required:
      - amount
      - dealConditionsId
      - id
      - state
      - utilizedAmount
      type: object
    SublimitListResponse:
      allOf:
      - properties:
          sublimits:
            description: Сублимиты
            items:
              $ref: '#/components/schemas/Sublimit'
            type: array
        type: object
      example:
        sublimits:
        - id: 04ab216e-5626-4111-86d8-f606048fc000
          dealConditionsId: b5c1e36d-bde1-42bf-8d72-9d0aa4504f73
          amount: 2000000.0
          utilizedAmount: 987654.38
          state:
            status: APPROVED
            statusDate: '2025-10-16T12:00:01.024001'
            errors: []
            cqrsVersion: 1742767789
        - id: b76ab99e-067c-4eea-ab51-2f759d6d0bbe
          dealConditionsId: 58a4683f-f1f6-41e8-9615-b1c8ea39523d
          amount: 1500000.0
          utilizedAmount: 0.0
          state:
            status: IN_PROCESSING
            statusDate: '2025-08-12T19:31:43.645387'
            errors: []
            cqrsVersion: 1742767789
      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