Seguimiento justificación
Entidades
| GastoJustificado | Entidad que representa al gasto que puede ser añadido en una justificación. Tendrá que venir identificado por un identificador único, por el proyecto al que pertenece, echa de devengo, un código económico, el importe del gasto y el importe justificado presentado en la justificación. El resto de campos del gasto 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 dinámicas que serán mostradas en las pantallas del SGI. 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. |
| GastoJustificadoDetalle | Entidad que representa el detalle de un gasto de una justificación con todos sus campos para mostrarlo en una pantalla de consulta del gasto. Tendrá unos campos fijos (identificador único, identificador del proyecto al que pertenece, fecha de devengo,, un código económico, importe gasto e importe presentado en la justificación) 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 gasto. Por cada campo se tendrá el el nombre y el valor del campo |
| Documento | Entidad que representa los documentos que pueda tener relacionados un gasto |
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
...
Definición de los objetos
GastoJustificado
| Nombre | Tipo | Descripción |
| id | String | Identificador del gasto. Tiene que ser un identificador único |
| proyectoId | String | Identificador del proyecto económico (SGE) |
| codigoEconomico | CodigoEconomicoGasto | Contiene la entidad Código económico Gasto (definida en SGI - ESB - SGE - Proyecto SGE y presupuesto) |
| fechaDevengo | String | Fecha de devengo (fecha del gasto) |
| codigoEconomico | CodigoEconomicoGasto | |
| importe |
| Numérico (sin separador de miles y como separador decimal el punto) | Importe del gasto |
| importeJustificado |
| Numérico (sin separador de miles y como separador decimal el punto) | Importe presentado en la justificación | |
| columnas | Map[clave,valor] | Mapa de propiedades El valor será un String salvo en aquellas columnas que sean acumulables (se tenga que hacer sumas sobre ellas) donde será de tipo Numérico (sin separador de miles y como separador decimal el punto) |
GastoJustificadoDetalle
| Nombre | Tipo | Descripción |
| id | String | Identificador del gasto. Tiene que ser un identificador único. |
| proyectoId | String | Identificador del proyecto económico (SGE) |
| codigoEconomico | CodigoEconomicoGasto | Contiene la entidad Código económico Gasto (definida en SGI - ESB - SGE - Proyecto SGE y presupuesto) |
| fechaDevengo | String | Fecha de devengo (fecha del gasto ) |
| importe | String | Importe del gasto |
| importeJustificado | String | Importe presentado en la justificación |
| campos | Lista[Campo] | Lista de campos, por cada campo se define el nombre y el valor del campo |
Columna
| Nombre | Tipo | Descripción |
| id | String | Identificador de la columna |
| nombre | String | Nombre de la columna |
| acumulable | Boolean | Indica si se tiene que sumar o no para mostrar los totales en la pantalla del SGI. Dos valores:
|
Documento
| 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, 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.
Método | URL | Parámetros | Respuesta | Descripción |
|---|---|---|---|---|
Método | URL | Parámetros | Respuesta | Descripción |
| GET | /ejecucion-economica/columnas | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. El tipoOperacion puede tomar los siguientes valores:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /ejecucion-economica Por cada columna se indica un id, nombre, si es una columna acumulable (se va a hacer una suma de ella en el SGI) Ver el apartado "Columnas Ejecución económica" para ver que columnas se deben de mostrar dependiendo del tipo de operación (campo tipoOperacion) y si es reducida o no |
| GET | /ejecucion-economica | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. El tipoOperacion puede tomar los siguientes valores:
| Lista[DatoEconomico] | Listado con los datos económicos pedidos según el campo tipoOperacion. Por cada dato económico se devolverán los siguientes campos:
|
| GET | /ejecucion-economica/{id} | tipoOperacion El tipoOperacion puede tomar los siguientes valores (cuando estamos en la llamada de detalle de dato económico):
| DatoEconomicoDetalle | Detalle del dato económico con todas sus columnas.
El listado de campos a mostrar dependerá de que dato económico sea, si es una factura o gasto, un viaje o dieta o un personal contratado. |
| Validación de gastos | ||||
| GET | /gastos/columnas | q+s (query + sort) La query estará formada por:
Si no esta informado el campo reducida se considera false. El campo estado puede tomar dos valores:
El campo reducida puede tomar los siguientes valores:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /gastos Por cada columna se indica un id, nombre, si es una columna acumulable (se va a hacer una suma de ella en el SGI) Ver el apartado "Columnas Validación de gastos" para ver que columnas se deben de mostrar dependiendo de si es reducida o no |
| GET | /gastos | q+s (query + sort) La query estará formada por:
El campo estado puede tomar dos valores:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. | Lista[DatoEconomico] | Listado de gastos pendientes de pasar por la "Validación de gastos" si en el campo del filtrado estado = 'Pendiente' o listado de gastos que ya han sido validados (han pasado por la "Validación de gastos") si en el campo del filtrado estado = 'Validado' Para cada gasto se devolverán los siguientes datos:
|
| GET | /gastos/{id} | DatoEconomicoDetalle | Detalle de un gasto. Para cada gasto se devolverán los siguientes datos:
| |
| PATCH | /gastos/{id}/validar | Comentario | Se valida el gasto y recibe como parámetro el comentario en caso de que lo tuviese. | |
| PATCH | /gastos/{id}/rechazar | Comentario | Se rechaza el gasto y recibe como parámetro el comentario en caso de que lo tuviese. | |
| 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 | |