Árbol de páginas

Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

Método

URL

Parámetros

Respuesta

Descripción

GET/empresas

q+s (query + sort)

La query estará formada por:

  • id
  • nombreRazonSocial
  • nombre
  • razonSocial
  • numeroIdentificacion

Lista[Empresa]

Listado de Empresa.

Ejemplo:

nombreRazonSocial=like=SL

nombre=like=(Tree);(razonSocial=like=SL)

GET/empresas/{id}
EmpresaDetalle de los datos generales de una empresa.
POST/empresasJSON

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

Bloque de código
languagejava
themeRDark
titleDescripción de Json
collapsetrue
{
"tipoSedeId": <<Enumerado que contiene los valores 'Entidad' o '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 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": <<Télefono<<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>>
}
Bloque de código
languagejava
themeRDark
titleEjemplo de Json
collapsetrue
{
  "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"
}



PUT/empresasJSON

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

Bloque de código
languagejava
themeRDark
titleDescripción de Json
collapsetrue
{
"tipoSedeId": <<Enumerado que contiene los valores 'Entidad' o '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 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": <<Télefono<<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>>
}
Bloque de código
languagejava
themeRDark
titleEjemplo de Json
collapsetrue
{
  "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": "F",
  "tipoEmpresaId": "1",
  "tipoEmpresaContabilidadId": "1",
  "tipoTerceroReinoUnidoId": "S"
}



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}
DatosContactoContiene los datos de contacto de una empresa. 

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-via
Lista[TipoVia]Listado de tipos de via para la dirección de 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.