Hércules

Árbol de páginas

  • Creado por Usuario desconocido (alicia.alvarez), modificado por última vez en mar 25, 2022


Control de cambios


Leyenda

NuevoModificadoEliminado


Historial de cambios

FechaCambios

 

Adaptaciones a los cambios de operativa y campos para el alta de empresas con y sin datos económicos y a la nueva solicitud de modificación de las mismas.

 

Adaptaciones a la fusión de los campos nombre y razón social en un único campo, a los nuevos campos de datos de contacto, a la nueva asociación con sectores industriales, códigos CNAE o clasificaciones de tipo sector industrial (llamado indistintamente de las tres formas) y al nuevo campo de "Tipo de tercero Reino Unido" para entidades con datos económicos con dirección en Reino Unido.

 Se actualizan los siguientes servicios del API de empresas:

  • POST: Se cambia la definición a /empresas/formly.
  • PUT: Se cambia la definición a /empresas/formly/{id} y se añade en el JSON el campo empresaId para facilitar su identificación.

 

Eliminar de los servicios de este API el método para obtener el listado de tipos de vía y su entidad relacionada por trasladarse al API del SGO.

 

Modificar definición del objeto Empresa para separar los campos nombre y razón social y de la búsqueda para que pueda filtrar por ambos campos.

 

Se modificar el servicio del alta de empresa para que en el caso de que el servicio sea síncrono devuelva el id de la empresa creada.

 

Nuevo servicio para obtener las empresas modificadas o nuevas a partir de una fecha

Sistema de gestión de empresas

Entidades

Cambios

Se actualiza lista de entidades para:

  • Modificar la definición de las entidades DatosContacto y DatosTipoEmpresa para añadir nuevos campos.
  • Añadir las entidades TipoTercero y TipoEmpresaContabilidad.
  • Modificar el uso de la entidad TipoEmpresa para pasar a ser información de empresas con datos económicos.

 Se actualiza lista de entidades para:

  • Añadir las entidades TipoTerceroReinoUnido, TipoVia y EmpresaClasificacion.
  • Traducir nombrado de entidades por separación entre entidades internas al SGI y específicas de UM (Empresa, DatosContacto y EmpresaClasificacion).

Se actualiza la lista de entidades para:

  • Eliminar la entidad "TipoVia".
EntidadDescripción
Empresa (EmpresaUM)Contiene los datos básicos de una empresa.
DatosContacto (DatosContactoUM)Contiene los datos de contacto de la empresa.
DatosTipoEmpresaContiene los datos relativos a la tipología de la empresa, estando esta tipología basada en criterios diversos (los que se establezcan por parte de la universidad o sistema externo).
TipoIdentificadorListado con los tipos de identificador fiscal (CIF, VAT, ...).
TipoTerceroListado con los tipos de tercero (necesario para las empresas con datos económicos).
TipoEmpresaListado con los tipos de empresa (necesario para las empresas con datos económicos).
TipoEmpresaContabilidadListado con los tipos de empresa para contabilidad (necesario para las empresas con datos económicos).
TipoTerceroReinoUnidoListado con los tipos de tercero para Reino Unido (necesario para las empresas con datos económicos cuyo país es el Reino Unido).
EmpresaClasificacion (EmpresaUMClasificacion)Listado de relaciones entre empresas y clasificaciones. En principio, únicamente con las del tipo "Código CNAE" también llamado "Sector Industrial". Ver definición de clasificaciones en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO).

Modelo lógico

Cambios

Se actualiza el modelo para:

  • Añadir las entidades TipoTercero, TipoEmpresaContabilidad, Pais, ComunidadAutonoma y Provincia.
  • Modificar entidad DatosTipoEmpresa para incluir nuevos campos, tipoTercero y tipoEmpresaContabilidad, como referencia a las entidades TipoTercero y TipoEmpresaContabilidad.
  • Modificar el uso de la entidad TipoEmpresa para pasar a ser información de empresas con datos económicos.
  • Modificar entidad DatosContacto para incluir nuevos campos, paisContacto, comunidadContacto, provinciaContacto como referencia a entidades Pais, ComunidadAutonoma y Provincia y los campos ciudadContacto y direccionWeb.
  • Modificar entidad Empresa para:
    • Incluir el nuevo campo padreId que hace referencia a la empresa que hace de entidad principal en el caso de empresas que son subentidad de otra.
    • Incluir el nuevo campo datosEconomicos para indicar si se trata de una empresa con datos económicos (está dada de alta en GENTE y en JUSTO) o sin datos económicos (está dada de alta solo en GENTE).

 Se actualiza el modelo para:

  • Añadir las entidades TipoTerceroReinoUnido, TipoVia y EmpresaClasificacionUM.
  • Renombrar entidades Empresa y DatosContacto por separación entre entidades internas al SGI y específicas de UM.
  • Modificar Empresa para usar un único campo entidadRazonSocial para gestionar el nombre y/o la razón social de la empresa.
  • Modificar DatosTipoEmpresa para incluir el nuevo campo tipoTerceroReinoUnido que hace referencia al tipo de tercero a seleccionar cuando el país es Reino Unido.
  • Modificar DatosContacto para:
    • Añadir los siguientes campos:
      • codigoPostal.
      • tipoVia como referencia a la entidad TipoVia.
      • nombreVia, sustituye a direccionContacto.
      • numero.
      • ampliacion.
      • email.
      • fax.
      • telefono.
    • Renombrar los campos paisContacto, comAutonomaContacto, provinciaContacto y ciudadContacto eliminando la palabra "Contacto".
  • Modificar TipoTercero para incluir la clase de tercero.

 Se actualiza el modelo para:

  • Reflejar el cambio de la entidad TipoVia al modelo del SGO.

 Modificar definición de la entidad Empresa para separar los campos nombre y razón social.

API

Características generales que todas las API REST deben de cumplir:

Definición de los objetos

Cambios

Se actualiza la definición de objetos para:

  • Añadir los objetos TipoTercero, TipoEmpresa, TipoEmpresaContabilidad y las referencias a los objetos del SGO Pais, ComunidadAutonoma y Provincia.
  • Modificar objeto DatosTipoEmpresa para incluir nuevos campos, tipoTercero y tipoEmpresaContabilidad, como referencia a los objetos TipoTercero y TipoEmpresaContabilidad.
  • Modificar el uso del objeto TipoEmpresa para pasar a ser información de empresas con datos económicos.
  • Modificar objeto DatosContacto para incluir nuevos campos, paisContacto, comunidadContacto, provinciaContacto, como referencia a los objetos Pais, ComunidadAutonoma y Provincia y los campos ciudadContacto y direccionWeb.
  • Modificar objeto Empresa para:
    • Incluir el nuevo campo padreId que hace referencia a la empresa que hace de entidad principal en el caso de empresas que son subentidad de otra.
    • Incluir el nuevo campo datosEconomicos para indicar si se trata de una empresa con datos económicos (está dada de alta en GENTE y en JUSTO) o sin datos económicos (está dada de alta solo en GENTE).

 

  • Añadir los objetos TipoTerceroReinoUnido, TipoVia y EmpresaClasificacion.
  • Modificar Empresa para usar un único campo entidadRazonSocial para gestionar el nombre y/o la razón social de la empresa.
  • Modificar DatosTipoEmpresa para incluir el nuevo campo tipoTerceroReinoUnido que hace referencia al tipo de tercero a seleccionar cuando el país es Reino Unido.
  • Modificar DatosContacto para:
    • Añadir los siguientes campos:
      • codigoPostal.
      • tipoVia como referencia a la entidad TipoVia.
      • nombreVia, sustituye a direccionContacto.
      • numero.
      • ampliacion.
      • email.
      • fax.
      • telefono.
    • Renombrar los campos paisContacto, comAutonomaContacto, provinciaContacto y ciudadContacto eliminando la palabra "Contacto".
  • Modificar TipoTercero para incluir la clase de tercero.

 Se actualiza la definición de objetos para:

  • Eliminar el objeto TipoVia del modelo propio e indicar cómo obtenerlo del SGO en DatosContacto.

 Se actualiza la definición de objetos para:

  • Modificar el objeto Empresa para separar los campos nombre y razón social.

Empresa


NombreTipoDescripción
idStringIdentificador de la empresa.
nombreStringNombre de la empresa. Se devolverá lo mismo que en el campo "razonSocial".
razonSocialStringRazón social de la empresa. Se devolverá lo mismo que en el campo "nombre".
tipoIdentificadorTipoIdentificadorTipo de identificador fiscal de la empresa. Se devuelve la entidad TipoIdentificador con todos sus campos.
numeroIdentificacionStringNúmero de identificación fiscal de la empresa del tipo indicado en "tipoIdentificador".
datosEconomicosBooleanIndicador de si se trata de una empresa con datos económicos (está dada de alta en GENTE y en JUSTO) o sin datos económicos (está dada de alta solo en GENTE).
padreIdStringIdentificador de la empresa padre o entidad principal. Estará informado en el caso de empresas que son subentidad de otra.
Empresa 
{
    "id": "ent-002",
    "nombre": "Empresa de Prueba",
    "razonSocial": "Empresa de Prueba",
    "tipoIdentificador": {
          "id":"tp-1",
          "nombre":"CIF"
     },
    "numeroIdentificacion": "H11111111",
    "datosEconomicos": false,
	"padreId": "ent-001"
}

TipoIdentificador

NombreTipoDescripción
idStringIdentificador de la entidad TipoIdentificador.
nombreStringNombre (Posibles valores: CIF, VAT, ...).
TipoIdentificador 
{ 
    "id":"tp-1",
    "nombre": "CIF"   
}

DatosTipoEmpresa

NombreTipoDescripción
tipoTerceroTipoTerceroTipo de tercero. Se devuelve la entidad TipoTercero con todos sus campos.
tipoEmpresaTipoEmpresaTipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos.
tipoEmpresaContabilidadTipoEmpresaContabilidadTipo de tercero. Se devuelve la entidad TipoEmpresaContabilidad con todos sus campos.
tipoTerceroReinoUnidoTipoTerceroReinoUnidoTipo de tercero para personas físicas (personas actuando como empresas) con dirección en el Reino Unido. Se devuelve la entidad TipoTerceroReinoUnido con todos sus campos.
DatosTipoEmpresa 
{ 
	"tipoTercero": {
    	"id":"tt-1",
    	"nombre": "Personas jurídicas españolas"   
	},
	"tipoEmpresa": {
    	"id":"te-1",
    	"nombre": "Empr. extranjeras"   
	},  
	"tipoEmpresaContabilidad": {
    	"id":"tec-1",
	    "nombre": "Otros entes del sector público, empresa o institución privada"   
	},
	"tipoTerceroReinoUnido": {
    	"id":"IN",
	    "nombre": "Tercero de Irlanda del Norte" 
	}
}

TipoTercero

NombreTipoDescripción
idStringIdentificador de la entidad TipoTercero.
nombreStringNombre.
claseStringClase de tercero Reino Unido. Posibles valores: F (Persona física), J (Persona jurídica).
TipoTercero 
{ 
    "id":"tt-1",
    "nombre": "Personas jurídicas: españolas",
	"clase": "J"
}

TipoEmpresa

NombreTipoDescripción
idStringIdentificador de la entidad TipoEmpresa.
nombreStringNombre. 
TipoEmpresa 
{ 
    "id":"te-1",
    "nombre": "Empr. extranjeras"   
}

TipoEmpresaContabilidad

NombreTipoDescripción
idStringIdentificador de la entidad TipoEmpresaContabilidad.
nombreStringNombre.
TipoEmpresaContabilidad 
{ 
    "id":"tec-1",
    "nombre": "Otros entes del sector público, empresa o institución privada"   
}

TipoTerceroReinoUnido

NombreTipoDescripción
idStringIdentificador de la entidad TipoTerceroReinoUnido. Posibles valores: S (Tercero normal), IN (Tercero de Irlanda del Norte).
nombreStringNombre. Posibles valores: Tercero normal (S), Tercero de Irlanda del Norte (IN).
TipoTerceroReinoUnido 
{ 
    "id":"IN",
    "nombre": "Tercero de Irlanda del Norte"
}

EmpresaClasificacion

NombreTipoDescripción
idStringIdentificador de la clasificación.
codigoStringCódigo de la clasificación.
nombreStringNombre de la clasificación.
padreIdStringIdentificador de la entidad padre de la clasificación.
Empresa-Clasificación padre 
   {
        "id": "1",
        "codigo": "01"
        "nombre":"Cultivos no perennes",
        "padreId": null
    }
Empresa-Clasificación hija de primer nivel 
   {
        "id": "2",
		"codigo": "0112"
        "nombre":"Cultivo de arroz", 
        "padreId": "1"
    }

DatosContacto


NombreTipoDescripción
paisContactoPais

Se devuelve la entidad Pais con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO).

comAutonomaContactoComunidadAutonoma

Se devuelve la entidad ComunidadAutonoma con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO).

provinciaContactoProvincia

Se devuelve la entidad Provincia con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO).

ciudadContactoStringCiudad de contacto de la empresa.

codigoPostal

StringCódigo postal de la empresa.
tipoViaTipoViaTipo de vía de la dirección de contacto de la empersa. Se devuelve la entidad TipoVia con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO).
nombreViaStringNombre de la vía de la dirección de contacto de la empresa.
numeroStringNúmero de la vía de la dirección de contacto de la empresa.
ampliacionStringCampo para ampliar la informaicón de la dirección de contacto de la empresa.
emailStringEmail de contacto de la empresa.
faxStringFax de contacto de la empresa.
telefonoStringTeléfono de contacto de la empresa.
direccionWebStringDirección web de la empresa.



DatosContacto 
{
	"paisContacto": {
       "id":"33",
       "nombre":"España"
     },
    "comAutonomaContacto": {
       "id":"ca-3",
       "nombre":"Asturias"
     }, 
    "provinciaContacto": {
       "id":"pro-1",
       "nombre":"Asturias"
     }, 
	"ciudadContacto": "Oviedo",
	"codigoPostal": "33002",
	"tipoVia": {
       "id":"tv-1",
       "nombre":"Calle"
     },
    "nombreVia": "Uría",
    "numero": "4",
	"ampliacion": "puerta A",
	"email": "email@empresadeprueba.es",
	"fax": "985798765",
	"telefono": "985798766",
	"direccionWeb": "www.empresadeprueba.es"
}

Servicios

Cambios

Se actualizan los servicios API para:

  • Modificar el funcionamiento del método POST de alta de empresa, ahora recibirá más información, toda la indicada por la UM para el alta (recogida en la pantalla de Alta de Empresa).
  • Crear 4 nuevos métodos:
    • Solicitar la modificación de los datos de Empresa.
    • Obtener todos los datos de una empresa en JSON para pintar tanto en la pantalla de Modificación como en el Ver Detalle.
    • Obtener listado de tipos de terceros.
    • Obtener listado de tipos de empresa para contabilidad.
  • Eliminar todos los métodos de alta parcial de datos de Empresa por secciones.

 Se actualizan los servicios API para:

  • Modificar el funcionamiento del método GET de búsqueda y filtrado de empresas para fundir en un solo campo el filtro por nombre y/o razón social.
  • Añadir 3 métodos:
    • Obtener el listado de clasificaciones de códigos CNAE asociados a una empresa.
    • Obtener el listado de tipos de vía para seleccionar en la dirección de una empresa.
    • Obtener el listado de tipos de terceros para Reino Unido para asociar a empresas con datos económicos

 Se actualizan los siguientes servicios del API de empresas:

  • POST: Se cambia la definición a /empresas/formly.
  • PUT: Se cambia la definición a /empresas/formly/{id} y se añade en el JSON el campo empresaId para facilitar su identificación.

Se actualiza la lista de servicios del API para:

  • Eliminar el servicio /tipos-via

 Se actualiza la lista de servicios del API para:

  • Modificar el funcionamiento del método GET de búsqueda y filtrado de empresas para separar en dos campos el filtro por nombre y/o razón social y que sean por nombre y razón social independientes.

Se modificar el servicio del alta de empresa para que en el caso de que el servicio sea síncrono devuelva el id de la empresa creada.

  • POST /empresas/formly

Nuevo servicio para obtener las empresas modificadas o nuevas a partir de una fecha

  • GET /empresas/modificadas-ids

Método

URL

Parámetros

Respuesta

Descripción

GET/empresas

q+s (query + sort)

La query estará formada por:

  • id
  • nombre
  • razonSocial
  • numeroIdentificacion

Lista[Empresa]

Listado de Empresa.

Ejemplo:

nombre=like=SL, razonSocial=like=SL

GET/empresas/{id}
Empresa

Detalle de los datos generales de una empresa.

POST/empresas/formlyJSON

id

Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona.

Recibe como parámetro la respuesta del usuario del formulario de datos de alta (formly) con los campos necesarios para crear una empresa.

Ejemplo de JSON 
{
  "tipoSedeId": "1",
  "datosEconomicos": false,
  "entidadRazonSocial": "Entidad",
  "tipoIdentificadorFiscalId": "2",
  "numeroIdentificadorFiscal": "12312312",
  "sectoresIndustriales": [
    "4",
    "5"
  ],
  "paisContactoId": "1",
  "codigoPostalContacto": "48152",
  "ciudadContacto": "Madrid",
  "tipoViaContactoId": "1",
  "nombreViaContacto": "Gran vía",
  "numeroViaContacto": "234",
  "ampliacion": "ampliación",
  "email": "email@prueba.com",
  "telefonoContacto": "66612345",
  "faxContacto": "915551234",
  "direccionWeb": "http://www.prueba.com",
  "tipoTerceroId": "F",
  "tipoEmpresaId": "1",
  "tipoEmpresaContabilidadId": "1",
  "tipoTerceroReinoUnidoId": "S"
}
  • tipoSedeId: 0 para tipo 'Entidad' y 1 para tipo 'Subentidad'
  • datosEconomicos: true | false
  • entidadRazonSocial: Descripción de la entidad o razón social
  • tipoIdentificadorFiscalId: Id de tipo de identificador fiscal procedente del endpoint /tipos-identificador
  • numeroIdentificadorFiscal: Nº de identificador fiscal
  • sectoresIndustriales:  Array de ids de clasificaciones CNAE procedentes de /empresas-clasificaciones/empresa/{id}
  • paisContactoId: Id de pais de contacto procedente de endpoint /paises. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO)
  • codigoPostalContacto: Código postal de dirección de contacto
  • ciudadContacto: Ciudad de contacto
  • tipoViaContactoId: Id de tipo de vía de contacto procedente de endpoint /tipos-via
  • nombreViaContacto: Nombre de vía de contacto
  • numeroViaContacto: Número de dirección de contacto
  • ampliacion: Descripción de ampliación
  • email: Email de contacto
  • telefonoContacto: Teléfono de contacto
  • faxContacto: Fax de contacto
  • direccionWeb: Web de contacto
  • tipoTerceroId: Id de tipo de tercero procedente de endpoint /tipos-tercero
  • tipoEmpresaId: Id de tipo de empresa procedente de endpoint /tipos-empresa
  • tipoEmpresaContabilidadId: Id de tipo de empresa contabilidad procedente de endpoint /tipos-empresa-contabilidad
  • tipoTerceroReinoUnidoId: Id de tipo de tercero reino unido procedente de endpoint /tipos-tercero-reino-unido
PUT/empresas/formly/{id}JSON

Recibe como parámetro la respuesta del usuario del formulario de datos de modificación (formly) con los campos necesarios para actualizar una empresa.


Ejemplo de JSON 
{
  "empresaId": "1",
  "tipoSedeId": "1",
  "datosEconomicos": false,
  "entidadRazonSocial": "Entidad",
  "tipoIdentificadorFiscalId": "2",
  "numeroIdentificadorFiscal": "12312312",
  "entidadPrincipal": "entidad principal",
  "sectoresIndustriales": [
    "4",
    "5"
  ],
  "paisContactoId": "1",
  "codigoPostalContacto": "48152",
  "ciudadContacto": "Madrid",
  "tipoViaContactoId": "1",
  "nombreViaContacto": "Gran vía",
  "numeroViaContacto": "234",
  "ampliacion": "ampliación",
  "email": "email@prueba.com",
  "telefonoContacto": "66612345",
  "faxContacto": "915551234",
  "direccionWeb": "http://www.prueba.com",
  "tipoTerceroId": "1",
  "tipoEmpresaId": "1",
  "tipoEmpresaContabilidadId": "1",
  "tipoTerceroReinoUnidoId": "S"
}
  • empresaId: Id de la empresa
  • tipoSedeId: 0 para tipo 'Entidad' y 1 para tipo 'Subentidad'
  • datosEconomicos: true | false
  • entidadRazonSocial: Descripción de la entidad o razón social
  • tipoIdentificadorFiscalId: Id de tipo de identificador fiscal procedente del endpoint /tipos-identificador
  • numeroIdentificadorFiscal: Nº de identificador fiscal
  • entidadPrincipal: Nombre de entidad principal
  • sectoresIndustriales:  Array de ids de clasificaciones CNAE procedentes de /empresas-clasificaciones/empresa/{id}
  • paisContactoId: Id de pais de contacto procedente de endpoint /paises. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO)
  • codigoPostalContacto: Código postal de dirección de contacto
  • ciudadContacto: Ciudad de contacto
  • tipoViaContactoId: Id de tipo de vía de contacto procedente de endpoint /tipos-via
  • nombreViaContacto: Nombre de vía de contacto
  • numeroViaContacto: Número de dirección de contacto
  • ampliacion: Descripción de ampliación
  • email: Email de contacto
  • telefonoContacto: Teléfono de contacto
  • faxContacto: Fax de contacto
  • direccionWeb: Web de contacto
  • tipoTerceroId: Id de tipo de tercero procedente de endpoint /tipos-tercero
  • tipoEmpresaId: Id de tipo de empresa procedente de endpoint /tipos-empresa
  • tipoEmpresaContabilidadId: Id de tipo de empresa contabilidad procedente de endpoint /tipos-empresa-contabilidad
  • tipoTerceroReinoUnidoId: Id de tipo de tercero reino unido procedente de endpoint /tipos-tercero-reino-unido
GET/empresas/formly/{id}
JSON

Devuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly). Se recibirá el mismo json que en la solicitud de modificación de empresa (/empresas PUT)


GET/datos-contacto/empresa/{id}
DatosContacto

Contiene los datos de contacto de una empresa. 

Ver UM - SGI - ESB - SGEMP - Adaptaciones integración para su implementación en el SGI.


GET/empresas-clasificaciones/empresa/{id}
EmpresaClasificacionListado de las clasificaciones de tipo códigos CNAE o sectores industriales asociados a una empresa. 

GET/datos-tipo-empresa/empresa/{id}
DatosTipoEmpresaDetalle de los datos de tipo de empresa de una empresa.

GET/tipos-identificador
Lista[TipoIdentificador]Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente.

GET/tipos-tercero
Lista[TipoTercero]Listado de tipos de tercero ordenados alfabéticamente de forma ascendente.
GET/tipos-empresa
Lista[TipoEmpresa]Listado de tipos de empresa ordenados alfabéticamente de forma ascendente.
GET/tipos-empresa-contabilidad
Lista[TipoEmpresaContabilidad]Listado de tipos de empresa para contabilidad ordenados alfabéticamente de forma ascendente.
GET/tipos-tercero-reino-unido
Lista[TipoTerceroReinoUnido]Listado de tipos de tercero, en caso de que el país sea Reino Unido, ordenados alfabéticamente de forma ascendente.

Métodos donde el SGI solo hace de pasarela entre Universidad y CVN
GET/empresas/modificadas-ids

q+s

La query estará formada por:

  • fechaModificacion
Lista[String]Listado de los identificadores de empresas que han sufrido cambios en los datos de identificativos de la empresa o en sus datos de contacto (entidad Empresa y entidad DatosContacto)
  • Sin etiquetas