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**, que es necesario consultar para obtener los campos necesarios para registrar un movimiento en CAJA 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: "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 metodométodo tipo GET
Insert: Permite el metodométodo tipo POST
Update: Permite el metodométodo tipo PUT
Delete: Permite el metodométodo tipo DELETE
FullControl: Permite el manejo de los Cuatro MetodosMétodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSInformacionTransaccionInput:
properties:
Empresa:
type: "integer"
format: "int32"
TransaccionCodigo:
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: DescripcionDescripción
type: "string"
ApModCod:
description: CodigoCó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ÃsticasEstadísticas
type: "string"
ApTrxTipCer:
description: Tipo de Certificación en Caja
type: "integer"
format: "int32"
ApTrxTC1Rut:
description: Rutina Certificación EstandarEstándar
type: "integer"
format: "int32"
ApTrxTC1Des:
description: DescripcionDescripción Rutina
type: "string"
ApTrxTC2Rut:
description: Rutina Impresión Documento
type: "integer"
format: "int32"
ApTrxTC2Des:
description: DescripcionDescripció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 transacciontransacción
type: "string"
ApTrxActiva:
description: Transacción Activa/Desactiva
type: "string"
ApTrxEsAjuste:
description: Transaccion Tipo Ajuste
type: "string"
ApTrxRptCertifica:
description: Rpt Imprime CertificacionCertificación
type: "string"
ApTrxEnlace:
description: Enlace con otros ModulosMó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: NumeroNú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 NumericoNumé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: CodigoCódigo Rutina
type: "integer"
format: "int32"
ApRutxDes:
description: DescripcionDescripció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: CodigoCódigo de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError" |