...
| Info | ||
|---|---|---|
| ||
Se actualizan las entidades "DatoEconomico" y "DatoEconomicoDetalle" para:
Se añade la entidad "ClasificacionSGE" |
| 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, fecha de devengo, partida presupuestaria, un código económico (opcional en algunos de los casos) y una clasificación SGE. 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, fecha de devengo, partida presupuestaria, un código económico y una clasificación SGE) 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). |
| ClasificacionSGE | Entidad que representa la clasificación de los gastos en el sistema de gestión económico. |
Enumerados
| Entidad | Descripción |
|---|---|
| TipoDatoEconomico | Puede tomar los siguientes valores:
|
| TipoOperacion | Puede tomar los siguientes valores:
|
| Estado (en validación de gastos) | Puede tomar los siguientes valores:
|
Modelo lógico
| Info | ||
|---|---|---|
| ||
Se actualizan las entidades "DatoEconomico" y "DatoEconomicoDetalle" para:
Se añade la entidad "ClasificacionSGE" |
API
Características generales que todas las API REST deben de cumplir:
...
Definición de los objetos
...
| Info |
|---|
...
| ||
Se actualizan las entidades "DatoEconomico" y "DatoEconomicoDetalle" para:
Se añade la entidad "ClasificacionSGE" |
DatoEconomico
| Nombre | Tipo | Descripción | |||||
| id | String | Identificador del | Tipo | Descripción | id | String | Identificador del dato económico. Tiene que ser un identificador único. |
| proyectoId | String | Identificador del proyecto económico | |||||
| partidaPresupuestaria | String | Código de la Partida presupuestaria | |||||
| fechaDevengo | String | Fecha de devengo (fecha del gasto o del ingreso) | |||||
| clasificacionSGE | ClasificacionSGE | Contiene la entidad ClasificacionSGE | |||||
| codigoEconomico | CodigoEconomicoGasto/CodigoEconomicoIngreso | Contiene la entidad Código económico Gasto si se trata de un gasto (campo "tipo" es "Gasto" ) o contiene la entidad Código económico Ingreso si se trata de un ingreso (campo "tipo" es "Gasto" ) | |||||
| anualidad | String | Anualidad | |||||
| tipo | String | Dos valores:
| |||||
| 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) |
...
| Nombre | Tipo | Descripción |
| id | String | Identificador del dato económico. Tiene que ser un identificador único. |
| proyectoId | String | Identificador del proyecto económico |
| partidaPresupuestaria | String | Código de la Partida presupuestaria |
| fechaDevengo | String | Fecha de devengo (fecha del gasto o del ingreso) |
| clasificacionSGE | ClasificacionSGE | Contiene la entidad ClasificacionSGE |
| codigoEconomico | CodigoEconomicoGasto/CodigoEconomicoIngreso | Contiene la entidad Código económico Gasto si se trata de un gasto o contiene la entidad Código económico Ingreso si se trata de un ingreso |
| anualidad | String | Anualidad |
| campos | Lista[Campo] | Lista de campos, por cada campo se define el nombre y el valor del campo |
...
| Nombre | Tipo | Descripción |
| nombre | String | Nombre del campo |
| valor | String | Valor del campo |
Comentario
| valor | String | Valor del campo |
Comentario
| Nombre | Tipo | Descripción |
| comentario | String | Comentario relacionado con el cambio de estado de un gasto |
ClasificacionSGE
| Nombre | Tipo | Descripción |
| id | String | Cadena numérica o alfanumérica que identifica a la clasificación del gasto en el SGE |
| nombre | String | Nombre o descripción de la clasificación SGE |
Servicios
| Info | ||
|---|---|---|
| ||
Se modifican los siguientes servicios para añadir como columnas fijas la "Fecha devengo" y "Clasificación SGE"
|
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 las siguientes columnas:
|
| 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:
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:
| 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 | |
...