...
Entidad | Descripción |
---|
Empresa | Contiene los datos básicos de una empresa. |
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, ...). |
TipoTercero | Listado con los tipos de tercero (necesario para las empresas con datos económicos). |
TipoEmpresa | Listado con los tipos de empresa (PYME, Microempresa, ...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
Image Modified
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 |
---|
language | java |
---|
theme | RDark |
---|
title | Empresa |
---|
collapse | true |
---|
|
{
"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 |
---|
language | java |
---|
theme | RDark |
---|
title | TipoIdentificador |
---|
collapse | true |
---|
|
{
"id":"tp-1",
"nombre": "CIF"
} |
DatosContacto
DatosTipoEmpresa
...
|
---|
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 |
...
Bloque de código |
---|
language | java |
---|
theme | RDark |
---|
title |
---|
|
...
DatosTipoEmpresa | collapse | true |
---|
|
{
|
...
"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"
}
} |
TipoTercero
...
tipoEmpresaTipoEmpresaTipo empresa. Se devuelve la entidad TipoEmpresa con todos sus camposla entidad TipoTercero. |
nombre | String | Nombre. |
Bloque de código |
---|
language | java |
---|
theme | RDark |
---|
title | DatosTipoEmpresaTipoTercero |
---|
collapse | true |
---|
|
{
"id":"tt-1",
"nombre": "Personas jurídicas españolas"
} |
TipoEmpresa
Nombre | Tipo | Descripción |
---|
id | String | Identificador de la entidad TipoEmpresa. |
nombre | String | Nombre. |
Bloque de código |
---|
language | java |
---|
theme | RDark |
---|
title | TipoEmpresa |
---|
collapse | true |
---|
|
{ "tipoEmpresa": {
"id": "temte-0021",
"nombre": "PYME"
}Empr. extranjeras"
} |
...
TipoEmpresaContabilidad
Nombre | Tipo | Descripción |
---|
id | String | Identificador de la entidad |
...
TipoEmpresaContabilidad. |
nombre | String | Nombre |
...
Bloque de código |
---|
language | java |
---|
theme | RDark |
---|
title | TipoEmpresaContabilidad |
---|
collapse | true |
---|
|
{
"id":"tec-1",
"nombre": "Otros entes del sector público, empresa o institución privada"
} |
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. |
Bloque de código |
---|
language | java |
---|
theme | RDark |
---|
title |
---|
|
...
DatosContacto | collapse | true |
---|
|
{
"paisContacto": {
"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"
} |
Servicios
Método | URL | Parámetros | Respuesta | Permisos | 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=(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 |
básicos 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 |
. En principio, únicamente la dirección de contacto. |
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 id de Empresa para saber de qué empresa se trata (campo oculto). |
|
GET | /datos-tipo-empresa/empresa/{id} | id | 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 id de Empresa para saber de qué empresa se trata (campo oculto). |
|
|
|
|
|
|
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. |
Documentación API
http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml