Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 79

changes.mady.by.user Usuario desconocido (lorena.alvarez)

Guardado el

comparado con

Nueva versión 80

changes.mady.by.user Usuario desconocido (lorena.alvarez)

Guardado el

Clave

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

...

EntidadDescripció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 nombre del campo, su valor, si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador, y si es visible desde la pantalla principal del SGI (desde la que se hace la búsqueda)

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 nombre del campo, su valor, si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador, y si es visible desde la pantalla principal del SGI (desde la que se hace la búsqueda)

DocumentoEntidad que representa los documentos que pueda tener relacionados un dato económico (en este caso los gastos).


Modelo lógico

Image Modified

API

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

...

NombreTipoDescripción
idStringIdentificador del dato económico. Tiene que ser un identificador único.
proyectoIdStringIdentificador del proyecto económico
partidaPresupuestariaStringCódigo de la Partida presupuestaria
codigoEconomicoCodigoEconomicoContiene la entidad Código económico asignado al gasto/ingreso
anualidadStringAnualidad
tipoString

Dos valores:

  • Gasto
  • Ingreso
columnasMap[idclave,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)

Listado con las columnas a mostrar

Columna

/ Numérico
NombreTipoDescripción
idStringIdentificador de la columna
nombreStringNombre de la columna
valorString o Numérico

El valor será un String salvo en aquellas columnas que sean acumulables,se tenga que hacer sumas sobre ellas, donde será de tipo

Valor de la columna

Para las columnas que sean acumulables el campo valor debe de ser de tipo Numérico (sin separador de miles y como separador decimal el punto)

acumulableBoolean

Indica si se tiene que sumar o no para mostrar los totales en la pantalla del SGI.

Dos valores:

  • true
  • false

...

NombreTipoDescripción
idStringIdentificador único del documento
nombreStringNombre del documento a mostrar

nombreFichero

StringNombre del fichero con extensión

Comentario

NombreTipoDescripción
comentarioStringComentario relacionado con el cambio de estado de un gasto

Método

URL

Parámetros

Respuesta

Descripción
GET/ejecucion-economica/columnas

q+s (query + sort)

La query estará formada por:

  • proyectoId

  • anualidad

  • tipoOperacion
  • reducida
  • fechaPago
  • fechaDevengo
  • fechaContabilizacion

El campo reducida puede tomar los siguientes valores:

  • true: sólo se envían las columnas a mostrar en la pantalla principal
  • false:  se envían todas las columnas (para su exportación)

Si no esta

informada,

informado el campo reducida se considera false.

El tipoOperacion puede tomar los siguientes valores:

  • EPA (
ejecución
  • Ejecución presupestaria -
estado
  • Estado actual)
  • EPG
:
  • (Ejecución presupestaria - Gastos)
  • EPI
:
  • (Ejecución presupestaria - Ingresos)
  • FJF
