Manual de usuario
Servicios: información concreta de uso
Finalidad, ruta de acceso, tipado de entidades, parámetros de salida, parámetros de entrada, etc. Detallamos cada uno de nuestros servicios para facilitar su uso al usuario.
En el manual de referencia se especifican con más detalle los tipados de entidades y como funcionan en conjunto. Aun con esto, si se ecuentra con alguna duda, contacte con soporte@diezsoftware.com.
Antes de que una aplicación pueda usar el servicio, siempre deberá pasar a través del header de las peticiones HTTP las claves de acceso facilitadas. Se requerirá un usuario y una clave.
Ejemplo:
"Usuario": "diezscan"
"Clave": "xWCTIbDJf7hnETQqS3yPkdWI2yxNcpbRdRdpIhwfboCPvtRel4jF4tyMTqcUT"
Índice
Upload: Servicios relacionados con la subida de documentos a DiezSCAN para su procesado.
Status: Servicios relacionados con el estado de los documentos ya subidos a DiezSCAN.
Reportes: Servicios relacionados con informes, datos, contabilización de documentos ya procesados, pendientes, filtrado de datos por usuario, NIF/CIF, etc.
Modelos o clases: Recopilación de las modelos o tipos de objeto utilizados para las respuestas de nuestros servicios.
#Upload
Upload- POST 
Finalidad
Envío de un documento para su procesado en DiezSCAN. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
Upload- DELETE
Finalidad
Borrado de un documento de DiezSCAN. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
#Status
Status - POST
Finalidad
Petición de estado de un documento subido. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
Status - GET (suscripción)
Finalidad
Servicio de suscripción para la obtención de notificaciones de procesado de facturas. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
#Reportes
GetDocumentosDigitalizados - GET
Finalidad
Solicita el número de documentos digitalizados filtrando por fechas. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
GetListadoDocPendientes - GET
Finalidad
Solicita un listado de documentos pendientes por cliente. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
GetListadoDocDiariosPorUsuario - GET
Finalidad
Solicita un listado de diarios por cliente. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
GetDiariosUsuario - GET
Finalidad
Solicita los documentos totales del usuario, la cantidad de dias en los que se han subido documentos y los documentos al dia de media. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
GetListadoDocPorNIF - GET
Finalidad
Solicita el listado de documentos digitalizados por NIF/CIF, contando los documentos emitidos y los recibidos. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
GetListadoUsosNIFporCliente - GET
Finalidad
Solicita un listado de usos de NIF/CIFs por cliente. Antes de que una aplicación pueda usar el servicio, pasaremos nuestro usuario y claves facilitados a través de la cabecera de la petición HTTP.
#Modelos/clases
Documento - Modelo de /Upload
Descripción
Modelo que esta formado por el Cliente, el CIF/NIF del documento, el tipo de factura (emitida o recibida), el nombre del archivo y un array de bytes, que es el archivo.
EstadoDocumento - Modelo de /Status
Descripción
Modelo que esta formado por el Cliente, el Id del documento y el tipo de factura (emitida o recibida).
RespuestaEstado - Modelo de respuesta /Status
Descripción
Modelo que esta formado por Id del documento, el estado del documento (siendo 0 -> Factura enviada y pendiente de ser procesada, 1 -> Factura procesada con sus datos disponibles y 2 -> Factura con algún tipo de error) y los datos del documento procesado si es que existen.
RespuestaPaginada - Modelo contenedor de Listados
Descripción
Es utilizado como contenedor de las respuestas con listados. Muestra los resultados totales, el número de páginas, el índice de la página actual, el número de elementos visibles en una página y el número visible en la página actual.
DocumentosPendientesUsuario - Modelo listado /Report/GetListadoDocPendientes
Descripción
Modelo que esta formado por cliente, que es la cadena del cliente, la fecha de subida de los documentos y el número de documentos pendientes en esa fecha.
DocumentosDiariosPorUsuario - Modelo listado /Report/GetListadoDocDiariosPorUsuario
Descripción
Modelo que esta formado por la cadena del cliente, el número de días en los que se han subido documentos, numero de documentos totales subidos, y el número de documentos al dia de media.
DocumentosDia - Modelo de /Report/GetDiariosUsuario
Descripción
Modelo que esta formado por el número de días en los que se han subido documentos, el número de documentos total y la media de documentos al día.
DocumentosPorNIF - Modelo de /Report/GetListadoDocPorNIF
Descripción
Modelo que esta formado por el NIF/CIF del documento, el número de documentos emitidos y el número de documentos recibidos.
DocumentosPorClienteYnif - Modelo listado /Report/GetListadoUsosNIFporCliente
Descripción
Modelo que esta formado por el cliente y un detalle con los CIF/NIF junto al número de documentos emitidos y número de documentos recibidos.
DatosFactura - Modelo DatosFactura
Descripción
Modelo que representa los datos de una factura procesada.