Árbol de páginas

Versiones comparadas

Clave

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

...

EntidadDescripción
FacturaEmitida

Entidad que representa una factura emitida del SGE. Tendrá que venir identificado por un identificador único, por el proyecto al que pertenece y la anualidad.

El resto de campos de la factura emitida 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 la pantalla del SGI de Factura emitidas.

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.

FacturaEmitidaDetalle

Entidad que representa el detalle de una factura emitida con todos sus campos para mostrarlo en una pantalla de consulta de la factura emitida.

Tendrá unos campos fijos (identificador único, identificador del proyecto al que pertenece y anualidad) 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 una factura emitida.

Por cada campo se tendrá el el nombre y el valor del campo

DocumentoEntidad que representa los documentos que pueda tener relacionados una factura emitida
FacturaPrevistaListado de facturas previstas en el calendario de facturación de un proyecto. Contiene la información introducida por el gestor en su previsión. El campo "numeroPrevision" es el campo de unión entre el SGI y el SGE. En el SGE al crea una factura se asociará a un "numeroPrevision". El "numeroPrevision" será el identificador interno de los item de calendario de facturación en el SGI.
ModeloEjecucucionRepresenta el modelo de ejecución relacionado con la factura (el relacionado con el proyecto).
FacturaPrevistaEmitida

Entidad que representa una factura emitida del SGE pero con menos información que la entidad "FacturaEmitida". Únicamente tiene la información sobre el "número de factura del SGE" y del "número de previsión". Es para poder mostrar en la pantalla de Calendario facturación del SGI el número de factura.

FacturaPrevistaEmitida

Entidad que representa una factura emitida del SGE pero con menos información que la entidad "FacturaEmitida". Únicamente tiene la información sobre el "número de factura del SGE" y del "número de previsión". Es para poder mostrar en la pantalla de Calendario facturación del SGI el número de factura.

Modelo Modelo lógico

API

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

...

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

nombreFichero

StringNombre del fichero con extensión

...

FacturaPrevistaEmitida

NombreTipoDescripción
idStringIdentificador de la factura emitida. Tiene que ser un identificador único.

proyectoIdSGI

StringIdentificador del proyecto SGI.

numeroFactura

StringNúmero de la factura emitida (en el SGE)
numeroPrevisionString

Es el campo que establece la relación entre el ítem del calendario de facturación y las facturas emitidas en el SGE.

Identificador interno del item de Junto con el identificador del proyecto SGI identificarán un item del calendario de facturación del SGI.proyectoIdSGI

Método

URL

StringIdentificador del proyecto SGI.fechaEmisionStringFecha en la que debe ser emitida la factura.

importeBase

NúmeroImporte base de la factura.modeloEjecucionModeloEjecucion

Modelo de ejecución asociado a la factura (al proyecto)

ModeloEjecucion

...

Parámetros

Respuesta

Descripción
SGI - SGE (Los debe de implementar Murcia)
GET/facturas-emitidas/columnas

q+s (query + sort)

La query estará formada por:

  • proyectoId
  • reducida
  • fechaFactura

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 informado el campo reducida se considera false.

Lista[Columna]



Listado con las columnas que va a devolver la llamada /facturas-emitidas

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 Factura Emitida" para ver que columnas se deben de mostrar.


GET/facturas-emitidas

q+s (query + sort)

La query estará formada por:

  • proyectoId
  • reducida
  • fechaFactura

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 informado el campo reducida se considera false.

Lista[FacturaEmitida]



Listado con las facturas emitidas del SGE. Por cada factura emitida se devolverán los siguientes campos:

  • Identificador de la factura emitida
  • Identificador del proyecto SGE
  • Anualidad
  • Número de factura
  • Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /facturas-emitidas/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)).

FacturaPrevistaEmitida

NombreTipoDescripciónidStringIdentificador de la factura emitida. Tiene que ser un identificador único.

proyectoIdSGI

StringIdentificador del proyecto SGI.

numeroFactura

StringNúmero de la factura emitida (en el SGE)numeroPrevisionString

Es el campo que establece la relación entre el ítem del calendario de facturación y las facturas emitidas en el SGE.

Identificador interno del item de calendario de facturación del SGI.

Lista[Columna]

proyectoIdreducida
  • fechaFactura
  • 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 informado el campo reducida se considera false.

    Lista[FacturaEmitida SGEAnualidad de facturaMapa de columnas de clave - valor (donde la clave será los id definidos en la llamada 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)). Ver el apartado "Columnas Factura Emitida" para ver los id de la columnas que se deben de mostrar.

    Detalle de la factura emitida con todas sus columnas.

    • Identificador de la factura emitida
    • Identificador del proyecto SGE
    • Anualidad
    • Listado de campos con su nombre y valor (Ver el apartado "Campos Detalle factura emitida" para ver que campos se deben de mostrar. En el detalle se muestran todos la columnas o campos.)
    • Listado de documentos (identificador, nombre del documento y nombre del fichero, sin el contenido)

    Método

    URL

    Parámetros

    Respuesta

    Descripción
    SGI - SGE
    GET/facturas-emitidas/columnas

    q+s (query + sort)

    La query estará formada por:

    • proyectoId
    • reducida
    • fechaFactura

    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 informado el campo reducida se considera false.

    Listado con las columnas que va a devolver la llamada /facturas-emitidas

    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 Factura Emitida" para ver los id de la columnas que
    columnas
    • se deben de mostrar.
    GET/facturas-previstas-emitidas

    q+s (query + sort)

    La query estará formada por:

    • proyectoIdSGI
    • numeroPrevision
    • numeroFactura

    proyectoIdSGI: identificador del proyecto en el SGI

    Lista[FacturaPrevistaEmitida]

    Listado con las facturas emitidas del SGE. Por cada factura emitida se devolverán los siguientes campos:

    • Identificador de la factura emitida
    • Identificador del proyecto
    • SGI
    • Número factura
    • Número
    • previsión
    GET/facturas-emitidas/
    GET/facturas-previstas-emitidas

    q+s (query + sort)

    La query estará formada por:

    • proyectoIdSGI
    • numeroPrevision
    • numeroFactura

    proyectoIdSGI: identificador del proyecto en el SGI

    Lista[FacturaPrevistaEmitida]

    Listado con las facturas emitidas del SGE. Por cada factura emitida se devolverán los siguientes campos:

    • Identificador de la factura emitida
    • Identificador del proyecto SGI
    • Número factura
    • Número previsión
    GET/facturas-emitidas/{id}FacturaEmitidaDetalleGET/documentos/{id}/archivoBinario (en la cabecera ira el contentType)Devuelve el binario del documento
    SGE - SGI
    GET/facturas-previstas

    q+s (query + sort)

    La query estará formada por:

    • proyectoIdSGI
    • numeroPrevision

    proyectoIdSGI: identificador del proyecto en el SGI

    Lista[FacturaPrevista]

    Listado de todas las facturas previstas, registradas en el SGI validadas por el IP y con fecha de conformidad (tanto si ya tienen la factura emitida creada en el SGE como sino).

    La relación entre el calendario de facturación del SGI y facturas emitidas se establecerá en el SGE.

    Este servicio será el utilizado en el SGE en la pantalla de creación de factura emitida para mostrar el listado de items del calendario de facturación creados en el SGI (tendrán que eliminar aquellos items del calendario del SGI que ya tienen factura emitida relacionada o creada). La relación factura emitida (SGE) - número previsión (SGI) se almacenará en el SGE.

    Por cada factura prevista se devolverán los siguientes campos:

    • Número previsión (identificador de la factura prevista en el SGI)
    • Identificador del proyecto en el SGI
    • Fecha de emisión
    • Importe base
    • Comentario

    Columnas Facturas emitidas

    (reducida =='true'reducida =='false')  (independientemente del campo reducida, ya que siempre se mandan todas las columnas) las columnas a devolver en la Universidad de Murcia serán:

    ...

    {id}
    FacturaEmitidaDetalle

    Detalle de la factura emitida con todas sus columnas.

    • Identificador de la factura emitida
    • Identificador del proyecto SGE
    • Anualidad
    • Listado de campos con su nombre y valor (Ver el apartado "Campos Detalle factura emitida" para ver que campos se deben de mostrar. En el detalle se muestran todos la columnas o campos.)
    • Listado de documentos (identificador, nombre del documento y nombre del fichero, sin el contenido)



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

    Columnas Facturas emitidas

    (reducida =='true'reducida =='false')  (independientemente del campo reducida, ya que siempre se mandan todas las columnas) las columnas a devolver en la Universidad de Murcia serán:

    idnombreacumulable
    1Fecha emisiónfalse
    2Entidadfalse
    3Conceptofalse
    4Importe basetrue
    5Porcentaje IVAfalse
    6Importe totaltrue
    7Estadofalse
    8Fecha cobrofalse
    9Importe cobradotrue
    10Número previsiónfalse

    Campos Factura emitida

    Los campos a devolver en la Universidad de Murcia serán:

    • Fecha emisión
    • Entidad
    • Concepto
    • Importe base
    • Porcentaje IVA
    • Importe total
    • Estado
    • Fecha cobro
    • Importe cobrado
    • Número previsión

    Ejemplos

    Columnas Facturas emitidas (/facturas-emitidas/columnas)


    Bloque de código
    themeRDark
    titleParámetros
    proyectoId=="123456";fechaFactura=bt=("2020-12-01T00:00:00Z","2021-01-31T23:59:59Z")
    Bloque de código
    themeRDark
    titleRespuesta
    [
     

    Campos Factura emitida

    Los campos a devolver en la Universidad de Murcia serán:

    • Fecha emisión
    • Entidad
    • Concepto
    • Importe base
    • Porcentaje IVA
    • Importe total
    • Estado
    • Fecha cobro
    • Importe cobrado
    • Número previsión

    Ejemplos

    Columnas Facturas emitidas (/facturas-emitidas/columnas)

    Bloque de código
    themeRDark
    titleParámetros
    proyectoId=="123456";fechaFactura=bt=("2020-12-01T00:00:00Z","2021-01-31T23:59:59Z")
    Bloque de código
    themeRDark
    titleRespuesta
    [
     {
       "id": "1"
       "nombre":"Fecha emisión"
       "acumulable": "false"
       
      },
      {
       "id":"2",
       "nombre":"Entidad",
       "acumulable": "false"
      
      },
      {
       "id":"3",
       "nombre":"Concepto",
       "acumulable": "false"
      
      },
      {
       "id":"4",
       "nombre":"Importe base",
       "acumulable": "true"
      },
      {
       "id":"5",
       "nombre":"Porcentaje IVA",
       "acumulable": "false"
      },
      {
       "id": "61",
       "nombre":"ImporteFecha totalemisión",
       "acumulable": "truefalse"
       
      },
      {
       "id":"72",
       "nombre":"EstadoEntidad",
       "acumulable": "false"
      
      },
      {
       "id":"83",
       "nombre":"Fecha cobroConcepto",
       "acumulable": "false"
      
      },
      {
       "id":"94",
       "nombre":"Importe cobradobase",
       "acumulable": "true"
      },
      {
       "id":"105",
       "nombre":"NúmeroPorcentaje previsiónIVA",
       "acumulable": "false"
      },
    
    ]

    Facturas emitidas (/facturas-emitidas)

    Bloque de código
    themeRDark
    titleParámetros
    proyectoId=="123456";fechaFactura=bt=("2020-12-01T00:00:00Z","2021-01-31T23:59:59Z")
    Bloque de código
    themeRDark
    titleRespuesta
    [
    {
    	"id":"11-2021"
    	"proyectoId":"123456",
    	"anualidad":"2021",
    	"numeroFactura":"J2021/01",
    	"columnas": {
         	"1":"20/05/2021",
      		"2":"Entidad1",
     		"3":"Concepto1",
      		"4":1000.00,
      		"5  {
       "id":"6",
       "nombre":"Importe total",
       "acumulable": "true"
      },
      {
       "id":"7",
       "nombre":"Estado",
       "acumulable": "false"
      },
      {
       "id":"8",
       "nombre":"Fecha cobro",
       "acumulable": "false"
      },
      {
       "id":"9",
       "nombre":"Importe cobrado",
       "acumulable": "true"
      },
      {
       "id":"10",
       		"6nombre":1100.00"Número previsión",
      		 "7acumulable": "Pagadafalse",
      }
    
    ]


    Facturas emitidas (/facturas-emitidas)


    Bloque de código
    themeRDark
    titleParámetros
    proyectoId=="123456";fechaFactura=bt=("2020-12-01T00:00:00Z","2021-01-31T23:59:59Z")
    Bloque de código
    themeRDark
    titleRespuesta
    [		"8":"20/08/2021",
      		"9":1100.00,
      		"10":"1"
      		}
    },
    {
    	"id":"1211-2021"
    	"proyectoId":"123456",
    	"anualidad":"2021",
    	"numeroFactura":"J2021/0201",
    	"columnas": {
         	"1":"20/0605/2021",
      		"2":"Entidad2Entidad1",
     		"3":"Concepto2Concepto1",
      		"4":1000.00,
      		"5":"10",
     		"6":1100.00,
      		"7":"Pagada",
      		"8":"20/08/2021",
      		"9":1100.00,
      		"10":"2"
      		}
    }
    ]
    

    Detalle factura emitida (/facturas-emitidas/{id})

    {

    Bloque de código
    themeRDark
    titleRespueta
    {
        1"
      		}
    },
    {
    	"id":"12-2021"
    	"proyectoId":"123456",
    	"anualidad":"2021",
    	"numeroFactura":"J2021/02",
        "campos	"columnas":[
            {
                "nombre	"1":"Fecha emisión20/06/2021",
                "valor		"2":"Entidad2",
     		"3":"1243Concepto2",
            }		"4":1000.00,
            {
                "nombre":"Entidad		"5":"10",
     		"6":1100.00,
      		"7":"Pagada",
                "valor		"8":"Entidad120/08/2021",
      		"9":1100.00,
      		"10":"2"
      		}
    }
    ]
    


    Detalle factura emitida (/facturas-emitidas/{id})

    {

    Bloque de código
    themeRDark
    titleRespueta
    {
        "id":"12-2021"
    	"proyectoId":"123456",
    	"anualidad":"2021",
    	"numeroFactura":"J2021/02",
        "campos":[
            },
            {
                "nombre":"Concepto",
                "valor":"Concepto1"
            },
            {
                "nombre":"Importe base",
                "valor":1000.00
            },
            {
                "nombre":"PorcentajeFecha IVAemisión",
                "valor":"101243"
            },
            {
                "nombre":"Importe totalEntidad",
                "valor":1100.00"Entidad1"
            },
            {
                "nombre":"EstadoConcepto",
                "valor":"PagadaConcepto1"
            },
            {
                "nombre":"FechaImporte cobrobase",
                "valor":"20/08/2021"1000.00
            },
            {
                "nombre":"ImportePorcentaje cobradoIVA",
                "valor":1100.00"10"
            },
            {
                "nombre":"NúmeroImporte previsióntotal",
                "valor":"21100.00
            }
        ],
       "documentos":[
         {
       {
      		 "id": "11", 
       		 "nombre":"FacturaEstado",
       		 "nombreFichero":"factura.pdf"
      		}
        ]
         
    }

    Facturas previstas   (/facturas-previstas)

    Las registradas en el SGI y que debe consultar el SGE, listado de facturas pendientes de un proyecto

    Bloque de código
    themeRDark
    titleParámetros
    proyectoIdSGI=="11"
    Bloque de código
    themeRDark
    titleRespuesta
    [
    {
    	"numeroPrevision":"1"
    	"proyectoIdSGI":"11",
    	"fechaEmision":"01/02/2021",
    	"importeBase":1500.50,
        "comentario": "comentario1"
    	
    },
    {
    	"numeroPrevision":"2"
    	"proyectoIdSGI":"11",
    	"fechaEmision":"01/02/2021",
    	"importeBase":1400.70,
        "comentario": "comentario2"
    }
    ]
    

    Detalle Factura prevista  (/facturas-previstas)

    Las registradas en el SGI y que debe consultar el SGE, detalle de una concreta

    Bloque de código
    themeRDark
    titleParámetros
    proyectoIdSGI=="11";numeroPrevision=="1"
    Bloque de código
    themeRDark
    titleRespuesta
    [
    {
    	"numeroPrevision":"1"
    	"proyectoIdSGI":"11",
    	"fechaEmision":"01/02/2021",
    	"importeBase":1500.50,
        "comentario": "comentario1"
    	
    }
    ]
     "valor":"Pagada"
            },
            {
                "nombre":"Fecha cobro",
                "valor":"20/08/2021"
            },
            {
                "nombre":"Importe cobrado",
                "valor":1100.00
            },
            {
                "nombre":"Número previsión",
                "valor":"2
            }
        ],
       "documentos":[
            {
      		 "id": "11", 
       		 "nombre":"Factura",
       		 "nombreFichero":"factura.pdf"
      		}
        ]
         
    }


    Consulta facturas previstas de emitir  (/facturas-previstas-emitidas)

    Las registradas en el SGE y que debe consultar el SGI para obtener el "número de factura" para mostrarlo en la pantalla de calendario faturaciónfacturación


    Bloque de código
    themeRDark
    titleParámetros
    proyectoIdSGI=="11";

    ...