Sistema de Gestión Económica de Protección Industrial e Intelectual

Entidades

Hay entidades que se reutilizan del modelo de Ejecución económica del SGE y pero se repiten aquí por claridad aunque ya están descritas en el API del SGE: SGI - ESB - SGE - Ejecución económica.

Entidad	Descripción
DatoEconomico	Entidad que representa cualquier dato económico. Tendrá que venir identificado por un identificador único, por el proyecto al que pertenece, anualidad, partida presupuestaria y un código económico (opcional en algunos de los casos). El resto de campos del dato económico se tratarán como columnas dinámicas. Se indicará por cada columna el identificador del campo, el nombre del campo y si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador.
Columna	Contiene el listado de columnas que serán mostradas en las pantallas del SGI dependiendo de la pantalla en la que se esté: gastos o repartos. Por cada columna se tendrá el identificador del campo, el nombre del campo, si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador, que, a los efectos de esta integración para las invenciones, equivaldría a identificar dicha columna como de tipo numéricos y si es la columna (solo puede haber una) que se ha de utilizar para hacer el cálculo del importe a deducir en los repartos de regalías.
DatoEconomicoDetalle	Entidad que representa el detalle de un dato económico con todos sus campos para mostrarlo en una pantalla de consulta del dato económico. Tendrá unos campos fijos (identificador único, identificador del proyecto al que pertenece, anualidad, partida presupuestaria y un código económico) y unos campos dinámicos. Por cada campo se detallará el nombre y el valor del campo para mostrarlo en la pantalla del SGI
Invencion	Entidad que representa a la invención cara a poder ser presentada en listas de valores con su título.

Enumerados

Entidad

Descripción

TipoDatoEconomico

Puede tomar los siguientes valores:

Ingreso
Gasto

TipoOperacion

Puede tomar los siguientes valores:

GAS
REP

Modelo lógico

API

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

Definición de los objetos

Hay objetos que se reutilizan del modelo de Ejecución económica del SGE y por tanto no se repiten aquí, están descritos en el API del SGE: UM - SGI - ESB - SGE - Ejecución económica.

Invencion

Nombre	Tipo	Descripción
id	String	Identificador único de la invención.
titulo	String	Título de la invención.

DatoEconomico

Nombre	Tipo	Descripción
id	String	Identificador del dato económico. Tiene que ser un identificador único.
tipo	String	Dos valores: Gasto Ingreso
columnas	Map[clave,valor]	Mapa de propiedades. El valor será un String salvo en aquellas columnas que sean acumulables (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI).

DatoEconomicoDetalle

Nombre	Tipo	Descripción
id	String	Identificador del dato económico. Tiene que ser un identificador único.
documentos	Lista[Documento]	Lista de documentos asociados al gasto (sin el contenido binario del fichero).

Columna

Nombre	Tipo	Descripción
id	String	Identificador de la columna
nombre	String	Nombre de la columna
acumulable	Boolean	Indica si la columna se puede sumar y por extensión, además indica que es numérica. Dos valores: true false
importeReparto	Boolean	Indica que la columna se corresponde con el importe que se quiere tener en cuenta a la hora de calcular el reparto de regalías. SOLO UNA COLUMNA PODRÁ TENER ESTE CAMPO ACTIVO. Dos valores: true false

Documento (se reutilizaría el mismo que el definido en UM - SGI - ESB - SGE - Ejecución económica)

Nombre	Tipo	Descripción
id	String	Identificador único del documento
nombre	String	Nombre del documento a mostrar
nombreFichero	String	Nombre del fichero con extensión

Servicios

Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sge-pii, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso.

Hay servicios a los que no se hace mención en este API porque la funcionalidad que los precisa, por ejemplo, la recuperación del binario de cada documento asociado a un gasto, ha de reutilizar los que ya están definidos en el modelo de Ejecución económica del SGE y por tanto no se repiten aquí, están descritos en el API del SGE: UM - SGI - ESB - SGE - Ejecución económica.

Servicio	Método	URL	Parámetros	Respuesta	Descripción
SGI - ESB - SGEPII - Buscar ingresos	GET	/ingresos-invencion	q+s (query + sort) La query estará formada por: proyectoId	Lista[DatoEconomico]	Listado de todos los ingresos asociados a una invención. La asociación en el SGI se realizará a través de contratos de CSP (proyectos) y el identificador de proyecto a enviar al SGE ha de ser el del proyecto económico en Justo. Los ingresos devueltos se corresponderán con las facturas emitidas asociadas a la invención a través del contrato. Para cada ingreso se devolverán los siguientes datos: Identificador del ingreso Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /ingresos-pii/columnas y el valor será el valor de la columna. El valor será un String salvo en aquellas columnas que sean acumulables, esto es, se puedan manejar como un importe y hacer operaciones numéricas con ella en el SGI, donde será de tipo Numérico (sin separador de miles y como separador decimal el punto).
SGI - ESB - SGEPII - Buscar columnas de ingresos	GET	/ingresos-invencion/columnas	q+s (query + sort) La query estará formada por: proyectoId	Lista[Columna]	Listado con las columnas que va a devolver la llamada /ingresos-invencion. El identificador de proyecto a enviar al SGE ha de ser el del proyecto económico en Justo. Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI). Por defecto, devolverá las siguientes columnas: Fecha Referencia Importe (acumulable = Sí) Nº interno de contrato Entidad pagadora
SGI - ESB - SGEPII - Buscar gastos	GET	/gastos-invencion	q+s (query + sort) La query estará formada por: invencionId tipoOperacion El tipo de operación puede tomar los siguientes valores: GAS (Ejecución económica - Gastos) REP (Ejecución económica - Repartos - Gastos a deducir)	Lista[DatoEconomico]	Listado de todos los gastos asociados a una invención. Para cada gasto se devolverán los siguientes datos: Identificador del gasto Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /gastos-invencion/columnas y el valor será el valor de la columna. El valor será un String salvo en aquellas columnas que sean acumulables, esto es, se puedan manejar como un importe y hacer operaciones numéricas con ella en el SGI, donde será de tipo Numérico (sin separador de miles y como separador decimal el punto). Si el tipo de operación se informa con el valor GAS, se han de devolver todos los gastos asociados a la invención. Si por el contrario el tipo de operación es REP, se han de devolver del conjunto de gastos asociados a la invención únicamente aquellos que se deban tener en cuenta para el reparto de regalías.
SGI - ESB - SGEPII - Buscar columnas gastos	GET	/gastos-invencion/columnas	q+s (query + sort) La query estará formada por: invencionId	Lista[Columna]	Listado con las columnas que va a devolver la llamada /gastos-invencion. Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI). Por defecto, devolverá las siguientes columnas: Fecha Referencia Concepto Tipo Importe (acumulable = Sí SOLO para una de las columnas)
SGI - ESB - SGEPII - Consultar detalle de gasto	GET	/gastos-invencion/{id}	q+s (query + sort) La query estará formada por: invencionId tipoOperacion El tipo de operación puede tomar los siguientes valores: GAS (Ejecución económica - Gastos) REP (Ejecución económica - Repartos - Gastos a deducir)	DatoEconomicoDetalle	Detalle de un gasto. Para cada gasto se devolverán los siguientes datos: Identificador del gasto. Listado de documentos (identificador, nombre del documento y nombre del fichero, sin el contenido).

Columnas Gastos

id	nombre	acumulable	descripción
1	Fecha	false	Fecha de emisión
2	Referencia	false	Nº / año factura
3	Concepto	false	Descripción de factura
4	Tipo	false	Tipo de gasto
5	Importe	true	Base imponible

Columnas Ingresos

id	nombre	acumulable	descripción
1	Fecha	false	Fecha de emisión
2	Referencia	false	Serie-Nº factura / año factura
3	Importe	true	Base imponible
3	Nº interno de contrato	false	Identificador del contrato del SGI asociado al ingreso
4	Entidad pagadora	false	Nombre del tercero pagador de la factura emitida

Ejemplos

Columnas de gastos (/gastos-invencion/columnas)

Respuesta

[
 {
   "id": "1"
   "nombre":"Fecha"
   "acumulable": "false"
  },
  {
   "id":"2",
   "nombre":"Referencia",
   "acumulable": "false"
  },
  {
   "id":"3",
   "nombre":"Concepto",
   "acumulable": "false"
  },
  {
   "id":"4",
   "nombre":"Tipo",
   "acumulable": "false"
  },
  {
   "id":"5",
   "nombre":"Importe",
   "acumulable": "true"
  }

]

Gastos (/gastos-invencion)

Respuesta

[
{
	"id":"1",
	"tipo":"Gasto",
	"columnas": {
     	"1":,
     	"2":"F123456",
     	"3":"Informe de patentabilidad",
     	"4":"Honorarios",
     	"5":55.99
     	}
 
},
{
	"id":"2",
	"tipo":"Gasto",
	"columnas": {
     	"1":,
     	"2":"F123457",
     	"3":"Solicitud de patente",
     	"4":"Tasa",
     	"5":99.99
     	}
}
]

Detalle gasto (/gastos-invencion/{id})

Respuesta

"id":"2",
"documentos":[
  {
   "id": "11",  
   "nombre":"Factura",
   "nombreFichero":"factura.pdf"
  },
  {
    "id": "12", 
    "nombre":"Otro documento",
    "nombreFichero":"otroDocumento.pdf"
  }
]

Árbol de páginas

SGI - ESB - SGEPII

Sistema de Gestión Económica de Protección Industrial e Intelectual

Entidades

Enumerados

Modelo lógico

API

Definición de los objetos

Invencion

DatoEconomico

DatoEconomicoDetalle

Columna

Documento (se reutilizaría el mismo que el definido en UM - SGI - ESB - SGE - Ejecución económica)

Servicios

Columnas Gastos

Columnas Ingresos

Ejemplos

Columnas de gastos (/gastos-invencion/columnas)

Gastos (/gastos-invencion)

Detalle gasto (/gastos-invencion/{id})