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"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/WSIngresarClientesInput"


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

  WSIngresarClientesInput:
    properties:
      Modo:
        descriptiontype: Tipo de Identificación"string"
      ConsultaFormaIdentificar:
        type: "integer"
        format: "int32"
       DocumentoIdentificacionPaisConsultaValorIdentificador:
        descriptiontype: Pais de Emisión Documento"string"
      WSCliente:
        typedescription: "integer"WSInformacion Cliente
        format$ref: "int64"
#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    properties:
      DocumentoIdentificacionDepartamentoCodigoCliente:
        description: Código Regióndel Emisión IdentifiCliente
        type: "integer"
        format: "int64"

      DocumentoIdentificacionMunicipioTipoDePersona:
        description: DepartamentoTipo Emisiónde IdentificPersona
        type: "integerstring"

       formatTipoIdentificacion:
"int64"        DocumentoIdentificacionZona:
        description: CódigoTipo Municipiode EmisiónIdentificación
Ident         type: "integer"
        format: "int64int32"

      NumeroIdentificacionDocumentoIdentificacionPais:
        description: NúmeroPais de IdentificaciónEmisión ClienDocumento
        type: "stringinteger"
       PrimerNombre format: "int64"

      descriptionDocumentoIdentificacionDepartamento:
Primer Nombre         typedescription: "string"Código Región Emisión Identifi
    SegundoNombre:         descriptiontype: Segundo"integer"
Nombre         typeformat: "stringint64"

      PrimeApellidoDocumentoIdentificacionMunicipio:
        description: PrimerDepartamento Emisión ApellidoIdentific
        type: "stringinteger"
        SegundoApellidoformat: "int64"

      descriptionDocumentoIdentificacionZona:
Segundo Apellido       description:  type: "string"Código Municipio Emisión Ident
        ApellidoCasadatype: "integer"
       description: Apellido de Casada
        type format: "stringint64"

      SexoNumeroIdentificacion:
        description: Número Sexode Identificación ClienteClien
        type: "string"

      FechaNacimientoPrimerNombre:
        description: FechaPrimer de NacimientoNombre
        type: "string"

       formatSegundoNombre:
"date"        EstadoCivil:
        description: EstadoSegundo CivilNombre
        type: "integerstring"

       formatPrimeApellido:
"int32"        NombreJuridico:
        description: NombrePrimer de EmpresaApellido
o Sociedad         type: "string"

      RepresentanteLegalSegundoApellido:
        description: NombreSegundo delApellido
Representante Legal         type: "string"

      NumeroRegistroMercantilApellidoCasada:
        description: NúmeroApellido de Registro MercantilCasada
        type: "string"

      FechaConstitucionSexo:
        description: FechaSexo deCliente
Constitución         type: "string"

       formatFechaNacimiento:
"date"        Grupodescription: Fecha de Nacimiento
     description: Código del Grupo de Afinidadtype: "string"
         typeformat: "integerdate"

       formatEstadoCivil:
"int64"        NumeroIdentificacionTributariadescription: Estado Civil
      description: Número de Identificación Tributariatype: "integer"
         typeformat: "stringint32"

      PromotorNombreJuridico:
        description: Código Promotor Nombre de Empresa o Sociedad
        type: "string"

      AfectoAImpuestosRepresentanteLegal:
        description: AfectoNombre del aRepresentante ImpuestosLegal
        type: "string"

      EstadoClienteNumeroRegistroMercantil:
        description: Número Estadode delRegistro ClienteMercantil
        type: "string"

      CodigoReferenciaFechaConstitucion:
        description: ReferenciaFecha de Constitución
        type: "string"
       ActividadEconomica format: "date"

      descriptionGrupo:
Código de actividad económica       description: Código del Grupo de Afinidad
        type: "integer"
        format: "int32int64"

      DireccionEMailPrincipalNumeroIdentificacionTributaria:
        description: Número Correode Identificación ElectrónicoTributaria
        type: "string"

      DireccionEMailSecundarioPromotor:
        description: CorreoCódigo Electrónico AlternativoPromotor
        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: PrestamoCódigo de actividad económica
        $reftype: "#/definitions/WSInformacionCliente.Prestamos"integer"
        CuentasAhorroformat: "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: Excluir CalificadorAdicionalde Correos Electronicos
        $reftype: "#/definitions/WSInformacionCliente.CalificadoresAdicionalesinteger"
       CuentasBancarias:
        type: array format: "int32"

       itemsParametrosExtendidos_B1Integration:
          description: CuentaBancariaParametros Extendidos_B1 Integration
        $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
        descriptionitems:
 Secuencia         typedescription: Referencia
 "integer"         format$ref: "int32#/definitions/WSInformacionCliente.RefPersonales"


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

      NombreCCSAPNombrePrestamo:
        description: Nombre del CCSAPPréstamo
        type: "string"

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

      NombreCCSifcoSubProducto:
        description: NombreCódigo SubProducto 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  properties:
      typeNumeroCuenta:
"string"        NombreCCSAPdescription:         description: Nombre CCSAPNumero Cuenta
        type: "string"

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

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

   ParametrosExtendidos_B1Integration.Transacciones:     propertiesTieneCondicionesEspeciales:

     InterfazarCodigosDeTransaccion:         description: InterfazarTiene CodigosCondiciones DeEspeciales
Transaccion         type: "booleanstring"

      NombreCampoSAPFrecuenciaCondicionesEspeciales:
        description: NombreCódigo de Campola SAPFrecuencia
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Series:   MontoDescuentoPlanilla:
 properties:       ObjetoDeNegociodescription: Monto Descuento Planilla
        type: "number"
        format: "double"

      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: "stringinteger"
        NombrePrestamoformat: "int32"

      descriptionValorCalificador:
Nombre del Préstamo      description: Valor del calificador adicional
        type: "string"


    x-gx-level: "WSInformacionCliente"


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

      SubProductoCodigoBanco:
        description: CódigoCodigo SubProducto ColocacionBanco
        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"

      descriptionEstadoReferencia:
Numero Cuenta       description:  typeEstatus de la Referencia Banca
        type: "string"


    x-gx-level:   Producto"WSInformacionCliente"


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

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

      TieneCondicionesEspecialesNumeroTelefono:
        description: TieneNúmero Condiciones Especialestelefonico
        type: "string"

      FrecuenciaCondicionesEspecialesObservacionTelefono:
        description: Código de la FrecuenciaObservaciones
        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 la FrecuenciaDirección
        type: "integer"
        format: "int32"

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

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

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

      ValorCalificadorDireccionZona:
        description: ValorCódigo delMunicipio calificadorDirección
adicional         type: "stringinteger"
        x-gx-levelformat: "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"


  WSInformacionCliente.RefPersonales:
  description: Estatus de la Referencia Banca
        type: "string" 

    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    properties:
      Correlativo:
        description: Correlativo de porReferencia clientePersonal
        type: "integer"
        format: "int32"

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

       format: "int32"

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

      ObservacionTelefonoDireccion:
        description: ObservacionesDirección Referencia Personal
        type: "string"

     x-gx-level CodigoPostal:
"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",
  }
}