...
Ejecución económica
Entidades
Hay entidades que se reutilizan del modelo de Ejecución económica del SGE y por tanto no se repiten aquí, 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 esta: Ejecución presupuestaria, detalle de operaciones, validación de gastos, etc... Por cada columna se tendrá 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. |
| 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 | ||
| Campo | Contiene el listado de campos dinámicos que serán mostradas en las pantallas de detalle de un dato económico. Por cada campo se tendrá el el nombre y el valor del campo | ||
| Documento | Entidad que representa los documentos que pueda tener relacionados un dato económico (en este caso los gastos). |
Enumerados
...
Puede tomar los siguientes valores:
- Ingreso
- Gasto
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: SGI - ESB - SGE - Ejecución económica.
DatoEconomico
| Nombre | Tipo | Descripción |
| id | String | Identificador del dato económico. Tiene que ser un identificador único. |
| tipo | String | Dos valores:
|
| 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). |
...
| Nombre | Tipo | Descripción |
| id | String | Identificador del dato económico. Tiene que ser un identificador único. |
| camposdocumentos | Lista[CampoDocumento] | Lista de campos, por cada campo se define el nombre y el valor del campo |
Columna
...
Indica si se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI.
Dos valores:
- true
- false
documentos asociados al gasto (sin el contenido binario del fichero). |
Servicios
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: SGI - ESB - SGE - Ejecución económica.
Documento
nombreFichero
Método | URL | Parámetros | Respuesta | Descripción | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Invención | ||||||||||||
| HEAD | /invenciones/{id} | HTTP 200 / HTTP 204 | Comprueba la existencia de la invención con el id indicado en el SGI. | |||||||||
| Gastos | ||||||||||||
| GET | /gastos-invencion/columnas | q+s (query + sort) La query estará formada por:
| 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:
| ||||||||
| GET | /gastos-invencion | q+s (query + sort) La query estará formada por:
| Lista[DatoEconomico] | Listado de todos los gastos asociados a una invención. Para cada gasto se devolverán los siguientes datos:
| ||||||||
| GET | /gastos-invencion/{id} | DatoEconomicoDetalle | Detalle de un gasto. Para cada gasto se devolverán los siguientes datos:
| |||||||||
| Ingresos | ||||||||||||
| GET | /ingresos-invencion/columnas | q+s (query + sort) La query estará formada por:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /ingresos-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:
| ||||||||
| GET | /ingresos-invencion | q+s (query + sort) La query estará formada por:
| Lista[DatoEconomico] | Listado de todos los ingresos asociados a una invención (la asociación se realizará a través de contratos de CSP), que se corresponderán con las facturas emitidas. Para cada ingreso se devolverán los siguientes datos:
| GET | /documentos/{id} | Documento | Devuelve el detalle del documento | GET | /documentos/{id}/archivo | Binario (en la cabecera ira el contentType) | Devuelve el binario del documento |
Columnas Gastos
| id | nombre | acumulable | descripción |
|---|---|---|---|
| 1 | Fecha | false | A completar con UMU |
| 2 | Referencia | false | |
| 3 | Concepto | false | |
| 4 | Tipo (Honorarios, Tasa, ...) | false | |
| 5 | Importe | true |
...