Page Comparison

DESCRIPCIÓN.

Este Web Service, permite consultar los campos necesarios para registrar una Transacción de Caja en la Aplicación SIFCO WEB, para dicha consulta es imprescindible tener el numero de transacción correspondiente (Estos deben consultarse en la Aplicación SIFCO WEB), adicionalmente se debe respetar el Flujograma Indicado en Web Services de Caja, dado a que ello garantizara que las transacciones se puedan ejecutar sin errores y perfectamente aceptadas y procesadas por la Aplicación SIFCO WEB.

Swagger open api macro

swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  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: "WSInformacionTransaccion"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/DgCq"
produces:
  - application/json
paths:
  /WSInformacionTransaccion:
    post:
      tags:
        - WSInformacionTransaccion
      operationId: "WSInformacionTransaccion"
      summary: "Consulta de Campos para Registrar Movimiento en CAJA"
      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: "WSInformacionTransaccionCajaInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/WSInformacionTransaccionInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/WSInformacionTransaccionOutput"
        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:

  WSInformacionTransaccionInput:
    properties:
      Empresa:
        description: Código Empresa
        type: "integer"
        format: "int32"
      TransaccionCodigo:
        description: Numero de Transacción a Consultar
        type: "integer"
        format: "int32"
  
  WSInformacionTransaccionOutput:
    properties:
      InformacionTransaccion_Caja_SDT:
        description: Informacion Transaccion_Caja_SDT
        $ref: "#/definitions/InformacionTransaccion_Caja_SDT"
  
  InformacionTransaccion_Caja_SDT:
    properties:
      ApEmpCodigo:
        description: Código Empresa
        type: "integer"
        format: "int32"

      ApEmpNombre:
        description: Nombre Empresa
        type: "string"

      ApTrxCod:
        description: Código de Transacción
        type: "integer"
        format: "int32"

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

      ApModCod:
        description: Código Modulo
        type: "string"

      ApModNom:
        description: Nombre Modulo
        type: "string"

      ApTrxUso:
        description: Grupo de Uso
        type: "integer"
        format: "int32"

      ApTrxNaturaleza:
        description: Naturaleza
        type: "integer"
        format: "int32"

      ApTrxSigla:
        description: Siglas para Estado de Cuenta
        type: "string"

      ApTrxEstadisticas:
        description: Acumula en Estadísticas
        type: "string"

      ApTrxTipCer:
        description: Tipo de Certificación en Caja
        type: "integer"
        format: "int32"

      ApTrxTC1Rut:
        description: Rutina Certificación Estándar
        type: "integer"
        format: "int32"

      ApTrxTC1Des:
        description: Descripción Rutina
        type: "string"

      ApTrxTC2Rut:
        description: Rutina Impresión Documento
        type: "integer"
        format: "int32"

      ApTrxTC2Des:
        description: Descripción de rutina
        type: "string"

      ApTrxAutoSup:
        description: Requiere Autorización del Supervisor
        type: "string"

      ApTrxUltPar:
        description: Ultimo Correlativo de Partidas
        type: "integer"
        format: "int64"

      ApTrxConta:
        description: Se contabiliza la transacción
        type: "string"

      ApTrxActiva:
        description: Transacción Activa/Desactiva
        type: "string"

      ApTrxEsAjuste:
        description: Transaccion Tipo Ajuste
        type: "string"

      ApTrxRptCertifica:
        description: Rpt Imprime Certificación
        type: "string"

      ApTrxEnlace:
        description: Enlace con otros Módulos
        type: "integer"
        format: "int32"

      Transaccion:
        $ref: "#/definitions/InformacionTransaccion_Caja_SDT.Transaccion"

      Campos:
        type: array
        items:
          description: Campo
          $ref: "#/definitions/InformacionTransaccion_Caja_SDT.Campos"

      Rutinas:
        type: array
        items:
          description: Rutina
          $ref: "#/definitions/InformacionTransaccion_Caja_SDT.Rutinas"


  InformacionTransaccion_Caja_SDT.Transaccion:
    properties:
      FechaValor:
        description: Fecha Valor
        type: "string"
        format: "date"

      Total:
        description: Total
        type: "number"
        format: "double"

      Cuenta:
        description: Campos para Número de Cuenta
        type: "string"

      LibNumero:
        description: Número de Libreta
        type: "integer"
        format: "int64"

      ApEmpCodigo:
        description: Código Empresa
        type: "integer"
        format: "int32"

      ApSucCodigo:
        description: Código de Sucursal
        type: "integer"
        format: "int32"

      ApUsuCod:
        description: Codigo del Usuario
        type: "string"

      ApMonCod:
        description: Codigo Moneda
        type: "integer"
        format: "int32"

      NumeroDocumento:
        description: Número Documento
        type: "integer"
        format: "int64"

      ApCajRecCodigo:
        description: Codigo Caja Receptora
        type: "integer"
        format: "int32"

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

      Cuotas:
        description: Cuotas
        type: "integer"
        format: "int32"

      CrUltimaTrx:
        description: Número del Movimiento Créditos
        type: "integer"
        format: "int64"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Campos:
    properties:
      ApCamCod:
        description: Código del Campo
        type: "integer"
        format: "int32"

      ApCtxOrden:
        description: Orden de Campos en Transacción
        type: "integer"
        format: "int32"

      ApCamClase:
        description: Tipo de Campo
        type: "integer"
        format: "int32"

      ApCamEti:
        description: Etiqueta Campo
        type: "string"

      ApCamTipo:
        description: Tipo de Campo
        type: "string"

      ApPResCod:
        description: Código del Periodo
        type: "integer"
        format: "int32"

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

      ApCamModifica:
        description: ApCamModifica
        type: "string"

      ValorTXT:
        description: Valor TXT
        type: "string"

      ValorNumerico:
        description: Valor Numérico
        type: "number"
        format: "double"

      ValorCuenta:
        description: Campos para Número de Cuenta
        type: "string"

      ValorFecha:
        description: Valor fecha
        type: "string"
        format: "date"

      ValorDocumento:
        description: Campos para Nos. de Documentos
        type: "integer"
        format: "int64"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Rutinas:
    properties:
      ApRutxTrx:
        description: Código Rutina
        type: "integer"
        format: "int32"

      ApRutxDes:
        description: Descripción rutina
        type: "string"

      ApRutSec:
        description: Secuencia Rutina
        type: "integer"
        format: "int32"

      ApRutxTip:
        description: Tipo de Rutina
        type: "string"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  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"

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service	Web Service a Constantes del Sistema Relacionados
InformacionTransaccion_Caja_SDT >Transaccion
ApUsuCod	WSApUsuariosSistemaLista
	Código	Descripción	Modulo
TransaccionCodigo	1001	BLOQUEO DE CUENTA	CAPTACIONES	1002	DESBLOQUEO DE CUENTA	CAPTACIONES	1003	LIBERACIÓN RESERVAS	CAPTACIONES	1004	AJUSTE DÉBITO LIBRETA	CAPTACIONES	1005	AJUSTE CRÉDITO LIBRETA	CAPTACIONES	1006	CAMBIO DE TASA SPREAD	CAPTACIONES	1007	AJUSTE DÉBITO CONTABLE	CAPTACIONES	1008	AJUSTE CRÉDITO CONTABLE	CAPTACIONES	1009	PROVISIÓN DE INTERESES	CAPTACIONES	1010	PAGO DE INTERESES-CAPITALIZACIÓN	CAPTACIONES	1011	IMPTO. PRODUCTOS FINANCIEROS	CAPTACIONES	1012	CANCELACIÓN CUENTAS	CAPTACIONES	1013	INTERESES GENERADOS PLAZO FIJO	CAPTACIONES	1014	CANCELACIÓN PLAZO FIJO	CAPTACIONES	1015	RENOVACIÓN PLAZO FIJO	CAPTACIONES	1016	DÉBITO CHEQUE RECHAZADO	CAPTACIONES	1017	PENALIZACION CANCELACIÓN	CAPTACIONES	1018	INTERESES POR SOBREGIRO	CAPTACIONES	1019	DÉBITO ABONO A PRÉSTAMO	CAPTACIONES	1021	CRÉDITO CANC PLAZO FIJO	CAPTACIONES	1022	INACTIVA CUENTAS DE AHORRO	CAPTACIONES	1023	ACTIVA CUENTA INACTIVA	CAPTACIONES	1024	COBRO IMPUESTO PLAZO FIJO	CAPTACIONES	1025	MANEJO DE CUENTA	CAPTACIONES	1026	AJUSTE DÉBITO PRODUCTOS SIN LIBRETA	CAPTACIONES	1027	AJUSTE CRÉDITO PRODUCTOS SIN LIBRETA	CAPTACIONES	1030	PAGO DE INTERESES A OTRA CUENTA	CAPTACIONES	1031	IMPTO. PRODUCTOS FINANCIEROS	CAPTACIONES	1032	PROVISIÓN DE MANTENIMIENTO VALOR	CAPTACIONES	1033	PAGO DE MANTENIMIENTO DE VALOR	CAPTACIONES	1098	DEPOSITO AHORROS MIGRACIÓN	CAPTACIONES	1099	RETIRO AHORROS MIGRACIÓN	CAPTACIONES	3011	MULTA CHEQUES RECHAZADOS	CAPTACIONES	3023	CANCELACIÓN CUENTAS DE AHORRO	CAPTACIONES	3025	RETIRO DE CAJA POR DOCUMENTO	CAPTACIONES	5025	DEPOSITO AHORROS CON LIBRETA	CAPTACIONES	5026	DEPÓSITOS A CUENTAS DE CHEQUES	CAPTACIONES	5027	DEPOSITO AHORROS SIN LIBRETA	CAPTACIONES	5028	DEPOSITO CUENTAS APORTACIONES	CAPTACIONES	5029	APERTURA APORTACIONES	CAPTACIONES	5030	DEPOSITO POR DESCUENTO PLANILLA	CAPTACIONES	5031	APERTURA DEPOSITO PLAZO FIJO	CAPTACIONES	5034	DEPOSITO POR BACK OFFICE	CAPTACIONES	5125	RETIRO AHORROS SIN LIBRETA	CAPTACIONES	5127	RETIRO AHORROS CON LIBRETA	CAPTACIONES	5128	RETIRO APORTACIONES	CAPTACIONES	5130	RETIRO AHORROS POR DOCUMENTOS	CAPTACIONES	5132	ACREDITAR APORTACIONES DE CRÉDITOS AUTOM	CAPTACIONES	5134	RETIRO POR BACK OFFICE	CAPTACIONES	2001	DESEMBOLSOS	COLOCACIONES	2002	CAMBIO DE TASA	COLOCACIONES	2003	AJUSTE DÉBITO A SALDO PRESTAMO	COLOCACIONES	2004	AJUSTE CRÉDITO A SALDO PRESTAMO	COLOCACIONES	2005	CAMBIO DE ESTADO	COLOCACIONES	2006	PRORROGA	COLOCACIONES	2007	AMPLIACIÓN	COLOCACIONES	2008	ABONOS A CAPITAL	COLOCACIONES	2009	CANCELACIÓN DE CRÉDITO	COLOCACIONES	2010	PAGOS DE CRÉDITOS	COLOCACIONES	2011	CONDONACION INT MORA	COLOCACIONES	2012	CONDONACION INT POST VENCIMIENTO	COLOCACIONES	2015	PROVISIÓN	COLOCACIONES	2016	APROPIACIÓN	COLOCACIONES	2017	AJUSTE POR INTERESES RETROACTIVOS	COLOCACIONES	2018	CAMBIO DE CATEGORÍA	COLOCACIONES	2019	RESERVA CUENTAS INCOBRABLES	COLOCACIONES	2020	REVERSIÓN PAGO CUOTA PRÉSTAMO	COLOCACIONES	2021	REVERSIÓN ABONOS A CAPITAL PRÉSTAMO	COLOCACIONES	2022	REVERSIÓN DE CANCELACIÓN	COLOCACIONES	2023	APROPIACIÓN INTERESES ANTICIPADOS	COLOCACIONES	2024	ANULACIÓN DE CRÉDITOS DESEMBOLSADOS	COLOCACIONES	2025	PERDIDAS GENERADAS	COLOCACIONES	2026	CONDONACION DE INTERESES	COLOCACIONES	2027	PAGOS EN EXCESO	COLOCACIONES	2028	PAGO INTERESES ANTICIPADOS	COLOCACIONES	2031	SUSPENSIÓN DE CALCULO DE INTERESES	COLOCACIONES	2032	LEVANTAR SUSPENSIÓN DE INTERESES	COLOCACIONES	2033	PROVISIÓN M.V.	COLOCACIONES	2034	PROVISIÓN INTS DEVENGADOS	COLOCACIONES	2035	DEVOLUCIÓN INTS PROVISIÓN	COLOCACIONES	3020	DESEMBOLSOS DE CRÉDITOS POR CAJA	COLOCACIONES	3027	RECEPCIÓN DE INTERESES ANTICIPADOS	COLOCACIONES	2030	PAGOS GRUPALES	CAJA	3004	RECEPCIÓN DE EFECTIVO DE BÓVEDA	CAJA	3005	ENVIÓ DEPÓSITOS 2030	PAGOS GRUPALES	CAJA
	3004	RECEPCIÓN DE EFECTIVO DE BOVEDA	CAJA
	3005	ENVIO DEPOSITOS BANCARIOS	CAJA
	3036	EXCEDENTE DE CAJA	CAJA
	3037	FALTANTE DE CAJA	CAJA
	8888	VENTA DE XXX	CAJA

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.

