API estadísticas de trámites del servicio de Recepción (Reportes)

Sovos México ha creado un API REST para obtener estadísticas de los trámites creados en tus ventanillas del servicio de Recepción

Contenido

• ¿Qué necesito?
• Resumen general de la ventanilla
• Resumen por número de trámite
• Resumen por estado de trámite
• Resumen por usuario asignado al trámite

¿Qué necesito?

• Generar un API Key en tu cuenta Sovos México, ya que se usa para autenticar la solicitud en el API REST. El API Key debe corresponder al ambiente en el que se realiza la solicitud. Para referencia de cómo generar el API Key, consulta el siguiente artículo: Generar API Key para Web Services.

El llamado al API REST deberá contener como dato de entrada el periodo del cual se requiere el reporte. El periodo que se recibe como parámetro de entrada no debe exceder de 7 días.*

Resumen general de la ventanilla

La siguiente petición de API Recepción mostrará por periodo*:

• Número total de trámites
• Número de trámites creados
• Trámites que cambiaron de estado
• Ejecutaron Post Función
• Detalle Cambios Estado

Encabezado HTTP , método GET

Dirección del servicio

Ejemplo de petición

https://oat.reachcore.com/api/rest/ventanilla/0220f0b6-00c1-4aec-0fd1-ff0d00d1b109/estadisticas?fechaInicial=2018/12/06 17:09:00&fechaFinal=2018/12/06 17:10:00

Ejemplo de respuesta

{
    "IdSeguimiento": "200cb0e0-0b0b-0d00-00fd-0000d0a00ddb",
    "FechaInicial": "2018-12-06T17:09:00",
    "FechaFinal": "2018-12-06T17:10:00",
    "TotalTramites": 5,
    "TramitesCreados": 1,
    "TramitesCambiaronEstado": 0,
    "EjecutaronPostFuncion": 0,
    "DetalleCambiosEstado": {
        "Recibido": 5
    },
    "DetallePostFuncion": {}
}

Ejemplo de respuesta que indica un error en la petición

{
    "Error": {
        "Target": "Ventanilla",
        "Details": "Alguno de los parámetros recibidos para la obtención del trámite, no es válido.",
        "InnerErrors": [
            {
                "Target": "Ventanilla",
                "Details": "El rango de fechas especificado es mayor al permitido. Se permite hasta [7] días.",
                "InnerErrors": null,
                "MoreInfo": null,
                "Code": "VNTLLA-STATS-001(RangoFecha)",
                "Message": "Rango de fechas no permitido."
            }
        ],
        "MoreInfo": null,
        "Code": "VNTLLA-STATS-001",
        "Message": "Parámetros inválidos"
    }
}

Resumen por número de trámite

Para está petición se necesita el numero de Folio que genero la ventanilla y se obtendrá la siguiente información:

• Fecha de creación
• Fecha de ultima actualización
• Datos del usuario creador
• Datos de la Factura
• Información del flujo
• Información del expediente

Encabezado HTTP , método GET

Dirección del servicio

Ejemplo de petición

https://oat.reachcore.com/api/rest/Tramites/a00d0aa0-aa00-000a-0aaa-00000a000000/AAA00001

Ejemplo de respuesta

{
  {
    "InformacionDeVentanilla": {
        "IdVentanilla": "a00d0aa0-aa00-000a-0aaa-00000a000000",
        "NombreVentanilla": "Ventanilla ejemplo"
    },
    "InformacionDeTramite": {
        "Folio": "AAA00001",
        "FechaCreacion": "2020-01-21T19:54:19.453",
        "FechaUltimaActualizacion": "2020-02-06T17:46:57.52",
        "UsuarioCreador": {
            "UserName": "proveedor",
            "Nombre": "Mi proveedor",
            "Correo": "proveedor@mail.com",
            "EsUsuarioProveedor": true
        },
        "Factura": {
            "Serie": "A",
            "Folio": "101",
            "FechaEmision": "2020-01-20T10:50:40",
            "TipoComprobante": "I",
            "RfcEmisor": "TME960709LR2",
            "RazonSocialEmisor": "Descripción de la razon social",
            "RfcReceptor": "AAA010101AAA",
            "Total": 4875.000000,
            "SubTotal": 5000.000000,
            "TotalImpuestosTrasladados": 0.000000,
            "UUID": "a0a0ee7e-f42e-441a-8d51-e4aa0aa0a0a0",
            "FechaTimbrado": "2020-01-20T10:50:45"
        }
    },
    "InformacionDeFlujo": {
        "NombreEstadoActual": "En revisión",
        "NombreExternoEstadoActual": "En revisión",
        "FechaDeTransicionAlEstadoActual": "2020-02-06T17:46:35.02",
        "UsuarioAsignado": {
            "UserName": "usuario",
            "Nombre": "Usuario asignado",
            "Correo": "autos@mail.com",
            "EsUsuarioProveedor": false
        },
        "MotivoTransicion": "Motivo"
    },
    "InformacionDeExpediente": {
        "DatosPromovidos": {
            "CFDISerie": "A",
            "CFDIFolio": "101",
            "CFDIUUID": "a0a0ee7e-f42e-441a-8d51-e4aa0aa0a0a0",
            "CFDIRFCEmisor": "TME960709LR2",
            "CFDIRazonSocialEmisor": "CFDI nombre razón social",
            "CFDIFechaEmision": "2020-01-20T10:50:40",
        },
        "Expediente": {
            "capturarecepcion": {
                "factura": {
                    "fileName": "FACTURA_A_101_AAA010101AAA....xml",
                    "fileUrl": "http:/oat.reachcore.com/api/...../factura"
                },
                "pdfxml": {
                    "fileName": "PDF Nombre.pdf",
                    "fileUrl": "http:/oat.reachcore.com/api/...../pdfxml"
                },
                "notasdecredito": {
                    "fileName": "Facturanotas.zip",
                    "fileUrl": "http://oat.reachcore.com/api/...../notasdecredito"
                },
               .
			   .
			   .
			   .
			   .
                }
            }
        }
    }
}

