Sistema de gestión de empresas
Entidades
Entidad | Descripción |
---|---|
Empresa | Contiene los datos básicos de una empresa. |
DatosContacto | Contiene los datos de contacto de la empresa. |
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, ...). |
TipoTercero | Listado con los tipos de tercero (necesario para las empresas con datos económicos). |
TipoEmpresa | Listado con los tipos de empresa (necesario para las empresas con datos económicos). |
TipoEmpresaContabilidad | Listado con los tipos de empresa para contabilidad (necesario para las empresas con datos económicos). |
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
Definición de los objetos
Empresa
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la empresa. |
nombre | String | Nombre 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". |
razonSocial | String | Razón social de la empresa. |
datosEconomicos | Boolean | Indicador 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). |
padreId | String | Identificador de la empresa padre o entidad principal. Estará informado en el caso de empresas que son subentidad de otra. |
TipoIdentificador
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad TipoIdentificador. |
nombre | String | Nombre (Posibles valores: CIF, VAT, ...). |
DatosTipoEmpresa
Nombre | Tipo | Descripción |
---|---|---|
tipoTercero | TipoTercero | Tipo de tercero. Se devuelve la entidad TipoTercero con todos sus campos. |
tipoEmpresa | TipoEmpresa | Tipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos. |
tipoEmpresaContabilidad | TipoEmpresaContabilidad | Tipo de tercero. Se devuelve la entidad TipoEmpresaContabilidad con todos sus campos. |
TipoTercero
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad TipoTercero. |
nombre | String | Nombre. |
TipoEmpresa
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad TipoEmpresa. |
nombre | String | Nombre. |
TipoEmpresaContabilidad
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad TipoEmpresaContabilidad. |
nombre | String | Nombre. |
DatosContacto
Nombre | Tipo | Descripción |
---|---|---|
paisContacto | Pais | Se devuelve la entidad Pais con todos sus campos. Ver definición en SGI - ESB - SGO. |
comAuntonomaContacto | ComunidadAutonoma | Se devuelve la entidad ComunidadAutonoma con todos sus campos. Ver definición en SGI - ESB - SGO. |
provinciaContacto | Provincia | Se devuelve la entidad Provincia con todos sus campos. Ver definición en SGI - ESB - SGO. |
ciudadContacto | String | Ciudad de contacto de la empresa. |
direccionContacto | String | Dirección de contacto de la empresa. |
direccionWeb | String | Dirección web de la empresa. |
Servicios
Método | URL | Parámetros | Respuesta | Permisos | Descripción |
---|---|---|---|---|---|
GET | /empresas | q+s (query + sort) La query estará formada por:
| Lista[Empresa] | Listado de Empresa. Ejemplo: nombre=like=(Tree);(razonSocial=like=SL) | |
GET | /empresas/{id} | id | 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 de alta (formly) con los campos necesarios para crear una empresa. | ||
PUT | /empresas | 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. | ||
GET | /empresas/formly/{id} | JSON | Devuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly). | ||
GET | /datos-contacto/empresa/{id} | id | DatosContacto | Contiene los datos de contacto de una empresa. | |
| |||||
GET | /datos-tipo-empresa/empresa/{id} | id | DatosTipoEmpresa | Detalle 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. |