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: País 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 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:         descriptiontype: Segundo Nombre"integer"
        typeformat: "stringint64"

      PrimeApellidoDocumentoIdentificacionMunicipio:
        description: Departamento PrimerEmisión ApellidoIdentific
        type: "stringinteger"
        SegundoApellidoformat: "int64"

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

      SexoNumeroIdentificacion:
        description: Número de SexoIdentificación ClienteClien
        type: "string"

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

       formatSegundoNombre:
"date"        EstadoCivildescription: Segundo Nombre
      description: Estado Civil  type: "string"

      PrimeApellido:
        typedescription: "integer"Primer Apellido
        formattype: "int32string"

      NombreJuridicoSegundoApellido:
        description: NombreSegundo de EmpresaApellido
o Sociedad         type: "string"

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

      NumeroRegistroMercantilSexo:
        description: Número de Registro MercantilSexo Cliente
        type: "string"

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

      GrupoEstadoCivil:
        description: Código del Grupo de AfinidadEstado Civil
        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"
       CodigoReferencia:
        description: Referencia
        type: "string format: "date"

      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ónico AlternativoPromotor
        type: "string"

      ExcluirDeMensajesDeCorreoAfectoAImpuestos:
        description: ExcluirAfecto dea CorreosImpuestos
Electrónicos         type: "integerstring"

       formatEstadoCliente:
"int32"        ParametrosExtendidos_B1Integrationdescription: Estado del Cliente
     description: Parámetros Extendidos_B1 Integrationtype: "string"

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

       itemsActividadEconomica:
 
        description: PréstamoCódigo de actividad económica
       $ref type: "#/definitions/WSInformacionCliente.Prestamosinteger"
       CuentasAhorro format: "int32"

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

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

      ExcluirDeMensajesDeCorreo:
      CalificadoresAdicionales  description: Excluir de Correos 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 CuentasBancarias:
    properties:       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: SecuenciaNúmero del Préstamo
      type: "integer"
        format type: "int32string"

      CodigoCCSAPNombrePrestamo:
        description: Nombre Códigodel CCSAPPréstamo
        type: "string"

      NombreCCSAPProducto:
        description: NombreCodigo CCSAPProducto
        type: "stringinteger"
       CodigoCCSifco format: "int32"

      descriptionSubProducto:
Código CCSifco       description: Código SubProducto Colocacion
        type: "integer"
        format: "int32"

      NombreCCSifcoSaldo:
        description: Saldo Nombrede CCSifcoCapital
        type: "string"number"
        format: "double"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosCuentasAhorro:
    properties:
      SecuenciaNumeroCuenta:
        description: SecuenciaNumero Cuenta
        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: Código de Nombrela CCSifcoFrecuencia
        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: Código Nombrede Campola SAPFrecuencia
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integrationint32"

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

       format: "int32"

      CodigoSerieSAPMonto:
        description: Código Serie SAPMonto
        type: "stringnumber"
       NombreSerieSAP:
        description: Nombre Serie SAP
        type: "string format: "double"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  WSInformacionCliente.PrestamosCalificadoresAdicionales:
    properties:
      NumeroPrestamoCodigoCalificador:
        description: Número del Préstamo Código
        type: "integer"
        typeformat: "stringint32"

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


     Productox-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasBancarias:
  description: Codigo Producto  properties:
      Correlativo:
        description: Referencia Bancaria
        type: "integer"
        format: "int32"

      SubProductoCodigoBanco:
        description: CódigoCodigo SubProducto ColocaciónBanco
        type: "integer"
        format: "int32"

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

     x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasAhorro NumeroCuenta:
    properties:       NumeroCuentadescription: Número        description: Numerode la Cuenta
        type: "string"

      ProductoEstadoReferencia:
        description: Código Producto Estatus de la Referencia Banca
        type: "integerstring"


      formatx-gx-level: "int32WSInformacionCliente"


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

      TieneCondicionesEspecialesTipoTelefono:
        description: TieneTipo Condicionesde Especialestelefono
        type: "stringinteger"
       FrecuenciaCondicionesEspeciales format: "int32"

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

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


    x-gx-level: "WSInformacionCliente"


  formatWSInformacionCliente.Direcciones:
  "double"  properties:
     FrecuenciaDescuentoPlanilla Correlativo:
        description: CódigoCorrelativo de laDirección
Frecuencia         type: "integer"
        format: "int32"

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

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

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

      ValorCalificadorDireccionMunicipio:
        description: ValorCódigo delDepartamento calificadorDirección
adicional         type: "stringinteger"
       x-gx-level format: "WSInformacionClienteint64"


  WSInformacionCliente.CuentasBancarias:     propertiesDireccionZona:
 
    Correlativo:         description: Código ReferenciaMunicipio BancariaDirección
        type: "integer"
        format: "int32int64"

      CodigoBancoDireccion:
        description: Código BancoDirección
        type: "integerstring"

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

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

      NumeroCuentaDireccionEmpresaDondeLabora:
        description: NúmeroNombre de la Cuentaempresa donde labora
        type: "string"

      EstadoReferenciaPuesto:
        description: EstatusPuesto deen la Referencia Bancariaempresa
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.TelefonosRefPersonales:
    properties:
      Correlativo:
        description: Correlativo porde Referencia clientePersonal
        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: ObservacionesDirección Referencia Personal
        type: "string"

     x-gx-level: "WSInformacionCliente" CodigoPostal:
        WSInformacionCliente.Direccionesdescription: Código Postal Ref. Personal
 properties:       Correlativotype: "integer"
        descriptionformat: Correlativo"int64"
de
Dirección      Telefono:
  type: "integer"     description: Teléfono Referencia Personal
format: "int32"        TipoDirecciontype: "string"

      descriptionFax:
Tipo de Dirección      description: FAX Referencia type:Personal
"integer"         formattype: "int32string"

      DireccionPaisemail:
        description: Correo CódigoElectrónico paísRef. direcciónPer.
        type: "integerstring"

       formatTipoRelalcion:
"int64"        DireccionDepartamentodescription: Tipo de Relación
     description: Código Región Direccióntype: "string"

      typeDetalle:
 "integer"       description: Detalles de la format:Referencia
"int64"        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: "string"array
        CodigoPostalitems:
          description: CódigoCentroDeCosto
 Postal         type$ref: "string"

#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      GeolocalizacionProyectos:
        descriptiontype: Geolocalizaciónarray
        typeitems:
 "string"         DireccionEmpresaDondeLaboradescription: Proyecto
        description: Nombre de la empresa donde labora  $ref: "#/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"

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

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


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
    typeproperties:
array      Secuencia:
        items:description: Secuencia
        type: "integer"
       $ref format: "#/definitions/WSInformacionClienteint32"

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