Ejemplo de respuesta que indica un error en la petición

{
    "Target": "Tramites",
    "Details": "El trámite con folio [BAA00212] no existe.",
    "InnerErrors": null,
    "MoreInfo": null,
    "Code": "TRAM-GETSNG-004",
    "Message": "Trámite no encontrado"
}

Resumen por estado de trámite

Muestra los folios de los trámites y su estado dentro del periodo consultado. El periodo* a consultar es requerido y no debe ser mayor a 7 días .

Encabezado HTTP , método GET

Dirección del servicio

Ejemplo de petición

https://oat.reachcore.com/api/rest/ventanilla/a00d0aa0-aa00-000a-0aaa-00000a000000/tramites?fechaInicial=2018/12/26 00:00:00&fechaFinal=2018/12/28 23:59:00&consultaEstado=Enviado

Ejemplo de respuesta

{
    "IdSeguimiento": "0ba3a065-eb8e-4706-ad34-812e542c2482",
    "FechaInicial": "2018-12-26T00:00:00",
    "FechaFinal": "2018-12-28T23:59:00",
    "ConsultaEstado": "Enviado",
    "TramitesEncontrados": 2,
    "DetalleTramites": [
        {
            "IdTramite": "AAA00001",
            "TimeStamp": "2017-11-24T12:53:02.97"
        },
        {
            "IdTramite": "AAA00002",
            "TimeStamp": "2017-11-24T12:53:03.08"
        }
    ]
}

Ejemplo de respuesta que indica un error en la petición

{
    "Error": {
        "Target": "Ventanilla",
        "Details": "Alguno de los parámetros recibidos para la obtención del trámite, no es válido.",
        "InnerErrors": [
            {
                "Target": "Ventanilla",
                "Details": "El rango de fechas especificado es mayor al permitido. Se permite hasta [7] días.",
                "InnerErrors": null,
                "MoreInfo": null,
                "Code": "VNTLLA-STATS-001(RangoFecha)",
                "Message": "Rango de fechas no permitido."
            }
        ],
        "MoreInfo": null,
        "Code": "VNTLLA-STATS-001",
        "Message": "Parámetros inválidos"
    }
}

Resumen por usuario asignado al trámite

Muestra los folios de los trámites asignado a un usuario y su estado dentro del periodo consultado.

Encabezado HTTP , método GET

Dirección del servicio

Ejemplo de petición

https://oat.reachcore.com/api/rest/ventanilla/a00d0aa0-aa00-000a-0aaa-00000a000000/tramites?fechaInicial=2023/03/23 00:00:00&fechaFinal=2023/03/30 23:59:00&asignadoA=olopez

Ejemplo de respuesta

{
    "IdSeguimiento": "04987406-482f-4661-81c0-8509a9f28104",
    "FechaInicial": "2023-01-28T00:00:00",
    "FechaFinal": "2023-02-03T23:59:00",
    "TramitesEncontrados": 3,
    "DetalleTramites": [
        {
            "IdTramite": "NT0002751",
            "TimeStamp": "2023-01-26T20:53:44.863",
            "Estado": "Trámite recibido de proveedor"
        },
        {
            "IdTramite": "NT0014586",
            "TimeStamp": "2023-02-03T14:10:50.327",
            "Estado": "Trámite recibido de proveedor"
        },
        {
            "IdTramite": "NT0014587",
            "TimeStamp": "2023-02-03T14:10:50.583",
            "Estado": "Trámite recibido de proveedor"
        }
    ]
}

Ejemplo de respuesta que indica un error en la petición

{
    "Error": {
        "Target": "Ventanilla",
        "Details": "El parámetro AsignadoA con valor [xxx] no es un usuario válido para la ventanilla con id 1f8e1ba8-37e1-4c46-8a31-e58b44fd377c.",
        "InnerErrors": null,
        "MoreInfo": null,
        "Code": "VNTLLA-STATS-001(AsignadoA)",
        "Message": "Parámetro AsignadoA no válido"
    }
}