Á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.

...

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.

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


Servicios

Info
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
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)). Ver el apartado "Columnas Factura Emitida" para ver los id de la columnas que 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/{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

...