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: "WSIngresarClientes"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/9ISo"
produces:
  - application/json
paths:
  /WSIngresarClientes:
    post:
      tags:
        - WSIngresarClientes
      operationId: "WSIngresarClientes"
      summary: "WSIngresar Clientes"
      parameters:
        - name: "WSIngresarClientesInput"
           $refin: "#/definitions/GxJsonErrorbody"
security:   - OAuth2: []     ApiKeyAuth1required: false
[]  securityDefinitions:   OAuth2:     typeschema:
oauth2     flow:  password     tokenUrl$ref: https:"#//test.sifco.org/DemoCoopGT/oauth/access_tokendefinitions/WSIngresarClientesInput"


  scopes:       Execute: Permite el método tipo GETresponses:
          Insert200:
Permite el método tipo POST      description: Update: Permite el método tipo PUT"Successful operation"
          Deleteschema:
 Permite el método tipo DELETE       FullControl$ref: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:"#/definitions/WSIngresarClientesOutput"
        404:
          typedescription: apiKey"Not found"
security:
  - inOAuth2: header[]
    nameApiKeyAuth1: granttype[]

definitionssecurityDefinitions:
   WSIngresarClientesInputOAuth2:
    propertiestype: oauth2
     Modoflow: password
    tokenUrl:   type: "string"https://test.sifco.org/DemoCoopGT/oauth/access_token
       ConsultaFormaIdentificarscopes:
      Execute: Permite type: "integer"
 el método tipo GET
      formatInsert: "int32"Permite el método tipo POST
  ConsultaValorIdentificador:    Update: Permite el método tipo type:PUT
"string"       WSClienteDelete: Permite el método tipo DELETE
   description: WSInformacion Cliente FullControl: Permite el manejo de los Cuatro Métodos $ref: "#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    propertiesGET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
CodigoCliente:    in: header
    descriptionname: Códigogranttype
del
Clientedefinitions:

  WSIngresarClientesInput:
    typeproperties:
"integer"         formatModo:
"int64"        TipoDePersonatype: "string"
       descriptionConsultaFormaIdentificar:
Tipo de Persona         type: "stringinteger"
        TipoIdentificacionformat: "int32"
       description: Tipo de IdentificaciónConsultaValorIdentificador:
        type: "integerstring"
        formatWSCliente:
"int32"        DocumentoIdentificacionPaisdescription: WSInformacion Cliente
      description: País de Emisión Documento
        type $ref: "integer#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    formatproperties:
"int64"        DocumentoIdentificacionDepartamentoCodigoCliente:
        description: Código Regióndel Emisión IdentificaciónCliente
        type: "integer"
        format: "int64"

      DocumentoIdentificacionMunicipioTipoDePersona:
        description: DepartamentoTipo Emisiónde IdentificaciónPersona
        type: "integerstring"

       formatTipoIdentificacion:
"int64"        DocumentoIdentificacionZona:
        description: CódigoTipo Municipio Emisiónde Identificación
        type: "integer"
        format: "int64int32"

      NumeroIdentificacionDocumentoIdentificacionPais:
        description: NúmeroPais de IdentificaciónEmisión ClientesDocumento
        type: "stringinteger"
        PrimerNombreformat: "int64"

      descriptionDocumentoIdentificacionDepartamento:
Primer Nombre         typedescription: "string"Código Región Emisión Identifi
    SegundoNombre:    type: "integer"
   description:    Segundo Nombreformat: "int64"

      typeDocumentoIdentificacionMunicipio:
"string"        PrimeApellidodescription: Departamento Emisión Identific
     description   type: Primer Apellido"integer"
        typeformat: "stringint64"

      SegundoApellidoDocumentoIdentificacionZona:
        description: Segundo ApellidoCódigo Municipio Emisión Ident
        type: "string"integer"
        format: "int64"

      ApellidoCasadaNumeroIdentificacion:
        description: ApellidoNúmero de Identificación CasadaClien
        type: "string"

      SexoPrimerNombre:
        description: SexoPrimer ClienteNombre
        type: "string"

      FechaNacimientoSegundoNombre:
        description: FechaSegundo de NacimientoNombre
        type: "string"

       formatPrimeApellido:
"date"        EstadoCivildescription: Primer Apellido
      description: Estado Civiltype: "string"

      type: "integer"
        format: "int32"

 SegundoApellido:
    NombreJuridico:         description: Nombre de Empresa o SociedadSegundo Apellido
         type: "string"

      RepresentanteLegalApellidoCasada:
        description: NombreApellido delde RepresentanteCasada
Legal         type: "string"

      NumeroRegistroMercantilSexo:
        description: NúmeroSexo de RegistroCliente
Mercantil         type: "string"

      FechaConstitucionFechaNacimiento:
        description: Fecha de ConstituciónNacimiento
        type: "string"
        format: "date"

      GrupoEstadoCivil:
        description: CódigoEstado delCivil
Grupo de Afinidad         type: "integer"
        format: "int64int32"

      NumeroIdentificacionTributariaNombreJuridico:
        description: NúmeroNombre de Empresa Identificacióno TributariaSociedad
        type: "string"

      PromotorRepresentanteLegal:
        description: Nombre Códigodel Representante PromotorLegal
        type: "string"

      AfectoAImpuestosNumeroRegistroMercantil:
        description: AfectoNúmero de aRegistro ImpuestosMercantil
        type: "string"

      EstadoClienteFechaConstitucion:
        description: EstadoFecha delde ClienteConstitución
        type: "string"
        format: "date"

      CodigoReferenciaGrupo:
        description: ReferenciaCódigo del Grupo de Afinidad
        type: "stringinteger"
        ActividadEconomicaformat: "int64"

      descriptionNumeroIdentificacionTributaria:
Código de actividad económica     description: Número de Identificación type:Tributaria
"integer"         formattype: "int32string"

      DireccionEMailPrincipalPromotor:
        description: CorreoCódigo ElectrónicoPromotor
        type: "string"

      DireccionEMailSecundarioAfectoAImpuestos:
        description: CorreoAfecto Electrónicoa AlternativoImpuestos
        type: "string"

      ExcluirDeMensajesDeCorreoEstadoCliente:
        description: ExcluirEstado dedel CorreosCliente
Electrónicos         type: "integerstring"

       formatCodigoReferencia:
"int32"        ParametrosExtendidos_B1Integrationdescription: Referencia
       description: Parámetros Extendidos_B1 Integration type: "string"

      ActividadEconomica:
   $ref: "#/definitions/ParametrosExtendidos_B1Integration"    description: Código de actividad Prestamos:económica
        type: array"integer"
        itemsformat: "int32"

        descriptionDireccionEMailPrincipal:
Préstamo        description: Correo Electrónico
$ref: "#/definitions/WSInformacionCliente.Prestamos"        CuentasAhorrotype: "string"

      typeDireccionEMailSecundario:
array         itemsdescription: Correo Electrónico Alternativo
       description type: CuentaAhorro"string"

      ExcluirDeMensajesDeCorreo:
   $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"    description: Excluir de Correos CalificadoresAdicionales:Electronicos
        type: array"integer"
        itemsformat: "int32"

      ParametrosExtendidos_B1Integration:
        description: CalificadorAdicionalParametros Extendidos_B1 Integration
        $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionalesParametrosExtendidos_B1Integration"

      CuentasBancariasPrestamos:
        type: array
        items:
          description: CuentaBancariaPrestamo
          $ref: "#/definitions/WSInformacionCliente.CuentasBancariasPrestamos"

      TelefonosCuentasAhorro:
        type: array
        items:
          description: TeléfonoCuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.TelefonosCuentasAhorro"

      DireccionesCalificadoresAdicionales:
        type: array
        items:
          description: DirecciónCalificadorAdicional
          $ref: "#/definitions/WSInformacionCliente.DireccionesCalificadoresAdicionales"

     ParametrosExtendidos_B1Integration:
    properties CuentasBancarias:
      CentrosDeCosto:
        type: array
        items:
          description: CentroDeCostoCuentaBancaria
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoCuentasBancarias"

      ProyectosTelefonos:
        type: array
        items:
          description: ProyectoTelefono
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosTelefonos"

      TransaccionesDirecciones:
        type: array
        items:
          description: TransaccionesDireccion
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesDirecciones"

      SeriesRefPersonales:
        type: array
        items:
          description: SerieReferencia
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesRefPersonales"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoPrestamos:
    properties:
      SecuenciaNumeroPrestamo:
        description: Número Secuenciadel Préstamo
        type: "integerstring"

       formatNombrePrestamo:
"int32"        CodigoCCSAPdescription: Nombre del Préstamo
      description: Código CCSAPtype: "string"

      typeProducto:
"string"        NombreCCSAPdescription: Codigo Producto
        descriptiontype: Nombre"integer"
CCSAP         typeformat: "stringint32"

      CodigoCCSifcoSubProducto:
        description: Código CCSifcoSubProducto Colocacion
        type: "integer"
        format: "int32"

      NombreCCSifcoSaldo:
        description: NombreSaldo de CCSifcoCapital
        type: "string"number"
        format: "double"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosCuentasAhorro:
    properties:
      SecuenciaNumeroCuenta:
        description: Numero SecuenciaCuenta
        type: "integerstring"

       formatProducto:
"int32"        CodigoProyectoSAPdescription: Codigo Producto
      description: Código Proyecto SAPtype: "integer"
        typeformat: "stringint32"

      NombreCCSAPSubProducto:
        description: Código Nombredel CCSAPSubProducto
        type: "stringinteger"
        CodigoCCSifcoformat: "int32"

      descriptionTieneCondicionesEspeciales:
Código CCSifco       description: Tiene type: "integer"Condiciones Especiales
        formattype: "int32string"

      NombreCCSifcoFrecuenciaCondicionesEspeciales:
        description: Nombre CCSifcoCódigo de la Frecuencia
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Transacciones:   MontoDescuentoPlanilla:
 properties:       InterfazarCodigosDeTransacciondescription: Monto Descuento Planilla
     description: Interfazar Códigos De Transaccióntype: "number"
        typeformat: "booleandouble"

      NombreCampoSAPFrecuenciaDescuentoPlanilla:
        description: NombreCódigo de Campola SAPFrecuencia
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Series:     propertiesReferencia:
      ObjetoDeNegocio:         description: ObjetoCuenta Dede NegocioReferencia
        type: "integerstring"

       formatMonto:
"int32"        CodigoSerieSAP:
        description: Código Serie SAPMonto
        type: "stringnumber"
       NombreSerieSAP:
        description: Nombre Serie SAP
        type format: "stringdouble"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  WSInformacionCliente.PrestamosCalificadoresAdicionales:
    properties:
      NumeroPrestamoCodigoCalificador:
        description: NúmeroCódigo
del Préstamo       type: "integer"
     type   format: "stringint32"

      NombrePrestamoValorCalificador:
        description: NombreValor del calificador Préstamoadicional
        type: "string"


     Productox-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasBancarias:
    properties:
      Correlativo:
        description: CodigoReferencia ProductoBancaria
        type: "integer"
        format: "int32"

      SubProductoCodigoBanco:
        description: CódigoCodigo SubProductoBanco
Colocación
        type: "integer"
        format: "int32"

      SaldoTipoCuenta:
        description: SaldoTipo de CapitalCuenta
        type: "numberinteger"
        format: "doubleint32"

      x-gx-levelNumeroCuenta:
"WSInformacionCliente"     WSInformacionCliente.CuentasAhorro:     propertiesdescription: Número de la Cuenta
  NumeroCuenta:         description: Numero Cuentatype: "string"

      EstadoReferencia:
    type: "string"   description: Estatus de la Referencia Producto:Banca
        descriptiontype: Código"string"
Producto

       typex-gx-level: "integerWSInformacionCliente"


  WSInformacionCliente.Telefonos:
   format properties:
"int32"        SubProductoCorrelativo:
        description: CódigoCorrelativo delpor SubProductocliente
        type: "integer"
        format: "int32"

      TieneCondicionesEspecialesTipoTelefono:
        description: TieneTipo Condicionesde Especialestelefono
        type: "stringinteger"
        FrecuenciaCondicionesEspecialesformat: "int32"

      descriptionNumeroTelefono: Código de
la Frecuencia       description: Número type:telefonico
"integer"         formattype: "int32string"

      MontoDescuentoPlanillaObservacionTelefono:
        description: MontoObservaciones
Descuento Planilla
        type: "numberstring"


    x-gx-level: "WSInformacionCliente"

format
  WSInformacionCliente.Direcciones:
"double"
    properties:
      FrecuenciaDescuentoPlanillaCorrelativo:
        description: CódigoCorrelativo de laDirección
Frecuencia         type: "integer"
        format: "int32"

      ReferenciaTipoDireccion:
        description: CuentaTipo de ReferenciaDirección
        type: "stringinteger"
       Monto format: "int32"

      descriptionDireccionPais:
Monto        description: Código type: "number"pais dirección
        formattype: "doubleinteger"
      x-gx-level  format: "WSInformacionClienteint64"

   WSInformacionCliente.CalificadoresAdicionales:     properties:
      CodigoCalificadorDireccionDepartamento:
        description: Código Región Dirección
        type: "integer"
        format: "int32int64"

      ValorCalificadorDireccionMunicipio:
        description: ValorCódigo delDepartamento calificador adicionalDirección
        type: "stringinteger"
        x-gx-levelformat: "WSInformacionClienteint64"




WSInformacionCliente.CuentasBancarias:     properties:
      Correlativo DireccionZona:
        description: ReferenciaCódigo Municipio BancariaDirección
        type: "integer"
        format: "int32int64"

      CodigoBancoDireccion:
        description: CódigoDirección
Banco         type: "integerstring"

       formatCodigoPostal:
"int32"        TipoCuentadescription: Código Postal
      description: Tipo de Cuenta  type: "string"

      Geolocalizacion:
        typedescription: "integer"Geolocalización
        formattype: "int32string"

      NumeroCuentaDireccionEmpresaDondeLabora:
        description: NúmeroNombre de la empresa donde Cuentalabora
        type: "string"

      EstadoReferenciaPuesto:
        description: EstatusPuesto deen la Referenciaempresa
Bancaria         type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.TelefonosRefPersonales:
    properties:
      Correlativo:
        description: Correlativo porde clienteReferencia Personal
        type: "integer"
        format: "int32"

      TipoTelefonoTipoPersona:
        description: Tipo de teléfonoPersona Referencia
        type: "integerstring"

       format: "int32"

      NumeroTelefonoNombre:
        description: NúmeroReferencia telefónicoNombre
        type: "string"

      ObservacionTelefonoDireccion:
        description: Dirección Referencia ObservacionesPersonal
        type: "string"

     x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Direcciones CodigoPostal:
    properties:       Correlativodescription: Código Postal Ref. Personal
    description: Correlativo de Dirección         type: "integer"
        format: "int32int64"

      TipoDireccionTelefono:
        description: TipoTeléfono deReferencia DirecciónPersonal
        type: "integerstring"

       formatFax:
"int32"        DireccionPaisdescription: FAX Referencia Personal
     description: Código país direccióntype: "string"

      typeemail:
   "integer"     description: Correo Electrónico Ref. format: "int64"Per.
        DireccionDepartamentotype: "string"

      descriptionTipoRelalcion:
Código Región Dirección      description: Tipo de type:Relación
"integer"         formattype: "int64string"

      DireccionMunicipioDetalle:
        description: CódigoDetalles de Departamentola DirecciónReferencia
        type: "integerstring"

       formatEstatus:
"int64"        DireccionZonadescription: Estatus de la      description: Código Municipio DirecciónReferencia Per.
        type: "integerstring"

       formatCelular:
"int64"        Direcciondescription: Celular referencia personal
     description: Dirección    type: "string"


   type x-gx-level: "stringWSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    CodigoPostalproperties:
        descriptionCentrosDeCosto: Código
Postal         type: "string"array
        Geolocalizacionitems:
          description: CentroDeCosto
 Geolocalización         type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      DireccionEmpresaDondeLaboraProyectos:
        descriptiontype: Nombrearray
de la empresa donde labora    items:
    type: "string"     description: Proyecto
 Puesto:         description$ref: Puesto en la empresa"#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

      Transacciones:
   type: "string"       x-gx-level$ref: "WSInformacionCliente"#/definitions/ParametrosExtendidos_B1Integration.Transacciones"

      WSIngresarClientesOutputSeries:
        propertiestype: array
        CodigoClienteitems:
        type  description: "integer"Serie
          format$ref: "int64#/definitions/ParametrosExtendidos_B1Integration.Series"

     ConsultaResultados FormaDePago:
        description$ref: WSInformacion Cliente"#/definitions/ParametrosExtendidos_B1Integration.FormaDePago"

      PagosTransferencia:
        type: array
        items:
          description: PagoTransferencia
          $ref: "#/definitions/WSInformacionClienteParametrosExtendidos_B1Integration.PagosTransferencia"


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
 Messages:   properties:
     description Secuencia:
Messages          type: array
        items:
          $ref: "#/definitions/Messages_Message"
      Result:
        type: "string"


  Messages_Message:
    properties:
      Id:
        description: Id
        type: "string"

      Type:
        description: Type
        type: "integer"
        format: "int32"

      Description:
        description: Description
        type: "string"

 
  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"

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.

NO DEBE OLVIDAR

Antes de consumir este Web Service, debe consultar cada una de los WS descritos en Web Services de Consulta de Categorías Generales, dado a que en ellos se listan los valores ya cargados de un conjunto de parámetros necesarios para ingresar un cliente al sistema, y dichos parámetros deben coincidir con los ya existentes en el para evitar errores y/o inconsistencias durante el ingreso de clientes, igualmente se debe respetar las constantes ya definida en el sistema, indicadas en la pagina de Constantes asociadas a variables preestablecidas en la Aplicación SIFCO WEB.

NO DEBE OLVIDAR

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, 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.

 {
  "Modo": "INS",
  "ConsultaFormaIdentificar": 0,
  "ConsultaValorIdentificador": "",
  "WSCliente": {
      "TipoIdentificacion": 1,
      "NumeroIdentificacion": "9999999999",
      "PrimerNombre": "XXXXXX",
      "SegundoNombre": "XXXXXXXX",
      "PrimeApellido": "XXXXXXXX",
      "SegundoApellido": "XXXXXXX",
      "ApellidoCasada": "",
      "FechaNacimiento": "1995-09-18",
      "EstadoCivil": 2,
      "ActividadEconomica": 1,
      "DireccionEMailPrincipal": "XXX@sifco.org"
} 


  

{
  "Modo": "INS",
  "ConsultaFormaIdentificar": 1,
  "ConsultaValorIdentificador": "0",
  "WSCliente": {
      "CodigoCliente": "0",
      "TipoDePersona": "J",
      "TipoIdentificacion": 2,    
      "NombreJuridico": "XXXXXXXXX",
      "RepresentanteLegal": "PENDIENTE",    
      "NumeroIdentificacionTributaria": "99999",
  }
}