METODO POST

Este método para este Web Service en especifico permite consultar los campos necesarios para registrar una Transacción de Caja en la Aplicación SIFCO WEB.

El siguiente ejemplo permite consultar los campos necesarios para registrar una Transacción de Caja en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/WSInformacionTransaccion

HEADERS

Code Block

language	json

content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

Code Block

language	json

{
  "Empresa": 1,
  "TransaccionCodigo": 1006
}

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "InformacionTransaccion_Caja_SDT": {
      "ApEmpCodigo": 1,
      "ApEmpNombre": "COOP DE AHORRO Y CREDITO EL EJEMPLO",
      "ApTrxCod": 1006,
      "ApTrxDes": "CAMBIO DE TASA SPREAD",
      "ApModCod": "CA",
      "ApModNom": "CAPTACIONES",
      "ApTrxUso": 2,
      "ApTrxNaturaleza": 3,
      "ApTrxSigla": "CAMTASPR",
      "ApTrxEstadisticas": "N",
      "ApTrxTipCer": 1,
      "ApTrxTC1Rut": 0,
      "ApTrxTC1Des": "",
      "ApTrxTC2Rut": 0,
      "ApTrxTC2Des": "",
      "ApTrxAutoSup": "S",
      "ApTrxUltPar": 0,
      "ApTrxConta": "N",
      "ApTrxActiva": "A",
      "ApTrxEsAjuste": "N",
      "ApTrxRptCertifica": "",
      "ApTrxEnlace": 0
    }
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 (This service needs an Authorization Header)

(No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ).

Code Block

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "InformacionTransaccion_Caja_SDT": {}
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Info

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Mensajes), donde se describe el listado de mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.

Note

NO DEBE OLVIDAR

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

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

Code Block

language	json

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

Warning

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.

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

WSApUsuariosSistemaLista

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 10

New Version 11

Key

DESCRIPCIÓN.

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente