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:
        -  descriptionname: "Internal server errorWSIngresarClientesInput"
          schemain: "body"
           $refrequired: "#/definitions/GxJsonError"
security:false
   - OAuth2: []     ApiKeyAuth1schema:
[] securityDefinitions:   OAuth2:     type: oauth2     flow$ref: password"#/definitions/WSIngresarClientesInput"


  tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token   responses:
 scopes:       Execute200:
Permite el metodo tipo GET      description: Insert: Permite el metodo tipo POST"Successful operation"
          Updateschema:
Permite  el metodo tipo PUT       Delete$ref: Permite el metodo tipo DELETE"#/definitions/WSIngresarClientesOutput"
        404:
 FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  WSIngresarClientesInput:
    properties:
 description: "Not found"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
Modo:      Execute: Permite el type: "string"método tipo GET
      ConsultaFormaIdentificarInsert: Permite el método tipo POST
   type: "integer"  Update: Permite el método tipo PUT
 format: "int32"    Delete: Permite el ConsultaValorIdentificador:método tipo DELETE
      typeFullControl: "string"Permite el manejo de los Cuatro  WSCliente:
 Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
   description type: WSInformacionapiKey
Cliente    in: header
   $ref name: "#/definitions/WSInformacionCliente"granttype

definitions:

  WSInformacionClienteWSIngresarClientesInput:
    properties:
      CodigoClienteModo:
        descriptiontype: Código del Cliente"string"
      ConsultaFormaIdentificar:
        type: "integer"
        format: "int64int32"
       TipoDePersona:
        description: Tipo de PersonaConsultaValorIdentificador:
        type: "string"
       TipoIdentificacionWSCliente:
        description: TipoWSInformacion deCliente
Identificación         type$ref: "integer#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    formatproperties:
"int32"      CodigoCliente:
  DocumentoIdentificacionPais:
        description: PaisCódigo dedel EmisiónCliente
Documento         type: "integer"
        format: "int64"

      DocumentoIdentificacionDepartamentoTipoDePersona:
        description: CódigoTipo Regiónde Emisión IdentifiPersona
        type: "integerstring"

       formatTipoIdentificacion:
"int64"

      DocumentoIdentificacionMunicipio:         description: DepartamentoTipo Emisiónde IdentificIdentificación
        type: "integer"
        format: "int64int32"

      DocumentoIdentificacionZonaDocumentoIdentificacionPais:
        description: CódigoPais Municipiode Emisión IdentDocumento
        type: "integer"
        format: "int64"

      NumeroIdentificacionDocumentoIdentificacionDepartamento:
        description: NúmeroCódigo deRegión IdentificaciónEmisión ClienIdentifi
        type: "integer"
        format: "stringint64"

      PrimerNombreDocumentoIdentificacionMunicipio:
        description: Departamento PrimerEmisión NombreIdentific
        type: "stringinteger"
       SegundoNombre format: "int64"

      descriptionDocumentoIdentificacionZona:
Segundo Nombre       description: Código type: "string"

Municipio Emisión Ident
     PrimeApellido:         descriptiontype: Primer Apellido"integer"
        typeformat: "stringint64"

      SegundoApellidoNumeroIdentificacion:
        description: Número Segundode Identificación ApellidoClien
        type: "string"

      ApellidoCasadaPrimerNombre:
        description: ApellidoPrimer de CasadaNombre
        type: "string"

      SexoSegundoNombre:
        description: SexoSegundo ClienteNombre
        type: "string"

      FechaNacimientoPrimeApellido:
        description: FechaPrimer deApellido
Nacimiento         type: "string"

       formatSegundoApellido:
"date"        EstadoCivil:
        description: EstadoSegundo CivilApellido
        type: "integerstring"

       format: "int32"
ApellidoCasada:
      NombreJuridico:         description: NombreApellido de Empresa o SociedadCasada
        type: "string"

      RepresentanteLegalSexo:
        description: Nombre del Representante LegalSexo Cliente
        type: "string"

      NumeroRegistroMercantilFechaNacimiento:
        description: Número de Registro Mercantil
        type: "string"

      FechaConstitucion:
        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 IdentificaciónEmpresa o 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"
       CodigoReferencia:
        description: Referencia
        type format: "stringdate"

      ActividadEconomicaGrupo:
        description: Código del Grupo de actividad económicaAfinidad
        type: "integer"
        format: "int32int64"

      DireccionEMailPrincipalNumeroIdentificacionTributaria:
        description: Correo ElectrónicoNúmero de Identificación Tributaria
        type: "string"

      DireccionEMailSecundarioPromotor:
        description: CorreoCódigo ElectrónicoPromotor
Alternativo
        type: "string"

      ExcluirDeMensajesDeCorreoAfectoAImpuestos:
        description: ExcluirAfecto dea CorreosImpuestos
Electronicos         type: "integerstring"

       formatEstadoCliente:
"int32"        ParametrosExtendidos_B1Integrationdescription: Estado del Cliente
     description: Parametros Extendidos_B1 Integrationtype: "string"

      $refCodigoReferencia:
"#/definitions/ParametrosExtendidos_B1Integration"        Prestamosdescription: Referencia
        type: array"string"

       itemsActividadEconomica:
 
        description: Código Prestamode actividad económica
        $reftype: "#/definitions/WSInformacionCliente.Prestamosinteger"
       CuentasAhorro format: "int32"

      typeDireccionEMailPrincipal:
array         itemsdescription: Correo Electrónico
        descriptiontype: CuentaAhorro"string"

      DireccionEMailSecundario:
  $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"     description: Correo Electrónico CalificadoresAdicionales:Alternativo
        type: array"string"

       itemsExcluirDeMensajesDeCorreo:
          description: CalificadorAdicionalExcluir de Correos Electronicos
        $reftype: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"integer"
        CuentasBancariasformat: "int32"

      typeParametrosExtendidos_B1Integration:
array         itemsdescription: Parametros Extendidos_B1 Integration
       description: CuentaBancaria
          $ref: "#/definitions/WSInformacionCliente.CuentasBancariasParametrosExtendidos_B1Integration"

      TelefonosPrestamos:
        type: array
        items:
          description: TelefonoPrestamo
          $ref: "#/definitions/WSInformacionCliente.TelefonosPrestamos"

      DireccionesCuentasAhorro:
        type: array
        items:
          description: DireccionCuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.DireccionesCuentasAhorro"
  

  ParametrosExtendidos_B1Integration:     propertiesCalificadoresAdicionales:
      CentrosDeCosto:
        type: array
        items:
          description: CentroDeCostoCalificadorAdicional
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoCalificadoresAdicionales"

      ProyectosCuentasBancarias:
        type: array
        items:
          description: ProyectoCuentaBancaria
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosCuentasBancarias"

      TransaccionesTelefonos:
        type: array
        items:
          description: TransaccionesTelefono
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesTelefonos"

      SeriesDirecciones:
        type: array
        items:
          description: SerieDireccion
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesDirecciones"

   ParametrosExtendidos_B1Integration.CentrosDeCosto:   RefPersonales:
 properties:       Secuenciatype: array
       description items:
 Secuencia         typedescription: "integer"Referencia
          format$ref: "int32"#/definitions/WSInformacionCliente.RefPersonales"


  WSInformacionCliente.Prestamos:
    properties:
  CodigoCCSAP    NumeroPrestamo:
        description: Número Codigodel CCSAPPréstamo
        type: "string"

      NombreCCSAPNombrePrestamo:
        description: Nombre CCSAPdel Préstamo
        type: "string"

      CodigoCCSifcoProducto:
        description: Codigo CCSifcoProducto
        type: "integer"
        format: "int32"

      NombreCCSifcoSubProducto:
        description: Código NombreSubProducto CCSifcoColocacion
        type: "stringinteger"
      x-gx-level  format: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Proyectos:   Saldo:
 properties:       Secuenciadescription: Saldo de     Capital
 description: Secuencia         type: "integernumber"
        format: "int32double"


     CodigoProyectoSAPx-gx-level: "WSInformacionCliente"


     descriptionWSInformacionCliente.CuentasAhorro:
Codigo Proyecto SAP         type: "string"properties:
       NombreCCSAPNumeroCuenta:
        description: NombreNumero CCSAPCuenta
        type: "string"

      CodigoCCSifcoProducto:
        description: Codigo CCSifcoProducto
        type: "integer"
        format: "int32"

      NombreCCSifcoSubProducto:
        description: Código Nombredel CCSifcoSubProducto
        type: "stringinteger"
      x-gx-level  format: "ParametrosExtendidos_B1Integrationint32"


  ParametrosExtendidos_B1Integration.Transacciones:     propertiesTieneCondicionesEspeciales:
      InterfazarCodigosDeTransaccion:         description: InterfazarTiene CodigosCondiciones De TransaccionEspeciales
        type: "booleanstring"

      NombreCampoSAPFrecuenciaCondicionesEspeciales:
        description: Código Nombrede Campola SAPFrecuencia
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integration""int32"

      MontoDescuentoPlanilla:
        description: Monto Descuento Planilla
        ParametrosExtendidos_B1Integration.Seriestype: "number"
     properties:   format: "double"

     ObjetoDeNegocio FrecuenciaDescuentoPlanilla:
        description: Código Objetode Dela NegocioFrecuencia
        type: "integer"
        format: "int32"

      CodigoSerieSAPReferencia:
        description: CodigoCuenta Seriede SAPReferencia
        type: "string"

      NombreSerieSAPMonto:
        description: Nombre Serie SAP Monto
        type: "number"
        typeformat: "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
Colocacion         type: "integer"
        format: "int32"

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

     x-gx-level: "WSInformacionCliente" NumeroCuenta:
        WSInformacionCliente.CuentasAhorrodescription: Número de la Cuenta
properties:        NumeroCuentatype: "string"

      EstadoReferencia:
        description: Numero Cuenta Estatus de la Referencia Banca
        type: "string"


     Productox-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    properties:
      Correlativo:
        description: CodigoCorrelativo por Productocliente
        type: "integer"
        format: "int32"

      SubProductoTipoTelefono:
        description: CódigoTipo delde SubProductotelefono
        type: "integer"
        format: "int32"

      TieneCondicionesEspecialesNumeroTelefono:
        description: TieneNúmero Condicionestelefonico
Especiales         type: "string"

      FrecuenciaCondicionesEspecialesObservacionTelefono:
        description: Código de laObservaciones
Frecuencia         type: "integerstring"


      formatx-gx-level: "int32WSInformacionCliente"


  WSInformacionCliente.Direcciones:
  MontoDescuentoPlanilla:  properties:
      descriptionCorrelativo:
Monto Descuento Planilla        description: Correlativo de Dirección
        type: "numberinteger"
        format: "doubleint32"

      FrecuenciaDescuentoPlanillaTipoDireccion:
        description: CódigoTipo de laDirección
Frecuencia         type: "integer"
        format: "int32"

      ReferenciaDireccionPais:
        description: CuentaCódigo depais Referenciadirección
        type: "stringinteger"
       Monto format: "int64"

      descriptionDireccionDepartamento:
Monto         type: "number"description: Código Región Dirección
        formattype: "doubleinteger"
        x-gx-levelformat: "WSInformacionClienteint64"

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

      ValorCalificadorDireccionZona:
        description: ValorCódigo delMunicipio calificador adicionalDirección
        type: "stringinteger"
      x-gx-level  format: "WSInformacionClienteint64"

   WSInformacionCliente.CuentasBancarias:   Direccion:
 properties:       Correlativodescription: Dirección
        descriptiontype: Referencia"string"
Bancaria
      CodigoPostal:
 type: "integer"      description: Código Postal
format: "int32"        CodigoBancotype: "string"

      descriptionGeolocalizacion:
Codigo Banco         typedescription: "integer"Geolocalización
        formattype: "int32string"

      TipoCuentaDireccionEmpresaDondeLabora:
        description: TipoNombre de Cuentala empresa donde labora
     type: "integer"         formattype: "int32string"

      NumeroCuentaPuesto:
        description: NúmeroPuesto deen la Cuentaempresa
        type: "string"


     EstadoReferenciax-gx-level: "WSInformacionCliente"


     description: Estatus de la Referencia Banca
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos.RefPersonales:
    properties:
      Correlativo:
        description: Correlativo porde Referencia clientePersonal
        type: "integer"
        format: "int32"

      TipoTelefonoTipoPersona:
        description: Tipo de Persona telefonoReferencia
        type: "integerstring"

       format: "int32"

      NumeroTelefonoNombre:
        description: NúmeroReferencia telefonicoNombre
        type: "string"

      ObservacionTelefonoDireccion:
        description: Dirección ObservacionesReferencia Personal
        type: "string"

      x-gx-levelCodigoPostal:
"WSInformacionCliente"      WSInformacionCliente.Direcciones:     propertiesdescription: Código Postal     Correlativo:
  Ref. Personal
     description: Correlativo de Dirección
        type: "integer"
        format: "int32int64"

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

       format: "int32"Fax:
        description: FAX Referencia Personal
        DireccionPaistype: "string"

      descriptionemail:
Código pais dirección      description: Correo Electrónico type: "integer"Ref. Per.
        formattype: "int64string"

      DireccionDepartamentoTipoRelalcion:
        description: CódigoTipo Regiónde DirecciónRelación
        type: "integerstring"

      Detalle:
format: "int64"        description: Detalles de la Referencia
        DireccionMunicipiotype: "string"

      descriptionEstatus:
Código Departamento Dirección      description: Estatus de la type: "integer"Referencia Per.
        formattype: "int64string"

      DireccionZonaCelular:
        description: CódigoCelular Municipioreferencia Direcciónpersonal
        type: "integerstring"


      formatx-gx-level: "int64WSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    Direccionproperties:
        descriptionCentrosDeCosto: Dirección
        type: array
"string"        CodigoPostalitems:
          description: CentroDeCosto
Código Postal         type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      GeolocalizacionProyectos:
        descriptiontype: Geolocalizaciónarray
        typeitems:
  "string"        DireccionEmpresaDondeLaboradescription: Proyecto
          description$ref: Nombre de la empresa donde labora"#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

      Transacciones:
        type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.Transacciones"

      PuestoSeries:
        descriptiontype: Puestoarray
en la empresa      items:
  type: "string"       x-gx-leveldescription: "WSInformacionCliente"Serie
     WSIngresarClientesOutput:     properties:$ref: "#/definitions/ParametrosExtendidos_B1Integration.Series"

     CodigoCliente FormaDePago:
        type$ref: "integer#/definitions/ParametrosExtendidos_B1Integration.FormaDePago"

       format: "int64"PagosTransferencia:
        type: array
        ConsultaResultadositems:
          description: WSInformacion Cliente PagoTransferencia
          $ref: "#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia"


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
   type: array properties:
      Secuencia:
        itemsdescription: Secuencia
        type: "integer"
        $refformat: "#/definitions/WSInformacionClienteint32"

     Messages CodigoCCSAP:
        description: MessagesCodigo CCSAP
        type:     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: Codigo 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",
  }
}