Tabla de Contenidos

Fábrica - Servicios Web - Integraciones - SicofWS

Este servicio expone las siguientes operaciones que afectan Sicof ERP:

MethodPathDescription
Get/Verifica el estado del servicio
Post/facturacionGeneración de facturas (Cuentas por Cobrar)
Post/recaudoGeneración de recaudos(Comprobantes de Ingresos)
Post/cambioIdActualiza la identificación de los tercero
Get/tercero/searchRealiza la búsqueda de un tercero por medio de su Nit
Post/tercero/guardarTerceroCrea la creación de terceros por medio de un listado de estudiantes
Get/factura/searchRealiza la búsqueda de facturas por medio de su referencia
Get/plantilla/searchRealiza la búsqueda de plantillas por medio de su código

Descripción del Servicio

NombreDescripciónTipo ServicioTecnologíaLenguajeTipo DesarrolloVersión DesarrolloArchivo de Configuración
SicofWSServicios Web backend para la creación/actualización de terceros, creación facturas y recaudos.RestSpringBoot 1.5.2Java 1.8Mantenimiento8.0.1.2application.properties
Tipo EmpaquetadoGestor de DependenciasServidor de DespliegueIDE ProyectoTipo RepositorioUrl DesarrolloUrl CalidadUrl Producción
warMaven 3.8.1Tomcat 6SpringTools 4.11Subversión SVN trunk
Dependencias
groupIdartifactIdversionscopeoptionalDescripción
com.zaxxerHikariCPcompileN/AN/AGestiona el pool de conexiones
org.springframework.bootspring-boot-starter-jerseyN/AN/AN/AJAX-RS
org.springframework.bootspring-boot-starter-data-jpaN/AN/AN/AAPI de persistencia
org.springframework.bootspring-boot-starter-data-restN/AN/AN/AAPI de mapeo de rutas
org.springframework.bootspring-boot-starter-webN/AN/AN/ACore Servicios Web
org.springframework.bootspring-boot-starter-web-servicesN/AN/AN/ACore Servicios Web
org.springframework.bootspring-boot-devtoolsN/AruntimetrueRecarga de aplicaciones
junitjunitN/AtestN/APruebas Unitarias
com.oracle.database.jdbcojdbc819.10.0.0N/AN/AAPI JDBC para conexión a Base de Datos
org.springframework.bootspring-boot-starter-tomcatN/AprovidedN/ACore Spring
org.apache.maven.pluginsmaven-compiler-plugin3.8.1N/AN/AGestor de dependnecias
Operaciones
Tipo Petición HttpNombre operaciónDescripciónDocumentación
Get/Verifica el estado del servicio
Post/facturacionGeneración de facturas (Cuentas por Cobrar)
Post/recaudoGeneración de recaudos(Comprobantes de Ingresos)
Post/cambioIdActualiza la identificación de los tercero
Get/tercero/searchRealiza la búsqueda de un tercero por medio de su Nit
Post/tercero/guardarTerceroCrea la creación de terceros por medio de un listado de estudiantes
Get/factura/searchRealiza la búsqueda de facturas por medio de su referencia
Get/plantilla/searchRealiza la búsqueda de plantillas por medio de su código
Ambientes de Despliegue
TipoUrlObservaciones
Desarrollo:http://localhost:8080/sicofwsAmbiente de desarrollo
Calidad: Ambiente de validación
Producción: Ambiente de producción

Información Adicional

Despliegue

Requisitos Técnicos Servidor

Pasos Previos: Generar war (IDE Eclipse y Spring Tools)

El proyecto está configurado para generar compilable war. Siga los siguientes pasos para generarlo1).

Nota

Para ubicar el war en el directorio del equipo desde el proyecto seleccione el war con click derecho y vaya a propiedades al visualizar la ventana emergente se verá la ubicación del archivo.

Despliegue en el servidor

  1. Realizar bacKup del artefacto actual sicofws.war
  2. Apagar el servicio tomcat y se elimina el war y sus dependencias.
  3. Se copia el nuevo war (sicofws.war ) a la carpeta webapps del Tomcat.
  4. Iniciar nuevamente el Servicio de Tomcat.
  5. Se realizan las validaciones de los servicios desplegados, se debe realizar prueba en un navegador dentro de la misma red con la siguiente URL {ip}:{puerto}/sicofws/ y esto responderá como se aprecia en la imagen a continuación:

Consideraciones

Tener presente que cada vez que se realice un cambio en la base de datos que altere estructuras que son consumidas por el servicio. Este debe reiniciarse para que tome los cambios.

Notas de Versión

Actualización 02/09/2021 -> 8.0.1.1

Se adiciona campo tipo en la factura.

{
    "consecutivo":"7",
    "estado":"A",
    "descripcion":"prueba 4 ws sicof factura 2 conceptos tipo sa01",
    "tipo" : "CXCP",//Nuevo Campo
    "facturas": [
        {
        "codigoConcepto" : "AD36" ,
        "valor" :"100",
        "nit":"1193474508",
        "centroCostos":"55301",
        "fechaPago":"30/09/2021",
        "descripcion" : "descrip concepto1 ",
        "seq" : "1",
        "seqRef" : "1",
        "referencia": "56563"       
        },
        {
        "codigoConcepto" : "AD36" ,
        "valor" :"200",
        "nit":"1193474508",
        "centroCostos":"55301",
        "fechaPago":"30/09/2021",
        "descripcion" : "descrip concepto2 ",
        "seq" : "2",
        "seqRef" : "1",
        "referencia": "56563"       
        }
    ]
}

Actualización 19/11/2021 -> 8.0.1.2

Se adicionan campos en la creación del tercero para el proceso de factura electrónica.

[
  {
    "nit" : "10262771440",
    "tipoDocumento": "1",
    "apellido1": "PALACINO",
    "apellido2": "VARGAS",
    "nombre1": "JHON",
    "nombre2": "ALEXANDER",
    "direccion": "CLL 54 C SUR  88 I 71 ",
    "codCiudad": "001",
    "codDepartamento": "50",
    "telefono": "3144518117",
    "email": "jhonpalacino0222@gmail.com",
    "tipoPersona": "1",
    "regimen": "N",
    "tipoVinculo": 29,
    "codPaisIso":"CO",//Nuevo Campo Código ISO 3611-1
    "fePostalZone": "500001",//Nuevo Campo Código Postal Colombia
    "feFiscalResponsability": "R-99-PN"//Nuevo Campo Responsabilidad Fiscal Anexo 1.8
  }
]

Nuevos Campos

HttpPathNombreTipo de DatoRequeridoValor por DefectoReglas de Validaciones
Post/tercero/guardarTercerocodPaisIsoStringNoCOSi el campo es nulo o vacio se asumira el valor “CO”. Si el código ISO no existe se cancela el proceso. Se debe enviar un código ISO válido el cual esta descrito en el anexo 1.8 de factura electrónica de la DIAN tabla 13.4.1. Países (ISO 3166‐1): cbc:IdentificationCode Sección Códigos Geográficos
Post/tercero/guardarTercerofePostalZoneStringNoNingunoEste campo no aplica reglas de validación
Post/tercero/guardarTercerofeFiscalResponsabilityStringNoNingunoSi el campo es nulo o vacio se asumira el valor “R-99-PN”. Los valores que se pueden enviar estan descritos en el anexo 1.8 de factura electrónica de la DIAN tabla 13.2.6. Responsabilidades fiscales

Nuevo Código de Errores

Se adicionan los siguientes códigos de errores:

HttpPathCódigo de ErrorDescripciónSolución
Post/tercero/guardarTercero1210Código ISO del país vacíoEl Servicio por defecto asumirá el código “CO” para identificar el país Colombia. Se debe enviar un código ISO válido el cual esta descrito en el anexo 1.8 de factura electrónica de la DIAN tabla 13.4.1. Países (ISO 3166‐1): cbc:IdentificationCode Sección Códigos Geográficos
Post/tercero/guardarTercero1211No existe el Código ISO del paísEl servicio cancela el proceso. Se debe enviar un código ISO válido el cual esta descrito en el anexo 1.8 de factura electrónica de la DIAN tabla 13.4.1. Países (ISO 3166‐1): cbc:IdentificationCode Sección Códigos Geográficos
Post/tercero/guardarTercero1212Responsabilidad Fiscal vacíaEl Servicio por defecto asumirá la responsabilidad “R-99-PN”. Los valores que se pueden enviar estan descritos en el anexo 1.8 de factura electrónica de la DIAN tabla 13.2.6. Responsabilidades fiscales

Actualización 17/07/2022 -> 8.0.1.3

Se adicionan control de campo requerido celular e inicialización del tipo de operacion con valor por defecto 10 en la creación del tercero para el proceso de factura electrónica.

[
  {
    "nit" : "10262771440",
    "tipoDocumento": "1",
    "apellido1": "PALACINO",
    "apellido2": "VARGAS",
    "nombre1": "JHON",
    "nombre2": "ALEXANDER",
    "direccion": "CLL 54 C SUR  88 I 71 ",
    "codCiudad": "001",
    "codDepartamento": "50",
    "telefono": "3144518117",
    "celular": "3144518117",
    "email": "jhonpalacino0222@gmail.com",
    "tipoPersona": "1",
    "regimen": "N",
    "tipoVinculo": 29,
    "codPaisIso":"CO",//Nuevo Campo Código ISO 3611-1
    "fePostalZone": "500001",//Nuevo Campo Código Postal Colombia
    "feFiscalResponsability": "R-99-PN"//Nuevo Campo Responsabilidad Fiscal Anexo 1.8
    "feOperationType": "10"//Nuevo Campo Tipo operación valor por defecto 10
  }
]

Actualización Campo

HttpPathNombreTipo de DatoRequeridoValor por DefectoReglas de Validaciones
Post/tercero/guardarTerceroCelularStringSiN/ASi el campo es nulo o vacio se cancela el proceso y se visualiza mensaje con código de error 1213.

Nuevo Campo

HttpPathNombreTipo de DatoRequeridoValor por DefectoReglas de Validaciones
Post/tercero/guardarTercerofeOperationTypeStringNo10Si el campo es nulo o vacio se asumira el valor “10”.

Nuevo Código de Error (17/07/2022)

Se adicionan los siguientes códigos de errores:

HttpPathCódigo de ErrorDescripciónSolución
Post/tercero/guardarTercero1213Celular vacíoEl Servicio fallará la creación del tercero si no ingresa infromación en la columna celular.

Probar Servicio

Se recomienda utilizar la herramienta Postman por su facilidad de uso. Ver guia rápida Testando Servicio con Postman (Web)

Agregue un request y registre el servicio segu la imagen

Si el consumo es correcto se visualiza una respuesta como muestra la imagen

Si es errrado se visualiza una respuesta como muestra la imagen

←Volver atrás

1)
Se asume que el lector tiene conocimeintos previos del uso del lenguaje Java e IDE utilizado