swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Registrar Solicitud de Cotización de un Crédito en la **Aplicación SIFCO WEB** ."
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "CrCotizacion"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/9ISo"
produces:
  - application/json
paths:
  /CrCotizacion:
    post:
      tags:
        - CrCotizacion
      operationId: "CrCotizacion"
      summary: "Registrar Solicitud de Cotización de un Crédito"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "CrCotizacionInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/CrCotizacionInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/CrCotizacionOutput"

        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el metodo tipo GET
      Insert: Permite el metodo tipo POST
      Update: Permite el metodo tipo PUT
      Delete: Permite el metodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  CrCotizacionInput:
    properties:
      SucursalElectronica_TipoCreditoID:
        type: "integer"
        format: "int32"
      SucursalElectronica_TipoCredito_SoCrPlazo:
        type: "integer"
        format: "int32"
      Monto:
        type: "number"
        format: "double"
      Referencia:
        type: "string"
  
  CrCotizacionOutput:
    properties:
      PlanPagos:
        description: Cuotas
        type: array
        items:
          $ref: "#/definitions/PlanPagos_EstadoCuenta_SDT.PlanPagos_Cuotas_PlanPagos_Cuota"
  
  PlanPagos_EstadoCuenta_SDT.PlanPagos_Cuotas_PlanPagos_Cuota:
    properties:
      Fecha:
        description: Fecha
        type: "string"
        format: "date"

      CapitalNumeroCuota:
        description: Numero de Cuota de Capital
        type: "integer"
        format: "int32"

      CapitalMonto:
        description: Monto del Capital
        type: "number"
        format: "double"

      CapitalAbonado:
        description: Capital Abonado
        type: "number"
        format: "double"

      CapitaAtrasado:
        description: Capita Atrasado
        type: "string"

      CapitalPagado:
        description: Capital Pagado
        type: "string"

      CapitalSaldo:
        description: Capital Saldo
        type: "number"
        format: "double"

      InteresNumeroCuota:
        description: PlanPNumCuot
        type: "integer"
        format: "int32"

      InteresMonto:
        description: Interes Monto
        type: "number"
        format: "double"

      InteresAbonado:
        description: Interes Abonado
        type: "number"
        format: "double"

      InteresAtrasado:
        description: Interes Atrasado
        type: "string"

      InteresPagado:
        description: Interes Pagado
        type: "string"

      InteresSaldo:
        description: Interes Saldo
        type: "number"
        format: "double"

      OtrosMonto:
        description: Otros Monto
        type: "number"
        format: "double"

      Otros:
        type: array
        items:
          description: OtrosCargos
          $ref: "#/definitions/PlanPagos_EstadoCuenta_SDT.PlanPagos_Cuotas.Otros"


  PlanPagos_EstadoCuenta_SDT.PlanPagos_Cuotas.Otros:
    properties:
      NumeroCuota:
        description: Numero de Cuota
        type: "integer"
        format: "int32"

      Monto:
        description: Monto
        type: "number"
        format: "double"

      Abonado:
        description: Abonado
        type: "number"
        format: "double"

      Atrasado:
        description: Atrasado
        type: "string"

      Pagado:
        description: Pagado
        type: "string"

      Saldo:
        description: Código de Saldo
        type: "integer"
        format: "int32"

      SaldoDescripcion:
        description: Descripcion
        type: "string"


    x-gx-level: "PlanPagos_EstadoCuenta_SDT.PlanPagos_Cuotas"
 
  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Codigo de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"

NO DEBE OLVIDAR

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Créditos, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

EN CASO DE ERROR HTTP 401 (Not Authenticated)

Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST.