Stamping Service Balance Consultation API

Sovos Mexico has a REST API to consult your balance in the Stamping webservice.

Content

• What do I need?
• Balance Stamping Service Consultation API
• Consume Report Downloading in PDF or CSV

What do I need?

• Have the Stamping service enabled in your Sovos Mexico account.
• To generate an API key on your Sovos account, this is an identifier that authenticates the user on the platform web services. To generate an API key, please review this article: Generating an API Key for web services (Spanish only).

Balance Stamping Service Consultation API

You need to send to the REST API the following URL:

HTTP: POST

HTTP Header

Body

You can only use a JSON structure in the body of the request

Request for Consultation of all RFCs Balance example

{
  "MesConsulta" : "2019-01"
}

Request for Consultation of an specific RFC Balance example

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

Response Codes

As a response to the REST service, you will get a code indicating the result of the request. All the responses will be in JSON format (application/json).

Example of the Response from Balance Consultation of the RFCs in the account

{
  "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
    }
  ]
}

Example of the Response from Balance Consultation for an specific RFC

{
  "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
    }
  ]
}

Response indicating an error in the request Example

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

Where:

Consume Report Downloading in PDF or CSV

You can consult the consumption report in PDF or CSV format (which can be interpreted by Excel) with this resource. The links to download those reports are:

For PDF format:

For CSV format:

In both URLs you must have the following parameters:

HTTP: POST

HTTP Header

Body

You can only use a JSON structure in the body of the request

Report Consultation Request example

{
  "MesConsulta" : "2019-10"
}

Response codes

As a response from the REST service, you will get a code indicating the result of the request. All the responses will be in JSON format (application/json).

Example of a download report response (CSV or PDF)

If you can generate a file with the report, the HTTP code will be 200 and it will have an attachment with the requested report. For a CSV report the content of the attachment will be as follows:

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

Example of a response indicating an error in the request

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

For more information or any doubt related to this guide, please send an email to MEX-soporte@sovos.com