API para Consulta de Saldo en Servicio de Timbrado

Reachcore ha creado un API REST para la consulta de saldos empleados en el servicio web de Timbre:

Contenido

• ¿Qué necesito?
• API de Consulta de Saldos de Timbre
• Descarga de reporte de consumo en formato PDF o CSV

¿Qué necesito?

• Tener activado el servicio de Timbre en tu cuenta Reachcore.
• Generar un API Key en tu cuenta Reachcore, 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.

API de Consulta de Saldos de Timbre

En este recurso se podrá consultar el saldo de todos los RFC registrados en tu cuenta, o la información específica de uno. Para ello, se debe enviar al API REST lo siguiente:

Verbo HTTP: POST

Encabezado HTTP

Cuerpo

Solo se acepta la estructura de un JSON en el cuerpo de la solicitud

Ejemplo de solicitud consulta de saldo de los RFC registrados en la Cuenta

{
  "MesConsulta" : "2019-01"
}

Ejemplo de solicitud consulta de saldo por RFC específico

{ 
  "MesConsulta" : "2019-12",
  "RFCConsulta" : "A&D061009TY8" 
}

Códigos de respuesta

Como respuestá del servicio REST, obtendrá un código indicando el resultado de la operación. Todas las repuestás son en formato JSON (application/json)

Ejemplo de respuesta a una consulta de saldo de los RFC registrados en la Cuenta

{
  "TipoConsumo" : "Postpago",
  "FechaActual" : "2019-11-19T13:53:41"
  "Registrados" : 0,
  "Autorizados" : 0,
  "GeneraronTimbre" : 0,
  "Transacciones" : 2,
  "Detalle" : [
    {
      "RFC" : "A&D061009TY8",
      "Fecha" : "2019-11-02T00:00:00",
      "TipoMovimiento" : "Consumo de timbre",
      "Monto" : 1
    },
    {
      "RFC" : "AAA010101AAA",
      "Fecha" : "2019-11-03T00:00:00",
      "TipoMovimiento" : "Consumo de timbre",
      "Monto" : 1
    }
  ]
}

Ejemplo de respuesta a una consulta de saldo por RFC específico

{
  "TipoConsumo" : "Postpago",
  "FechaActual" : "2019-11-19T13:55:49"
  "Registrados" : 0,
  "Autorizados" : 0,
  "GeneraronTimbre" : 0,
  "Transacciones" : 1,
  "Detalle" : [
    {
      "RFC" : "A&D061009TY8",
      "Fecha" : "2019-11-02T00:00:00",
      "TipoMovimiento" : "Consumo de timbre",
      "Monto" : 1
    }
  ]
}

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

{
  "errors": [
    {
      "Code": "400-001",
      "Message": "'MesConsulta' se encuentra en un formato inválido."
    }
  ]
}

Donde:

Descarga de reporte de consumo en formato PDF o CSV

En este recurso se podrá consultar el reporte de consumo en formato PDF o CSV (el cual puede ser interpretado por Excel). Las ligas para descargar estos reportes son las siguientes:

Para formato PDF:

Para formato CSV:

En ambos URL para la petición de descarga del reporte debe contener los siguientes parámetros:

Verbo HTTP: POST

Encabezado HTTP

Cuerpo

Solo se acepta la estructura de un JSON en el cuerpo de la solicitud

Ejemplo de solicitud consulta de reporte

{
  "MesConsulta" : "2019-10"
}

Códigos de respuesta

Como respuestá del servicio REST, obtendrá un código indicando el resultado de la operación. Todas las repuestás son en formato JSON (application/json)

Ejemplo de respuesta de la descarga de un reporte (CSV o PDF)

Si se puede generar el archivo con el reporte, el código HTTP será 200 y se responderá con un attachment con el reporte solicitado. Para un reporte en CSV, el contenido del attachment es el siguiente:

Cuenta,TipoConsumo,FechaInicioConsulta,FechaFinConsulta,FechaActual
Pruebas,Postpago,2019-10-01T00:00:00,2019-10-31T00:00:00,2019-11-20T16:57:53

Estado de los RFC
Registrados,0
Autorizados,1
Generaron Timbre,1

Transacciones
Consumo de todos los RFC:,3

RFC,Fecha,Tipo movimiento,Monto
AAA010101AAA ,10/17/2019 12:00:00 AM,Consumo de timbre,3

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

{
  "errors": [
    {
      "Code": "400-002",
      "Message": "No es necesario mandar el 'RFCConsulta'"
    }
  ]
}

Para mayor información o aclaración de dudas relacionadas con está guía, por favor envía un correo a MEX-soporte@sovos.com