Sistema de gestión de empresas

Entidades

Entidad	Descripción
Empresa	Contiene los datos básicos de una empresa.
DatosEntidad	Contiene los datos que identifican si la empresa es una entidad o una subentidad (sede, sucursal, ...) de otra entidad principal y de cuál concretamente.
DatosContacto	Contiene los datos de contacto de la empresa, a priori, únicamente la dirección postal.
DatosTipoEmpresa	Contiene 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), como puede ser por ejemplo su tamaño.
TipoIdentificador	Listado con los tipos de identificador fiscal (CIF, VAT, ...).
TipoEmpresa	Listado con los tipos de empresa (PYME, AAPP, ...).

Modelo lógico

API

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

Consultas filtradas y paginadas

Definición de los objetos

Empresa

Nombre	Tipo	Descripción
id	String	Identificador de la empresa.
nombre	String	Nombre de la empresa.
razonSocial	String	Razón social de la empresa.
tipoIdentificador	TipoIdentificador	Tipo de identificador fiscal de la empresa. Se devuelve la entidad TipoIdentificador con todos sus campos.
numeroIdentificacion	String	Número de identificación fiscal de la empresa del tipo indicado en "tipoIdentificador".

Empresa

{
    "id": "ent-002",
    "nombre": "Empresa de Prueba",
    "razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
    "tipoIdentificador": {
          "id":"tp-1",
          "nombre":"CIF"
     },
    "numeroIdentificacion": "H11111111"
}

TipoIdentificador

Nombre	Tipo	Descripción
id	String	Identificador de la entidad TipoIdentificador
nombre	String	Nombre (Posibles valores: CIF, VAT, ...)

TipoIdentificador

{ 
    "id":"tp-1",
    "nombre": "CIF"   
}

DatosEntidad

Nombre	Tipo	Descripción
tipoEntidad	String	Un valor dentro de los definidos en enumerado interno del SGI "TipoEntidad".
entidadPrincipal	Empresa	Entidad de tipo Empresa únicamente con los datos generales de la empresa principal de la que la empresa es subentidad. Solo estará informada si el valor de "tipoEntidad" se corresponde con el tipo "Subentidad".

DatosEntidad

{ 
	"tipoEntidad":"Subentidad",
    "entidadPrincipal": {
    	"id": "ent-002",
    	"nombre": "Empresa de Prueba",
    	"razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
    	"tipoIdentificador": {
          	"id":"tp-1",
          	"nombre":"CIF"
     	},
    	"numeroIdentificacion": "H11111111"
	}
}

DatosContacto

Nombre	Tipo	Descripción
direccionContacto	String	Dirección de contacto de la empresa

DatosContacto

{
    "direccionContacto": "C/ Uria número 4, puerta A"
}

DatosTipoEmpresa

Nombre	Tipo	Descripción
tipoEmpresa	TipoEmpresa	Tipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos.

DatosTipoEmpresa

{ 
    "tipoEmpresa": {
    	"id": "tem-002",
    	"nombre": "PYME"
	}
}

TipoEmpresa

Nombre	Tipo	Descripción
id	String	Identificador de la entidad TipoEmpresa.
nombre	String	Nombre (Posibles valores: PYME, AAPP, ...)

TipoEmpresa

{ 
    "id":"tem-001",
    "nombre": "AAPP"   
}

Servicios

Método	URL	Parámetros	Respuesta	Descripción
GET	/empresas	q+s (query + sort) La query estará formada por: nombre razonSocial numeroIdentificacion empresaRef	Lista[Empresa]	Listado de Empresa. Ejemplo: nombre=like=(Tree);(razonSocial=like=SL)
GET	/empresas/{empresaRef}	empresaRef	Empresa	Detalle de los datos generales de una empresa.
GET	/empresas/formly/create		Formly	Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos generales". Ver IU-GEN-0081 - Solicitar alta de empresa.
POST	/empresas	JSON		Recibe como parámetro la respuesta del usuario del formulario de datos básicos (formly) con los campos necesarios para crear una empresa.

GET	/datos-entidad/empresa/{empresaRef}	empresaRef	DatosEntidad	Detalle de los datos de entidad de una empresa (tipo de entidad, entidad principal en caso de ser una subentidad, etc).
GET	/datos-entidad/formly/create		Formly	Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos empresa". Ver IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de entidad.
POST	/datos-entidad	JSON		Recibe como parámetro la respuesta del usuario del formulario de datos de entidad (formly) con los campos necesarios para crear la entidad de datos de entidad de una empresa. En el formulario se deben de incluir el campo empresaRef para saber de qué empresa se trata (campo oculto).

GET	/datos-contacto/empresa/{empresaRef}	empresaRef	DatosContacto	Contiene la dirección de contacto de una empresa.
GET	/datos-contacto/formly/create		Formly	Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos contacto". Ver IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de contacto
POST	/datos-contacto	JSON		Recibe como parámetro la respuesta del usuario del formulario de datos contacto (formly) con los campos necesarios para crear los datos de contacto de una empresa. En el formulario se deben de incluir el campo empresaRef para saber de qué empresa se trata (campo oculto).

GET	/datos-tipo-empresa/empresa/{empresaRef}	empresaRef	DatosTipoEmpresa	Detalle de los datos de tipo de empresa de una empresa.
GET	/datos-tipo-empresa/formly/create		Formly	Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos de tipo de empresa". Ver IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de tipo de empresa
POST	/datos-tipo-empresa	JSON		Recibe como parámetro la respuesta del usuario del formulario de vinculación (formly) con los campos necesarios para los datos de tipo de empresa de la empresa. En el formulario se deben de incluir el campo empresaRef para saber de qué empresa se trata (campo oculto).

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

GET	/tipo-empresas		Lista[TipoEmpresa]	Listado de tipos de empresas ordenados alfabéticamente de forma ascendente.

Documentación API

http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml

Árbol de páginas

SGI - ESB - SGEMP

Sistema de gestión de empresas

Entidades

Modelo lógico

API

Definición de los objetos

Empresa

TipoIdentificador

DatosEntidad

DatosContacto

DatosTipoEmpresa

TipoEmpresa

Servicios

Documentación API