: Factura
  • FJ: Viajes
  • FJ: Personal contratado
  • DO: Gastos
  • DO: Ingresos
    • (Facturas y justificantes - Facturas y gastos)
    • FJV (Facturas y justificantes - Viajes y dietas
    • FJP (Facturas y justificantes - Personal contratado)
    • DOG (Detalle de operaciones - Gastos)
    • DOI (Detalle de operaciones - Ingresos)
    • DOM (Detalle de operaciones - Modificaciones)
    DO: Modificaciones

    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 totalizadora (se va a hacer una suma de ella en el SGI) y si es visible o no en la pantalla principal del SGI

    Cuando tipoOperacion=='EPA' las columnas a devolver en la Universidad de Murcia serán:

    • 1 - Importe presupuestado
    - Es totalizadora - Es visible
    • 2 - Importe actual
    - Es totalizadora - Es visible
    • 3 - Importe disponible para gastos
    - Es totalizadora - Es visible
    • 4 - Derechos
    - Es totalizadora - Es visible
    • 5 - Cobros
    - Es totalizadora - Es visible

    Cuando tipoOperacion=='EPG' las columnas a devolver en la Universidad de Murcia serán:

    • 1 - Importe presupuestado
    - Es totalizadora - Es visible
    • 2 - Importe definitivo
    - Es totalizadora - Es visible3 -Gastos pagados - Es totalizadora - Es visible
    • 3 -Gastos pagados
    • 4 -Gastos en tramitación
    - Es totalizadora - Es visible
    • 5 -Crédito disponible
    - Es totalizadora - Es visible
    • 6 -Retenciones personal contratado y expedientes
    - Es totalizadora - Es visible
    • 7 -Pedidos activos
    - Es totalizadora - Es visible
    • 8 -Gastos pendientes de pago
    - Es totalizadora - Es visible
    • 9 -Pagos a justificar
    - Es totalizadora - Es visible

    Cuando tipoOperacion=='EPI' las columnas a devolver en la Universidad de Murcia serán:

    • 1 - Importe presupuestado
    - Es totalizadora - Es visible
    • 2 - Importe actual
    - Es totalizadora - Es visible
    • 3 - Derechos
    - Es totalizadora - Es visible
    • 4 - Cobros
    - Es totalizadora - Es visible
    GET/ejecucion-economica

    q+s (query + sort)

    La query estará formada por:

    • proyectoId
    • anualidad
    • tipoOperacion
    • reducida
    • fechaPago
    • fechaDevengo
    • fechaContabilizacion

    El

    tipoOperacion

    campo reducida puede tomar los siguientes valores:

  • EP: Estado actual
  • EP: Gastos
  • EP: Ingresos
  • FJ: Factura
  • FJ: Viajes
  • FJ: Personal contratado
  • DO: Gastos
  • DO: Ingresos
    • true: sólo se envían las columnas a mostrar en la pantalla principal
    • false:  se envían todas las columnas (para su exportación)

    Si no esta informado el campo reducida se considera false.

    El tipoOperacion puede tomar los siguientes valores:

    • EPA (Ejecución presupestaria - Estado actual)
    • EPG (Ejecución presupestaria - Gastos)
    • EPI (Ejecución presupestaria - Ingresos)
    • FJF (Facturas y justificantes - Facturas y gastos)
    • FJV (Facturas y justificantes - Viajes y dietas
    • FJP (Facturas y justificantes - Personal contratado)
    • DOG (Detalle de operaciones - Gastos)
    • DOI (Detalle de operaciones - Ingresos)
    • DOM (Detalle de operaciones - Modificaciones)
    DO: Modificaciones

    Lista[DatoEconomico]



    Listado con

    el balance de las partidas presupuestaria del proyecto

    los datos económicos pedidos según el campo tipoOperacion. Por cada

    partida presupuestaria

    dato económico se devolverán las

    columnas a mostrar en el SGI con sus cálculos realizados sobre las operaciones contables.

    siguientes columnas:

    • Identificador del dato económico
    • Identificador del proyecto SGE
    • Anualidad
    • Partida presupuestaria
    • Código económico
    • Tipo (si es Gasto o Ingreso)
    • Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /ejecucion-economica/columnas y el valor será el valor de la columna. 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))
    GET/ejecucion-economica/{id}
    		DatoEconomico

    Detalle del dato económico con todas sus columnas.

    • Identificador del dato económico
    Por cada partida se devolverá:
    • Identificador del proyecto SGE
    • Anualidad
    • Partida presupuestaria
    Anualidad
    • Código económico
    • Tipo (si es Gasto o Ingreso)
    Listado GET/ejecucion-economica/{id}DatoEconomico
    • Mapa de columnas
    (definidas en la llamada /ejecucion-economica/columnas) indicando el id y el valor
    • de clave - valor (donde la clave el nombre de la columna y 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))
    Validación de gastos
    GET/gastos/columnas

    q+s (query + sort)

    La query estará formada por:

    • proyectoId
    • fecha
    • id
    • estado

    El campo estado puede tomar dos valores:

    • Pendiente
    • Validado

    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 totalizadora (se va a hacer una suma de ella en el SGI en la pantalla principal) y si es visible o no en la pantalla principal del SGI.

    Las columnas a devolver en la Universidad de Murcia serán:

    • 1 - Fecha gasto
    - No es totalizadora - Es visible
    • 2 - PENDIENTES DE DEFINIR
    GET/gastos

    q+s (query + sort)

    La query estará formada por:

    • proyectoId
    • fecha
    • id
    • estado

    El campo estado puede tomar dos valores:

    • Pendiente
    • Validado

    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:

    • Identificador del gasto
    • Identificador del proyecto SGE
    • Partida presupuestaria a la que esta asignado el gasto
    • Código económico asignado al gasto
    • Anualidad
    • Tipo: Gasto
    Listado
    • Mapa de columnas
    (definidas
    • de clave - valor (donde la clave será los id definidos en la llamada /gastos
    /columnas) indicando el id y el valor
    • /columnas y el valor será el valor de la columna. 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))
    GET/gastos/{id}

    DatoEconomico



    		Detalle de un gasto.

    Para cada gasto se devolverán los siguientes datos:

    • Identificador del gasto
    • Identificador del proyecto SGE
    • Partida presupuestaria a la que esta asignado el gasto
    • Código económico asignado al gasto
    • Anualidad
    • Tipo: Gasto
    Listado
    • Mapa de columnas
    indicando el id,  valor
    • de clave - valor (donde la clave el nombre de la columna y 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))
    • Listado de documentos (nombre del documento y nombre del fichero, sin el contenido)
    PATCH/gastos/{id}/validarComentario
    		Se valida el gasto y recibe como parámetro el comentario  en caso de que lo tuviese.
    PATCH/gastos/{id}/rechazarComentario
    		Se rechaza el gasto y recibe como parámetro el comentario  en caso de que lo tuviese.




    Se necesita un servicio que reciba como parámetros la lista de identificadores del gasto y devuelve las columnas a mostrar en la validación de gastos con la suma ya realizada, en este caso "Importe validado" e "Importe pagado" (realiza la sumas de esos importes de todos los gastos pasados como parámetro)

    Se necesitará primero la función que devuelva el nombre de las columnas?





    Se necesita un servicio que reciba como parámetro la lista de códigos económicos usados en el proyecto (en elegibilidad) y devuelva para cada código económico la suma del importe de todos los gastos pendientes para ese código económico

    Se necesitará primero la función que devuelva el nombre de las columnas?


    GET/documentos/{id}
    		DocumentoDevuelve el detalle del documento
    GET/documentos/{id}/archivo
    		Binario (en la cabecera ira el contentType)Devuelve el binario del documento


    Ejemplos

    Ejecución presupuestaria - Estado actual - Columnas (/ejecucion-economica/columnas)

    ...