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 Consultar Planillas de Transacciones Masivas de Descuentos, cargadas desde un Sistema Externo o Directamente desde 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: "TransaccionesMasivas_PlanillasPendientes"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/PgDQhQPG"
produces:
  - application/json
paths:
  /TransaccionesMasivas_PlanillasPendientes:
    post:
      tags:
        - TransaccionesMasivas_PlanillasPendientes
      operationId: "TransaccionesMasivas_PlanillasPendientes"
      summary: "Web Service para para Consultar Planillas de Transacciones Masivas Pendientes (Para Obtener Descuentos generados desde un Sistema Externo, o Directamente desde el Sistema SIFCO)"
      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: "TransaccionesMasivas_PlanillasPendientesInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasPendientesInput"

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

        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 método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TransaccionesMasivas_PlanillasPendientesInput:
    properties:
      Desde:
        type: "string"
        format: "date"
      Hasta:
        type: "string"
        format: "date"
  
  TransaccionesMasivas_PlanillasPendientesOutput:
    properties:
      Planillas:
        description: Transacciones Masivas_Planilla Salida
        $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida"
  
  TransaccionesMasivas_PlanillaSalida:
    properties:
      Planillas:
        type: array
        items:
          description: Planilla
          $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas"


  TransaccionesMasivas_PlanillaSalida.Planillas:
    properties:
      ID:
        description: ID de la Planilla
        type: "string"

      Descripcion:
        description: Descripción
        type: "string"

      Fecha:
        description: Fecha de la planilla
        type: "string"
        format: "date"

      FrecuenciaCodigo:
        description: Código de la Frecuencia
        type: "integer"
        format: "int32"

      FrecuenciaNombre:
        description: Descripción de Frecuencia
        type: "string"

      Detalles:
        type: array
        items:
          description: Detalle
          $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas.Detalles"

    x-gx-level: "TransaccionesMasivas_PlanillaSalida"

  TransaccionesMasivas_PlanillaSalida.Planillas.Detalles:
    properties:
      ID:
        description: ID del Cargo
        type: "string"

      ClienteCodigoSifco:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClienteReferencia:
        description: Referencia del Cliente
        type: "string"

      TransaccionNumero:
        description: Transacción Numero
        type: "string"

      TransaccionReferencia:
        description: Transacción Referencia
        type: "string"

      Valor:
        description: Valor a Descontar o Descontado
        type: "number"
        format: "double"


    x-gx-level: "TransaccionesMasivas_PlanillaSalida.Planillas"

  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Código 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 Planillas de Transacciones Masivas, 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.