...
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. |
| TipoIdentificador | Listado con los tipos de identificador fiscal (CIF, VAT, ...). |
| EmpresaClasificacion | Listado |
| de relaciones entre empresas y clasificaciones. Las empresas se relacionarán únicamente con las clasificaciones del tipo "Sector Industrial". Ver definición de clasificaciones en SGI - ESB - SGO. |
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
...
| 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. |
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "ent-002",
"nombre": "Empresa de Prueba",
"tipoIdentificador": {
"id":"tp-1",
"nombre":"CIF"
},
"numeroIdentificacion": "H11111111",
"razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
"datosEconomicos": false,
"padreId": "ent-001"
} |
TipoIdentificador
| Nombre | Tipo | Descripción |
|---|---|---|
| id | String | Identificador de la entidad TipoIdentificador. |
| nombre | String | Nombre (Posibles valores: CIF, VAT, ...). |
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id":"tp-1",
"nombre": "CIF"
} |
DatosTipoEmpresa
| tipoTercero | TipoTercero | Tipo de tercero. Se devuelve la entidad TipoTercero con todos sus campos.||||
| tipoEmpresaContabilidad | TipoEmpresaContabilidad | Tipo de tercero. Se devuelve la entidad TipoEmpresaContabilidad con todos sus campos. |
...
| language | java |
|---|---|
| theme | RDark |
| title | DatosTipoEmpresa |
| collapse | true |
...
...
TipoTercero
...
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id":"tt-1",
"nombre": "Personas jurídicas españolas"
} | ||||||||
TipoEmpresa
...
...
{
"id":"te-1",
"nombre": "Empr. extranjeras"
}TipoEmpresaContabilidad
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id":"tec-1",
"nombre": "Otros entes del sector público, empresa o institución privada"
} |
DatosContacto
| Nombre | Tipo | Descripción |
|---|
Se devuelve la entidad Pais con todos sus campos. Ver definición en SGI - ESB - SGO.
Se devuelve la entidad ComunidadAutonoma con todos sus campos. Ver definición en SGI - ESB - SGO.
Se devuelve la entidad Provincia con todos sus campos. Ver definición en SGI - ESB - SGO.
| direccion | String | Dirección de contacto |
| de la empresa. |
| Bloque de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"paisContactodireccion": {
"id":"33",
"nombre":"España"
},
"comAuntonomaContacto": {
"id":"ca-3",
"nombre":"Asturias"
},
"provinciaContacto": {
"id":"pro-1",
"nombre":"Asturias"
},
"ciudadContacto": "Oviedo",
"direccionContacto": "C/ Uría número 4, puerta A",
"direccionWeb": "www.empresadeprueba.es"
"C/ Uría, número 4, puerta A, 33002, Oviedo, Asturias, España"
} |
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 | /tipos-identificador | Lista[TipoIdentificador] | Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente. | |